src/gallium/include/pipe/p_context.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 #ifndef PIPE_CONTEXT_H
  29 #define PIPE_CONTEXT_H
  30
  31 #include "p_state.h"
  32
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38
  39 struct pipe_screen;
  40 struct pipe_fence_handle;
  41 struct pipe_state_cache;
  42 struct pipe_query;
  43 struct pipe_winsys;
  44
  45 /**
  46  * Gallium rendering context.  Basically:
  47  *  - state setting functions
  48  *  - VBO drawing functions
  49  *  - surface functions
  50  */
  51 struct pipe_context {
  52    struct pipe_winsys *winsys;
  53    struct pipe_screen *screen;
  54
  55    void *priv;  /**< context private data (for DRI for example) */
  56    void *draw;  /**< private, for draw module (temporary?) */
  57
  58    void (*destroy)( struct pipe_context * );
  59
  60
  61    /* Possible interface for setting edgeflags.  These aren't really
  62     * vertex elements, so don't fit there.
  63     */
  64    void (*set_edgeflags)( struct pipe_context *,
  65                           const unsigned *bitfield );
  66
  67
  68    /**
  69     * VBO drawing (return false on fallbacks (temporary??))
  70     */
  71    /*@{*/
  72    boolean (*draw_arrays)( struct pipe_context *pipe,
  73                            unsigned mode, unsigned start, unsigned count);
  74
  75    boolean (*draw_elements)( struct pipe_context *pipe,
  76                              struct pipe_buffer *indexBuffer,
  77                              unsigned indexSize,
  78                              unsigned mode, unsigned start, unsigned count);
  79
  80    /* XXX: this is (probably) a temporary entrypoint, as the range
  81     * information should be available from the vertex_buffer state.
  82     * Using this to quickly evaluate a specialized path in the draw
  83     * module.
  84     */
  85    boolean (*draw_range_elements)( struct pipe_context *pipe,
  86                                    struct pipe_buffer *indexBuffer,
  87                                    unsigned indexSize,
  88                                    unsigned minIndex,
  89                                    unsigned maxIndex,
  90                                    unsigned mode,
  91                                    unsigned start,
  92                                    unsigned count);
  93    /*@}*/
  94
  95
  96    /**
  97     * Query objects
  98     */
  99    /*@{*/
 100    struct pipe_query *(*create_query)( struct pipe_context *pipe,
 101                                        unsigned query_type );
 102
 103    void (*destroy_query)(struct pipe_context *pipe,
 104                          struct pipe_query *q);
 105
 106    void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
 107    void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
 108
 109    boolean (*get_query_result)(struct pipe_context *pipe,
 110                                struct pipe_query *q,
 111                                boolean wait,
 112                                uint64_t *result);
 113    /*@}*/
 114
 115    /**
 116     * State functions (create/bind/destroy state objects)
 117     */
 118    /*@{*/
 119    void * (*create_blend_state)(struct pipe_context *,
 120                                 const struct pipe_blend_state *);
 121    void   (*bind_blend_state)(struct pipe_context *, void *);
 122    void   (*delete_blend_state)(struct pipe_context *, void  *);
 123
 124    void * (*create_sampler_state)(struct pipe_context *,
 125                                   const struct pipe_sampler_state *);
 126    void   (*bind_sampler_states)(struct pipe_context *, unsigned num, void **);
 127    void   (*delete_sampler_state)(struct pipe_context *, void *);
 128
 129    void * (*create_rasterizer_state)(struct pipe_context *,
 130                                      const struct pipe_rasterizer_state *);
 131    void   (*bind_rasterizer_state)(struct pipe_context *, void *);
 132    void   (*delete_rasterizer_state)(struct pipe_context *, void *);
 133
 134    void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
 135                                         const struct pipe_depth_stencil_alpha_state *);
 136    void   (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
 137    void   (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
 138
 139    void * (*create_fs_state)(struct pipe_context *,
 140                              const struct pipe_shader_state *);
 141    void   (*bind_fs_state)(struct pipe_context *, void *);
 142    void   (*delete_fs_state)(struct pipe_context *, void *);
 143
 144    void * (*create_vs_state)(struct pipe_context *,
 145                              const struct pipe_shader_state *);
 146    void   (*bind_vs_state)(struct pipe_context *, void *);
 147    void   (*delete_vs_state)(struct pipe_context *, void *);
 148    /*@}*/
 149
 150    /**
 151     * Parameter-like state (or properties)
 152     */
 153    /*@{*/
 154    void (*set_blend_color)( struct pipe_context *,
 155                             const struct pipe_blend_color * );
 156
 157    void (*set_clip_state)( struct pipe_context *,
 158                            const struct pipe_clip_state * );
 159
 160    void (*set_constant_buffer)( struct pipe_context *,
 161                                 uint shader, uint index,
 162                                 const struct pipe_constant_buffer *buf );
 163
 164    void (*set_framebuffer_state)( struct pipe_context *,
 165                                   const struct pipe_framebuffer_state * );
 166
 167    void (*set_polygon_stipple)( struct pipe_context *,
 168                                 const struct pipe_poly_stipple * );
 169
 170    void (*set_scissor_state)( struct pipe_context *,
 171                               const struct pipe_scissor_state * );
 172
 173    void (*set_viewport_state)( struct pipe_context *,
 174                                const struct pipe_viewport_state * );
 175
 176    void (*set_sampler_textures)( struct pipe_context *,
 177                                  unsigned num_textures,
 178                                  struct pipe_texture ** );
 179
 180    void (*set_vertex_buffers)( struct pipe_context *,
 181                                unsigned num_buffers,
 182                                const struct pipe_vertex_buffer * );
 183
 184    void (*set_vertex_elements)( struct pipe_context *,
 185                                 unsigned num_elements,
 186                                 const struct pipe_vertex_element * );
 187    /*@}*/
 188
 189
 190    /**
 191     * Surface functions
 192     */
 193    /*@{*/
 194
 195    /**
 196     * Copy a block of pixels from one surface to another.
 197     * The surfaces must be of the same format.
 198     */
 199    void (*surface_copy)(struct pipe_context *pipe,
 200                         struct pipe_surface *dest,
 201                         unsigned destx, unsigned desty,
 202                         struct pipe_surface *src,
 203                         unsigned srcx, unsigned srcy,
 204                         unsigned width, unsigned height);
 205
 206    /**
 207     * Fill a region of a surface with a constant value.
 208     */
 209    void (*surface_fill)(struct pipe_context *pipe,
 210                         struct pipe_surface *dst,
 211                         unsigned dstx, unsigned dsty,
 212                         unsigned width, unsigned height,
 213                         unsigned value);
 214    /*@}*/
 215
 216    /**
 217     * Clear the specified set of currently bound buffers to specified values.
 218     * The entire buffers are cleared (no scissor, no colormask, etc).
 219     *
 220     * \param buffers  bitfield of PIPE_CLEAR_* values.
 221     * \param rgba  pointer to an array of one float for each of r, g, b, a.
 222     * \param depth  depth clear value in [0,1].
 223     * \param stencil  stencil clear value
 224     */
 225    void (*clear)(struct pipe_context *pipe,
 226                  unsigned buffers,
 227                  const float *rgba,
 228                  double depth,
 229                  unsigned stencil);
 230
 231    /** Flush rendering
 232     * \param flags  bitmask of PIPE_FLUSH_x tokens)
 233     */
 234    void (*flush)( struct pipe_context *pipe,
 235                   unsigned flags,
 236                   struct pipe_fence_handle **fence );
 237
 238    /**
 239     * Check whether a texture is referenced by an unflushed hw command.
 240     * The state-tracker uses this function to optimize away unnecessary
 241     * flushes. It is safe (but wasteful) to always return.
 242     * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
 243     * \param pipe  The pipe context whose unflushed hw commands will be
 244     *              checked.
 245     * \param level  mipmap level.
 246     * \param texture  texture to check.
 247     * \param face  cubemap face. Use 0 for non-cubemap texture.
 248     */
 249    unsigned int (*is_texture_referenced) (struct pipe_context *pipe,
 250                                           struct pipe_texture *texture,
 251                                           unsigned face, unsigned level);
 252
 253    /**
 254     * Check whether a buffer is referenced by an unflushed hw command.
 255     * The state-tracker uses this function to optimize away unnecessary
 256     * flushes. It is safe (but wasteful) to always return
 257     * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
 258     * \param pipe  The pipe context whose unflushed hw commands will be
 259     *              checked.
 260     * \param buf  Buffer to check.
 261     */
 262    unsigned int (*is_buffer_referenced) (struct pipe_context *pipe,
 263                                          struct pipe_buffer *buf);
 264 };
 265
 266
 267 #ifdef __cplusplus
 268 }
 269 #endif
 270
 271 #endif /* PIPE_CONTEXT_H */