src/gallium/include/pipe/p_screen.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
   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 TUNGSTEN GRAPHICS 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
  60
  61 /**
  62  * Gallium screen/adapter context.  Basically everything
  63  * hardware-specific that doesn't actually require a rendering
  64  * context.
  65  */
  66 struct pipe_screen {
  67    void (*destroy)( struct pipe_screen * );
  68
  69    const char *(*get_name)( struct pipe_screen * );
  70
  71    const char *(*get_vendor)( struct pipe_screen * );
  72
  73    /**
  74     * Query an integer-valued capability/parameter/limit
  75     * \param param  one of PIPE_CAP_x
  76     */
  77    int (*get_param)( struct pipe_screen *, enum pipe_cap param );
  78
  79    /**
  80     * Query a float-valued capability/parameter/limit
  81     * \param param  one of PIPE_CAP_x
  82     */
  83    float (*get_paramf)( struct pipe_screen *, enum pipe_capf param );
  84
  85    /**
  86     * Query a per-shader-stage integer-valued capability/parameter/limit
  87     * \param param  one of PIPE_CAP_x
  88     */
  89    int (*get_shader_param)( struct pipe_screen *, unsigned shader, enum pipe_shader_cap param );
  90
  91    /**
  92     * Query an integer-valued capability/parameter/limit for a codec/profile
  93     * \param param  one of PIPE_VIDEO_CAP_x
  94     */
  95    int (*get_video_param)( struct pipe_screen *,
  96                            enum pipe_video_profile profile,
  97                            enum pipe_video_entrypoint entrypoint,
  98                            enum pipe_video_cap param );
  99
 100    /**
 101     * Query a compute-specific capability/parameter/limit.
 102     * \param param  one of PIPE_COMPUTE_CAP_x
 103     * \param ret    pointer to a preallocated buffer that will be
 104     *               initialized to the parameter value, or NULL.
 105     * \return       size in bytes of the parameter value that would be
 106     *               returned.
 107     */
 108    int (*get_compute_param)(struct pipe_screen *,
 109                             enum pipe_compute_cap param,
 110                             void *ret);
 111
 112    /**
 113     * Query a timestamp in nanoseconds. The returned value should match
 114     * PIPE_QUERY_TIMESTAMP. This function returns immediately and doesn't
 115     * wait for rendering to complete (which cannot be achieved with queries).
 116     */
 117    uint64_t (*get_timestamp)(struct pipe_screen *);
 118
 119    struct pipe_context * (*context_create)( struct pipe_screen *,
 120                                             void *priv );
 121
 122    /**
 123     * Check if the given pipe_format is supported as a texture or
 124     * drawing surface.
 125     * \param bindings  bitmask of PIPE_BIND_*
 126     */
 127    boolean (*is_format_supported)( struct pipe_screen *,
 128                                    enum pipe_format format,
 129                                    enum pipe_texture_target target,
 130                                    unsigned sample_count,
 131                                    unsigned bindings );
 132
 133    /**
 134     * Check if the given pipe_format is supported as output for this codec/profile.
 135     * \param profile  profile to check, may also be PIPE_VIDEO_PROFILE_UNKNOWN
 136     */
 137    boolean (*is_video_format_supported)( struct pipe_screen *,
 138                                          enum pipe_format format,
 139                                          enum pipe_video_profile profile );
 140
 141    /**
 142     * Check if we can actually create the given resource (test the dimension,
 143     * overall size, etc).  Used to implement proxy textures.
 144     * \return TRUE if size is OK, FALSE if too large.
 145     */
 146    boolean (*can_create_resource)(struct pipe_screen *screen,
 147                                   const struct pipe_resource *templat);
 148
 149    /**
 150     * Create a new texture object, using the given template info.
 151     */
 152    struct pipe_resource * (*resource_create)(struct pipe_screen *,
 153                                              const struct pipe_resource *templat);
 154
 155    /**
 156     * Create a texture from a winsys_handle. The handle is often created in
 157     * another process by first creating a pipe texture and then calling
 158     * resource_get_handle.
 159     */
 160    struct pipe_resource * (*resource_from_handle)(struct pipe_screen *,
 161                                                   const struct pipe_resource *templat,
 162                                                   struct winsys_handle *handle);
 163
 164    /**
 165     * Get a winsys_handle from a texture. Some platforms/winsys requires
 166     * that the texture is created with a special usage flag like
 167     * DISPLAYTARGET or PRIMARY.
 168     */
 169    boolean (*resource_get_handle)(struct pipe_screen *,
 170                                   struct pipe_resource *tex,
 171                                   struct winsys_handle *handle);
 172
 173
 174    void (*resource_destroy)(struct pipe_screen *,
 175                             struct pipe_resource *pt);
 176
 177
 178    /**
 179     * Do any special operations to ensure frontbuffer contents are
 180     * displayed, eg copy fake frontbuffer.
 181     * \param winsys_drawable_handle  an opaque handle that the calling context
 182     *                                gets out-of-band
 183     */
 184    void (*flush_frontbuffer)( struct pipe_screen *screen,
 185                               struct pipe_resource *resource,
 186                               unsigned level, unsigned layer,
 187                               void *winsys_drawable_handle );
 188
 189
 190
 191    /** Set ptr = fence, with reference counting */
 192    void (*fence_reference)( struct pipe_screen *screen,
 193                             struct pipe_fence_handle **ptr,
 194                             struct pipe_fence_handle *fence );
 195
 196    /**
 197     * Checks whether the fence has been signalled.
 198     */
 199    boolean (*fence_signalled)( struct pipe_screen *screen,
 200                                struct pipe_fence_handle *fence );
 201
 202    /**
 203     * Wait for the fence to finish.
 204     * \param timeout  in nanoseconds (may be PIPE_TIMEOUT_INFINITE).
 205     */
 206    boolean (*fence_finish)( struct pipe_screen *screen,
 207                             struct pipe_fence_handle *fence,
 208                             uint64_t timeout );
 209
 210    /**
 211     * Returns a driver-specific query.
 212     *
 213     * If \p info is NULL, the number of available queries is returned.
 214     * Otherwise, the driver query at the specified \p index is returned
 215     * in \p info. The function returns non-zero on success.
 216     */
 217    int (*get_driver_query_info)(struct pipe_screen *screen,
 218                                 unsigned index,
 219                                 struct pipe_driver_query_info *info);
 220
 221 };
 222
 223
 224 #ifdef __cplusplus
 225 }
 226 #endif
 227
 228 #endif /* P_SCREEN_H */