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
  45
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51
  52 /** Opaque type */
  53 struct winsys_handle;
  54 /** Opaque type */
  55 struct pipe_fence_handle;
  56 struct pipe_winsys;
  57 struct pipe_resource;
  58 struct pipe_surface;
  59 struct pipe_transfer;
  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    struct pipe_winsys *winsys;
  69
  70    void (*destroy)( struct pipe_screen * );
  71
  72
  73    const char *(*get_name)( struct pipe_screen * );
  74
  75    const char *(*get_vendor)( struct pipe_screen * );
  76
  77    /**
  78     * Query an integer-valued capability/parameter/limit
  79     * \param param  one of PIPE_CAP_x
  80     */
  81    int (*get_param)( struct pipe_screen *, enum pipe_cap param );
  82
  83    /**
  84     * Query a float-valued capability/parameter/limit
  85     * \param param  one of PIPE_CAP_x
  86     */
  87    float (*get_paramf)( struct pipe_screen *, enum pipe_cap param );
  88
  89    /**
  90     * Query a per-shader-stage integer-valued capability/parameter/limit
  91     * \param param  one of PIPE_CAP_x
  92     */
  93    int (*get_shader_param)( struct pipe_screen *, unsigned shader, enum pipe_shader_cap param );
  94
  95    struct pipe_context * (*context_create)( struct pipe_screen *,
  96                                             void *priv );
  97
  98    /**
  99     * Check if the given pipe_format is supported as a texture or
 100     * drawing surface.
 101     * \param bindings  bitmask of PIPE_BIND_*
 102     * \param geom_flags  bitmask of PIPE_TEXTURE_GEOM_*
 103     */
 104    boolean (*is_format_supported)( struct pipe_screen *,
 105                                    enum pipe_format format,
 106                                    enum pipe_texture_target target,
 107                                    unsigned sample_count,
 108                                    unsigned bindings,
 109                                    unsigned geom_flags );
 110
 111    /**
 112     * Create a new texture object, using the given template info.
 113     */
 114    struct pipe_resource * (*resource_create)(struct pipe_screen *,
 115                                              const struct pipe_resource *templat);
 116
 117    /**
 118     * Create a texture from a winsys_handle. The handle is often created in
 119     * another process by first creating a pipe texture and then calling
 120     * texture_get_handle.
 121     */
 122    struct pipe_resource * (*resource_from_handle)(struct pipe_screen *,
 123                                                   const struct pipe_resource *templat,
 124                                                   struct winsys_handle *handle);
 125
 126    /**
 127     * Get a winsys_handle from a texture. Some platforms/winsys requires
 128     * that the texture is created with a special usage flag like
 129     * DISPLAYTARGET or PRIMARY.
 130     */
 131    boolean (*resource_get_handle)(struct pipe_screen *,
 132                                   struct pipe_resource *tex,
 133                                   struct winsys_handle *handle);
 134
 135
 136    void (*resource_destroy)(struct pipe_screen *,
 137                             struct pipe_resource *pt);
 138
 139    /** Get a 2D surface which is a "view" into a texture
 140     * \param usage  bitmaks of PIPE_BIND_* flags
 141     */
 142    struct pipe_surface *(*get_tex_surface)(struct pipe_screen *,
 143                                            struct pipe_resource *resource,
 144                                            unsigned face, unsigned level,
 145                                            unsigned zslice,
 146                                            unsigned usage );
 147
 148    void (*tex_surface_destroy)(struct pipe_surface *);
 149
 150
 151
 152    /**
 153     * Create a buffer that wraps user-space data.
 154     *
 155     * Effectively this schedules a delayed call to buffer_create
 156     * followed by an upload of the data at *some point in the future*,
 157     * or perhaps never.  Basically the allocate/upload is delayed
 158     * until the buffer is actually passed to hardware.
 159     *
 160     * The intention is to provide a quick way to turn regular data
 161     * into a buffer, and secondly to avoid a copy operation if that
 162     * data subsequently turns out to be only accessed by the CPU.
 163     *
 164     * Common example is OpenGL vertex buffers that are subsequently
 165     * processed either by software TNL in the driver or by passing to
 166     * hardware.
 167     *
 168     * XXX: What happens if the delayed call to buffer_create() fails?
 169     *
 170     * Note that ptr may be accessed at any time upto the time when the
 171     * buffer is destroyed, so the data must not be freed before then.
 172     */
 173    struct pipe_resource *(*user_buffer_create)(struct pipe_screen *screen,
 174                                                void *ptr,
 175                                                unsigned bytes,
 176                                                unsigned bind_flags);
 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_surface *surf,
 186                               void *winsys_drawable_handle );
 187
 188
 189
 190    /** Set ptr = fence, with reference counting */
 191    void (*fence_reference)( struct pipe_screen *screen,
 192                             struct pipe_fence_handle **ptr,
 193                             struct pipe_fence_handle *fence );
 194
 195    /**
 196     * Checks whether the fence has been signalled.
 197     * \param flags  driver-specific meaning
 198     * \return zero on success.
 199     */
 200    int (*fence_signalled)( struct pipe_screen *screen,
 201                            struct pipe_fence_handle *fence,
 202                            unsigned flags );
 203
 204    /**
 205     * Wait for the fence to finish.
 206     * \param flags  driver-specific meaning
 207     * \return zero on success.
 208     */
 209    int (*fence_finish)( struct pipe_screen *screen,
 210                         struct pipe_fence_handle *fence,
 211                         unsigned flags );
 212
 213 };
 214
 215
 216 #ifdef __cplusplus
 217 }
 218 #endif
 219
 220 #endif /* P_SCREEN_H */