src/gallium/include/pipe/p_screen.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * @file
  30  *
  31  * Screen, Adapter or GPU
  32  *
  33  * These are driver functions/facilities that are context independent.
  34  */
  35
  36
  37 #ifndef P_SCREEN_H
  38 #define P_SCREEN_H
  39
  40
  41 #include "pipe/p_compiler.h"
  42 #include "pipe/p_format.h"
  43 #include "pipe/p_defines.h"
  44 #include "pipe/p_video_enums.h"
  45
  46
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52
  53 /** Opaque types */
  54 struct winsys_handle;
  55 struct pipe_fence_handle;
  56 struct pipe_resource;
  57 struct pipe_surface;
  58 struct pipe_transfer;
  59 struct pipe_box;
  60
  61
  62 /**
  63  * Gallium screen/adapter context.  Basically everything
  64  * hardware-specific that doesn't actually require a rendering
  65  * context.
  66  */
  67 struct pipe_screen {
  68    void (*destroy)( struct pipe_screen * );
  69
  70    const char *(*get_name)( struct pipe_screen * );
  71
  72    const char *(*get_vendor)( struct pipe_screen * );
  73
  74    /**
  75     * Returns the device vendor.
  76     *
  77     * The returned value should return the actual device vendor/manufacturer,
  78     * rather than a potentially generic driver string.
  79     */
  80    const char *(*get_device_vendor)( struct pipe_screen * );
  81
  82    /**
  83     * Query an integer-valued capability/parameter/limit
  84     * \param param  one of PIPE_CAP_x
  85     */
  86    int (*get_param)( struct pipe_screen *, enum pipe_cap param );
  87
  88    /**
  89     * Query a float-valued capability/parameter/limit
  90     * \param param  one of PIPE_CAP_x
  91     */
  92    float (*get_paramf)( struct pipe_screen *, enum pipe_capf param );
  93
  94    /**
  95     * Query a per-shader-stage integer-valued capability/parameter/limit
  96     * \param param  one of PIPE_CAP_x
  97     */
  98    int (*get_shader_param)( struct pipe_screen *, unsigned shader, enum pipe_shader_cap param );
  99
 100    /**
 101     * Query an integer-valued capability/parameter/limit for a codec/profile
 102     * \param param  one of PIPE_VIDEO_CAP_x
 103     */
 104    int (*get_video_param)( struct pipe_screen *,
 105                            enum pipe_video_profile profile,
 106                            enum pipe_video_entrypoint entrypoint,
 107                            enum pipe_video_cap param );
 108
 109    /**
 110     * Query a compute-specific capability/parameter/limit.
 111     * \param param  one of PIPE_COMPUTE_CAP_x
 112     * \param ret    pointer to a preallocated buffer that will be
 113     *               initialized to the parameter value, or NULL.
 114     * \return       size in bytes of the parameter value that would be
 115     *               returned.
 116     */
 117    int (*get_compute_param)(struct pipe_screen *,
 118                             enum pipe_compute_cap param,
 119                             void *ret);
 120
 121    /**
 122     * Query a timestamp in nanoseconds. The returned value should match
 123     * PIPE_QUERY_TIMESTAMP. This function returns immediately and doesn't
 124     * wait for rendering to complete (which cannot be achieved with queries).
 125     */
 126    uint64_t (*get_timestamp)(struct pipe_screen *);
 127
 128    /**
 129     * Create a context.
 130     *
 131     * \param screen      pipe screen
 132     * \param priv        a pointer to set in pipe_context::priv
 133     * \param flags       a mask of PIPE_CONTEXT_* flags
 134     */
 135    struct pipe_context * (*context_create)(struct pipe_screen *screen,
 136                                            void *priv, unsigned flags);
 137
 138    /**
 139     * Check if the given pipe_format is supported as a texture or
 140     * drawing surface.
 141     * \param bindings  bitmask of PIPE_BIND_*
 142     */
 143    boolean (*is_format_supported)( struct pipe_screen *,
 144                                    enum pipe_format format,
 145                                    enum pipe_texture_target target,
 146                                    unsigned sample_count,
 147                                    unsigned bindings );
 148
 149    /**
 150     * Check if the given pipe_format is supported as output for this codec/profile.
 151     * \param profile  profile to check, may also be PIPE_VIDEO_PROFILE_UNKNOWN
 152     */
 153    boolean (*is_video_format_supported)( struct pipe_screen *,
 154                                          enum pipe_format format,
 155                                          enum pipe_video_profile profile,
 156                                          enum pipe_video_entrypoint entrypoint );
 157
 158    /**
 159     * Check if we can actually create the given resource (test the dimension,
 160     * overall size, etc).  Used to implement proxy textures.
 161     * \return TRUE if size is OK, FALSE if too large.
 162     */
 163    boolean (*can_create_resource)(struct pipe_screen *screen,
 164                                   const struct pipe_resource *templat);
 165
 166    /**
 167     * Create a new texture object, using the given template info.
 168     */
 169    struct pipe_resource * (*resource_create)(struct pipe_screen *,
 170                                              const struct pipe_resource *templat);
 171
 172    /**
 173     * Create a texture from a winsys_handle. The handle is often created in
 174     * another process by first creating a pipe texture and then calling
 175     * resource_get_handle.
 176     */
 177    struct pipe_resource * (*resource_from_handle)(struct pipe_screen *,
 178                                                   const struct pipe_resource *templat,
 179                                                   struct winsys_handle *handle);
 180
 181    /**
 182     * Create a resource from user memory. This maps the user memory into
 183     * the device address space.
 184     */
 185    struct pipe_resource * (*resource_from_user_memory)(struct pipe_screen *,
 186                                                        const struct pipe_resource *t,
 187                                                        void *user_memory);
 188
 189    /**
 190     * Get a winsys_handle from a texture. Some platforms/winsys requires
 191     * that the texture is created with a special usage flag like
 192     * DISPLAYTARGET or PRIMARY.
 193     */
 194    boolean (*resource_get_handle)(struct pipe_screen *,
 195                                   struct pipe_resource *tex,
 196                                   struct winsys_handle *handle);
 197
 198
 199    void (*resource_destroy)(struct pipe_screen *,
 200                             struct pipe_resource *pt);
 201
 202
 203    /**
 204     * Do any special operations to ensure frontbuffer contents are
 205     * displayed, eg copy fake frontbuffer.
 206     * \param winsys_drawable_handle  an opaque handle that the calling context
 207     *                                gets out-of-band
 208     * \param subbox an optional sub region to flush
 209     */
 210    void (*flush_frontbuffer)( struct pipe_screen *screen,
 211                               struct pipe_resource *resource,
 212                               unsigned level, unsigned layer,
 213                               void *winsys_drawable_handle,
 214                               struct pipe_box *subbox );
 215
 216    /** Set ptr = fence, with reference counting */
 217    void (*fence_reference)( struct pipe_screen *screen,
 218                             struct pipe_fence_handle **ptr,
 219                             struct pipe_fence_handle *fence );
 220
 221    /**
 222     * Wait for the fence to finish.
 223     * \param timeout  in nanoseconds (may be PIPE_TIMEOUT_INFINITE).
 224     */
 225    boolean (*fence_finish)( struct pipe_screen *screen,
 226                             struct pipe_fence_handle *fence,
 227                             uint64_t timeout );
 228
 229    /**
 230     * Returns a driver-specific query.
 231     *
 232     * If \p info is NULL, the number of available queries is returned.
 233     * Otherwise, the driver query at the specified \p index is returned
 234     * in \p info. The function returns non-zero on success.
 235     */
 236    int (*get_driver_query_info)(struct pipe_screen *screen,
 237                                 unsigned index,
 238                                 struct pipe_driver_query_info *info);
 239
 240    /**
 241     * Returns a driver-specific query group.
 242     *
 243     * If \p info is NULL, the number of available groups is returned.
 244     * Otherwise, the driver query group at the specified \p index is returned
 245     * in \p info. The function returns non-zero on success.
 246     */
 247    int (*get_driver_query_group_info)(struct pipe_screen *screen,
 248                                       unsigned index,
 249                                       struct pipe_driver_query_group_info *info);
 250
 251 };
 252
 253
 254 #ifdef __cplusplus
 255 }
 256 #endif
 257
 258 #endif /* P_SCREEN_H */