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 pipe_fence_handle;
  54 struct pipe_winsys;
  55 struct pipe_buffer;
  56
  57
  58
  59 /**
  60  * Gallium screen/adapter context.  Basically everything
  61  * hardware-specific that doesn't actually require a rendering
  62  * context.
  63  */
  64 struct pipe_screen {
  65    struct pipe_winsys *winsys;
  66
  67    void (*destroy)( struct pipe_screen * );
  68
  69
  70    const char *(*get_name)( struct pipe_screen * );
  71
  72    const char *(*get_vendor)( struct pipe_screen * );
  73
  74    /**
  75     * Query an integer-valued capability/parameter/limit
  76     * \param param  one of PIPE_CAP_x
  77     */
  78    int (*get_param)( struct pipe_screen *, int param );
  79
  80    /**
  81     * Query a float-valued capability/parameter/limit
  82     * \param param  one of PIPE_CAP_x
  83     */
  84    float (*get_paramf)( struct pipe_screen *, int param );
  85
  86    /**
  87     * Check if the given pipe_format is supported as a texture or
  88     * drawing surface.
  89     * \param tex_usage  bitmask of PIPE_TEXTURE_USAGE_*
  90     * \param flags  bitmask of PIPE_TEXTURE_GEOM_*
  91     */
  92    boolean (*is_format_supported)( struct pipe_screen *,
  93                                    enum pipe_format format,
  94                                    enum pipe_texture_target target,
  95                                    unsigned tex_usage,
  96                                    unsigned geom_flags );
  97
  98    /**
  99     * Create a new texture object, using the given template info.
 100     */
 101    struct pipe_texture * (*texture_create)(struct pipe_screen *,
 102                                            const struct pipe_texture *templat);
 103
 104    /**
 105     * Create a new texture object, using the given template info, but on top of
 106     * existing memory.
 107     *
 108     * It is assumed that the buffer data is layed out according to the expected
 109     * by the hardware. NULL will be returned if any inconsistency is found.
 110     */
 111    struct pipe_texture * (*texture_blanket)(struct pipe_screen *,
 112                                             const struct pipe_texture *templat,
 113                                             const unsigned *stride,
 114                                             struct pipe_buffer *buffer);
 115
 116    void (*texture_destroy)(struct pipe_texture *pt);
 117
 118    /** Get a surface which is a "view" into a texture */
 119    struct pipe_surface *(*get_tex_surface)(struct pipe_screen *,
 120                                            struct pipe_texture *texture,
 121                                            unsigned face, unsigned level,
 122                                            unsigned zslice,
 123                                            unsigned usage );
 124
 125    void (*tex_surface_destroy)(struct pipe_surface *);
 126
 127
 128    /** Get a transfer object for transferring data to/from a texture */
 129    struct pipe_transfer *(*get_tex_transfer)(struct pipe_screen *,
 130                                              struct pipe_texture *texture,
 131                                              unsigned face, unsigned level,
 132                                              unsigned zslice,
 133                                              enum pipe_transfer_usage usage,
 134                                              unsigned x, unsigned y,
 135                                              unsigned w, unsigned h);
 136
 137    void (*tex_transfer_destroy)(struct pipe_transfer *);
 138
 139    void *(*transfer_map)( struct pipe_screen *,
 140                           struct pipe_transfer *transfer );
 141
 142    void (*transfer_unmap)( struct pipe_screen *,
 143                            struct pipe_transfer *transfer );
 144
 145
 146    /**
 147     * Buffer management. Buffer attributes are mostly fixed over its lifetime.
 148     *
 149     */
 150    struct pipe_buffer *(*buffer_create)( struct pipe_screen *screen,
 151                                          unsigned alignment,
 152                                          unsigned usage,
 153                                          unsigned size );
 154
 155    /**
 156     * Create a buffer that wraps user-space data.
 157     *
 158     * Effectively this schedules a delayed call to buffer_create
 159     * followed by an upload of the data at *some point in the future*,
 160     * or perhaps never.  Basically the allocate/upload is delayed
 161     * until the buffer is actually passed to hardware.
 162     *
 163     * The intention is to provide a quick way to turn regular data
 164     * into a buffer, and secondly to avoid a copy operation if that
 165     * data subsequently turns out to be only accessed by the CPU.
 166     *
 167     * Common example is OpenGL vertex buffers that are subsequently
 168     * processed either by software TNL in the driver or by passing to
 169     * hardware.
 170     *
 171     * XXX: What happens if the delayed call to buffer_create() fails?
 172     *
 173     * Note that ptr may be accessed at any time upto the time when the
 174     * buffer is destroyed, so the data must not be freed before then.
 175     */
 176    struct pipe_buffer *(*user_buffer_create)(struct pipe_screen *screen,
 177                                              void *ptr,
 178                                              unsigned bytes);
 179
 180    /**
 181     * Allocate storage for a display target surface.
 182     *
 183     * Often surfaces which are meant to be blitted to the front screen (i.e.,
 184     * display targets) must be allocated with special characteristics, memory
 185     * pools, or obtained directly from the windowing system.
 186     *
 187     * This callback is invoked by the pipe_screenwhen creating a texture marked
 188     * with the PIPE_TEXTURE_USAGE_DISPLAY_TARGET flag  to get the underlying
 189     * buffer storage.
 190     */
 191    struct pipe_buffer *(*surface_buffer_create)(struct pipe_screen *screen,
 192                                                 unsigned width, unsigned height,
 193                                                 enum pipe_format format,
 194                                                 unsigned usage,
 195                                                 unsigned *stride);
 196
 197
 198    /**
 199     * Map the entire data store of a buffer object into the client's address.
 200     * flags is bitmask of PIPE_BUFFER_USAGE_CPU_READ/WRITE flags.
 201     */
 202    void *(*buffer_map)( struct pipe_screen *screen,
 203                         struct pipe_buffer *buf,
 204                         unsigned usage );
 205    /**
 206     * Map a subrange of the buffer data store into the client's address space.
 207     *
 208     * Return pointer is always relative to offset 0, regardless of the
 209     * read/write ranges.
 210     */
 211    void *(*buffer_map_range)( struct pipe_screen *screen,
 212                               struct pipe_buffer *buf,
 213                               unsigned offset,
 214                               unsigned length,
 215                               unsigned usage);
 216
 217    /**
 218     * written is the range that the client actually wrote.
 219     */
 220    void (*buffer_flush_mapped_range)( struct pipe_screen *screen,
 221                                       struct pipe_buffer *buf,
 222                                       unsigned offset,
 223                                       unsigned length);
 224
 225    void (*buffer_unmap)( struct pipe_screen *screen,
 226                          struct pipe_buffer *buf );
 227
 228    void (*buffer_destroy)( struct pipe_buffer *buf );
 229
 230
 231    /**
 232     * Do any special operations to ensure frontbuffer contents are
 233     * displayed, eg copy fake frontbuffer.
 234     */
 235    void (*flush_frontbuffer)( struct pipe_screen *screen,
 236                               struct pipe_surface *surf,
 237                               void *context_private );
 238
 239
 240
 241    /** Set ptr = fence, with reference counting */
 242    void (*fence_reference)( struct pipe_screen *screen,
 243                             struct pipe_fence_handle **ptr,
 244                             struct pipe_fence_handle *fence );
 245
 246    /**
 247     * Checks whether the fence has been signalled.
 248     * \param flags  driver-specific meaning
 249     * \return zero on success.
 250     */
 251    int (*fence_signalled)( struct pipe_screen *screen,
 252                            struct pipe_fence_handle *fence,
 253                            unsigned flag );
 254
 255    /**
 256     * Wait for the fence to finish.
 257     * \param flags  driver-specific meaning
 258     * \return zero on success.
 259     */
 260    int (*fence_finish)( struct pipe_screen *screen,
 261                         struct pipe_fence_handle *fence,
 262                         unsigned flag );
 263
 264 };
 265
 266
 267 #ifdef __cplusplus
 268 }
 269 #endif
 270
 271 #endif /* P_SCREEN_H */