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_buffer;
  58 struct pipe_texture;
  59 struct pipe_surface;
  60 struct pipe_video_surface;
  61 struct pipe_transfer;
  62
  63
  64 /**
  65  * Gallium screen/adapter context.  Basically everything
  66  * hardware-specific that doesn't actually require a rendering
  67  * context.
  68  */
  69 struct pipe_screen {
  70    struct pipe_winsys *winsys;
  71
  72    void (*destroy)( struct pipe_screen * );
  73
  74
  75    const char *(*get_name)( struct pipe_screen * );
  76
  77    const char *(*get_vendor)( struct pipe_screen * );
  78
  79    /**
  80     * Query an integer-valued capability/parameter/limit
  81     * \param param  one of PIPE_CAP_x
  82     */
  83    int (*get_param)( struct pipe_screen *, int param );
  84
  85    /**
  86     * Query a float-valued capability/parameter/limit
  87     * \param param  one of PIPE_CAP_x
  88     */
  89    float (*get_paramf)( struct pipe_screen *, int param );
  90
  91    struct pipe_context * (*context_create)( struct pipe_screen *,
  92                                             void *priv );
  93
  94    /**
  95     * Check if the given pipe_format is supported as a texture or
  96     * drawing surface.
  97     * \param tex_usage  bitmask of PIPE_TEXTURE_USAGE_*
  98     * \param geom_flags  bitmask of PIPE_TEXTURE_GEOM_*
  99     */
 100    boolean (*is_format_supported)( struct pipe_screen *,
 101                                    enum pipe_format format,
 102                                    enum pipe_texture_target target,
 103                                    unsigned tex_usage,
 104                                    unsigned geom_flags );
 105
 106    /**
 107     * Create a new texture object, using the given template info.
 108     */
 109    struct pipe_texture * (*texture_create)(struct pipe_screen *,
 110                                            const struct pipe_texture *templat);
 111
 112    /**
 113     * Create a texture from a winsys_handle. The handle is often created in
 114     * another process by first creating a pipe texture and then calling
 115     * texture_get_handle.
 116     */
 117    struct pipe_texture * (*texture_from_handle)(struct pipe_screen *,
 118                                                 const struct pipe_texture *templat,
 119                                                 struct winsys_handle *handle);
 120
 121    /**
 122     * Get a winsys_handle from a texture. Some platforms/winsys requires
 123     * that the texture is created with a special usage flag like
 124     * DISPLAYTARGET or PRIMARY.
 125     */
 126    boolean (*texture_get_handle)(struct pipe_screen *,
 127                                  struct pipe_texture *tex,
 128                                  struct winsys_handle *handle);
 129
 130
 131    void (*texture_destroy)(struct pipe_texture *pt);
 132
 133    /** Get a 2D surface which is a "view" into a texture
 134     * \param usage  bitmaks of PIPE_BUFFER_USAGE_* read/write flags
 135     */
 136    struct pipe_surface *(*get_tex_surface)(struct pipe_screen *,
 137                                            struct pipe_texture *texture,
 138                                            unsigned face, unsigned level,
 139                                            unsigned zslice,
 140                                            unsigned usage );
 141
 142    void (*tex_surface_destroy)(struct pipe_surface *);
 143
 144
 145    /** Get a transfer object for transferring data to/from a texture */
 146    struct pipe_transfer *(*get_tex_transfer)(struct pipe_screen *,
 147                                              struct pipe_texture *texture,
 148                                              unsigned face, unsigned level,
 149                                              unsigned zslice,
 150                                              enum pipe_transfer_usage usage,
 151                                              unsigned x, unsigned y,
 152                                              unsigned w, unsigned h);
 153
 154    void (*tex_transfer_destroy)(struct pipe_transfer *);
 155
 156    void *(*transfer_map)( struct pipe_screen *,
 157                           struct pipe_transfer *transfer );
 158
 159    void (*transfer_unmap)( struct pipe_screen *,
 160                            struct pipe_transfer *transfer );
 161
 162
 163    /**
 164     * Create a new buffer.
 165     * \param alignment  buffer start address alignment in bytes
 166     * \param usage  bitmask of PIPE_BUFFER_USAGE_x
 167     * \param size  size in bytes
 168     */
 169    struct pipe_buffer *(*buffer_create)( struct pipe_screen *screen,
 170                                          unsigned alignment,
 171                                          unsigned usage,
 172                                          unsigned size );
 173
 174    /**
 175     * Create a buffer that wraps user-space data.
 176     *
 177     * Effectively this schedules a delayed call to buffer_create
 178     * followed by an upload of the data at *some point in the future*,
 179     * or perhaps never.  Basically the allocate/upload is delayed
 180     * until the buffer is actually passed to hardware.
 181     *
 182     * The intention is to provide a quick way to turn regular data
 183     * into a buffer, and secondly to avoid a copy operation if that
 184     * data subsequently turns out to be only accessed by the CPU.
 185     *
 186     * Common example is OpenGL vertex buffers that are subsequently
 187     * processed either by software TNL in the driver or by passing to
 188     * hardware.
 189     *
 190     * XXX: What happens if the delayed call to buffer_create() fails?
 191     *
 192     * Note that ptr may be accessed at any time upto the time when the
 193     * buffer is destroyed, so the data must not be freed before then.
 194     */
 195    struct pipe_buffer *(*user_buffer_create)(struct pipe_screen *screen,
 196                                              void *ptr,
 197                                              unsigned bytes);
 198
 199
 200
 201    /**
 202     * Map the entire data store of a buffer object into the client's address.
 203     * flags is bitmask of PIPE_BUFFER_USAGE_CPU_READ/WRITE flags.
 204     */
 205    void *(*buffer_map)( struct pipe_screen *screen,
 206                         struct pipe_buffer *buf,
 207                         unsigned usage );
 208    /**
 209     * Map a subrange of the buffer data store into the client's address space.
 210     *
 211     * The returned pointer is always relative to buffer start, regardless of
 212     * the specified range. This is different from the ARB_map_buffer_range
 213     * semantics because we don't forbid multiple mappings of the same buffer
 214     * (yet).
 215     */
 216    void *(*buffer_map_range)( struct pipe_screen *screen,
 217                               struct pipe_buffer *buf,
 218                               unsigned offset,
 219                               unsigned length,
 220                               unsigned usage);
 221
 222    /**
 223     * Notify a range that was actually written into.
 224     *
 225     * Can only be used if the buffer was mapped with the
 226     * PIPE_BUFFER_USAGE_CPU_WRITE and PIPE_BUFFER_USAGE_FLUSH_EXPLICIT flags
 227     * set.
 228     *
 229     * The range is relative to the buffer start, regardless of the range
 230     * specified to buffer_map_range. This is different from the
 231     * ARB_map_buffer_range semantics because we don't forbid multiple mappings
 232     * of the same buffer (yet).
 233     *
 234     */
 235    void (*buffer_flush_mapped_range)( struct pipe_screen *screen,
 236                                       struct pipe_buffer *buf,
 237                                       unsigned offset,
 238                                       unsigned length);
 239
 240    /**
 241     * Unmap buffer.
 242     *
 243     * If the buffer was mapped with PIPE_BUFFER_USAGE_CPU_WRITE flag but not
 244     * PIPE_BUFFER_USAGE_FLUSH_EXPLICIT then the pipe driver will
 245     * assume that the whole buffer was written. This is mostly for backward
 246     * compatibility purposes and may affect performance -- the state tracker
 247     * should always specify exactly what got written while the buffer was
 248     * mapped.
 249     */
 250    void (*buffer_unmap)( struct pipe_screen *screen,
 251                          struct pipe_buffer *buf );
 252
 253    void (*buffer_destroy)( struct pipe_buffer *buf );
 254
 255    /**
 256     * Create a video surface suitable for use as a decoding target by the
 257     * driver's pipe_video_context.
 258     */
 259    struct pipe_video_surface*
 260    (*video_surface_create)( struct pipe_screen *screen,
 261                             enum pipe_video_chroma_format chroma_format,
 262                             unsigned width, unsigned height );
 263
 264    void (*video_surface_destroy)( struct pipe_video_surface *vsfc );
 265
 266    /**
 267     * Do any special operations to ensure buffer size is correct
 268     */
 269    void (*update_buffer)( struct pipe_screen *ws,
 270                           void *context_private );
 271
 272    /**
 273     * Do any special operations to ensure frontbuffer contents are
 274     * displayed, eg copy fake frontbuffer.
 275     */
 276    void (*flush_frontbuffer)( struct pipe_screen *screen,
 277                               struct pipe_surface *surf,
 278                               void *context_private );
 279
 280
 281
 282    /** Set ptr = fence, with reference counting */
 283    void (*fence_reference)( struct pipe_screen *screen,
 284                             struct pipe_fence_handle **ptr,
 285                             struct pipe_fence_handle *fence );
 286
 287    /**
 288     * Checks whether the fence has been signalled.
 289     * \param flags  driver-specific meaning
 290     * \return zero on success.
 291     */
 292    int (*fence_signalled)( struct pipe_screen *screen,
 293                            struct pipe_fence_handle *fence,
 294                            unsigned flags );
 295
 296    /**
 297     * Wait for the fence to finish.
 298     * \param flags  driver-specific meaning
 299     * \return zero on success.
 300     */
 301    int (*fence_finish)( struct pipe_screen *screen,
 302                         struct pipe_fence_handle *fence,
 303                         unsigned flags );
 304
 305 };
 306
 307
 308 #ifdef __cplusplus
 309 }
 310 #endif
 311
 312 #endif /* P_SCREEN_H */