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     * VBO drawing (return false on fallbacks (temporary??))
  62     */
  63    /*@{*/
  64    void (*draw_arrays)( struct pipe_context *pipe,
  65                         unsigned mode, unsigned start, unsigned count);
  66
  67    void (*draw_elements)( struct pipe_context *pipe,
  68                           struct pipe_buffer *indexBuffer,
  69                           unsigned indexSize,
  70                           unsigned mode, unsigned start, unsigned count);
  71
  72    /* XXX: this is (probably) a temporary entrypoint, as the range
  73     * information should be available from the vertex_buffer state.
  74     * Using this to quickly evaluate a specialized path in the draw
  75     * module.
  76     */
  77    void (*draw_range_elements)( struct pipe_context *pipe,
  78                                 struct pipe_buffer *indexBuffer,
  79                                 unsigned indexSize,
  80                                 unsigned minIndex,
  81                                 unsigned maxIndex,
  82                                 unsigned mode,
  83                                 unsigned start,
  84                                 unsigned count);
  85    /*@}*/
  86
  87    /**
  88     * Predicate subsequent rendering on occlusion query result
  89     * \param query  the query predicate, or NULL if no predicate
  90     * \param mode  one of PIPE_COND_RENDER_x
  91     */
  92    void (*render_condition)( struct pipe_context *pipe,
  93                              struct pipe_query *query,
  94                              uint mode );
  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_fragment_sampler_states)(struct pipe_context *,
 127                                           unsigned num_samplers,
 128                                           void **samplers);
 129    void   (*bind_vertex_sampler_states)(struct pipe_context *,
 130                                         unsigned num_samplers,
 131                                         void **samplers);
 132    void   (*delete_sampler_state)(struct pipe_context *, void *);
 133
 134    void * (*create_rasterizer_state)(struct pipe_context *,
 135                                      const struct pipe_rasterizer_state *);
 136    void   (*bind_rasterizer_state)(struct pipe_context *, void *);
 137    void   (*delete_rasterizer_state)(struct pipe_context *, void *);
 138
 139    void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
 140                                         const struct pipe_depth_stencil_alpha_state *);
 141    void   (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
 142    void   (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
 143
 144    void * (*create_fs_state)(struct pipe_context *,
 145                              const struct pipe_shader_state *);
 146    void   (*bind_fs_state)(struct pipe_context *, void *);
 147    void   (*delete_fs_state)(struct pipe_context *, void *);
 148
 149    void * (*create_vs_state)(struct pipe_context *,
 150                              const struct pipe_shader_state *);
 151    void   (*bind_vs_state)(struct pipe_context *, void *);
 152    void   (*delete_vs_state)(struct pipe_context *, void *);
 153
 154    void * (*create_gs_state)(struct pipe_context *,
 155                              const struct pipe_shader_state *);
 156    void   (*bind_gs_state)(struct pipe_context *, void *);
 157    void   (*delete_gs_state)(struct pipe_context *, void *);
 158
 159    /*@}*/
 160
 161    /**
 162     * Parameter-like state (or properties)
 163     */
 164    /*@{*/
 165    void (*set_blend_color)( struct pipe_context *,
 166                             const struct pipe_blend_color * );
 167
 168    void (*set_clip_state)( struct pipe_context *,
 169                            const struct pipe_clip_state * );
 170
 171    void (*set_constant_buffer)( struct pipe_context *,
 172                                 uint shader, uint index,
 173                                 const struct pipe_constant_buffer *buf );
 174
 175    void (*set_framebuffer_state)( struct pipe_context *,
 176                                   const struct pipe_framebuffer_state * );
 177
 178    void (*set_polygon_stipple)( struct pipe_context *,
 179                                 const struct pipe_poly_stipple * );
 180
 181    void (*set_scissor_state)( struct pipe_context *,
 182                               const struct pipe_scissor_state * );
 183
 184    void (*set_viewport_state)( struct pipe_context *,
 185                                const struct pipe_viewport_state * );
 186
 187    void (*set_fragment_sampler_textures)(struct pipe_context *,
 188                                          unsigned num_textures,
 189                                          struct pipe_texture **);
 190
 191    void (*set_vertex_sampler_textures)(struct pipe_context *,
 192                                        unsigned num_textures,
 193                                        struct pipe_texture **);
 194
 195    void (*set_vertex_buffers)( struct pipe_context *,
 196                                unsigned num_buffers,
 197                                const struct pipe_vertex_buffer * );
 198
 199    void (*set_vertex_elements)( struct pipe_context *,
 200                                 unsigned num_elements,
 201                                 const struct pipe_vertex_element * );
 202    /*@}*/
 203
 204
 205    /**
 206     * Surface functions
 207     *
 208     * The pipe driver is allowed to set these functions to NULL, and in that
 209     * case, they will not be available.
 210     */
 211    /*@{*/
 212
 213    /**
 214     * Copy a block of pixels from one surface to another.
 215     * The surfaces must be of the same format.
 216     */
 217    void (*surface_copy)(struct pipe_context *pipe,
 218                         struct pipe_surface *dest,
 219                         unsigned destx, unsigned desty,
 220                         struct pipe_surface *src,
 221                         unsigned srcx, unsigned srcy,
 222                         unsigned width, unsigned height);
 223
 224    /**
 225     * Fill a region of a surface with a constant value.
 226     */
 227    void (*surface_fill)(struct pipe_context *pipe,
 228                         struct pipe_surface *dst,
 229                         unsigned dstx, unsigned dsty,
 230                         unsigned width, unsigned height,
 231                         unsigned value);
 232    /*@}*/
 233
 234    /**
 235     * Clear the specified set of currently bound buffers to specified values.
 236     * The entire buffers are cleared (no scissor, no colormask, etc).
 237     *
 238     * \param buffers  bitfield of PIPE_CLEAR_* values.
 239     * \param rgba  pointer to an array of one float for each of r, g, b, a.
 240     * \param depth  depth clear value in [0,1].
 241     * \param stencil  stencil clear value
 242     */
 243    void (*clear)(struct pipe_context *pipe,
 244                  unsigned buffers,
 245                  const float *rgba,
 246                  double depth,
 247                  unsigned stencil);
 248
 249    /** Flush rendering
 250     * \param flags  bitmask of PIPE_FLUSH_x tokens)
 251     */
 252    void (*flush)( struct pipe_context *pipe,
 253                   unsigned flags,
 254                   struct pipe_fence_handle **fence );
 255
 256    /**
 257     * Check whether a texture is referenced by an unflushed hw command.
 258     * The state-tracker uses this function to optimize away unnecessary
 259     * flushes. It is safe (but wasteful) to always return.
 260     * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
 261     * \param pipe  The pipe context whose unflushed hw commands will be
 262     *              checked.
 263     * \param level  mipmap level.
 264     * \param texture  texture to check.
 265     * \param face  cubemap face. Use 0 for non-cubemap texture.
 266     */
 267    unsigned int (*is_texture_referenced) (struct pipe_context *pipe,
 268                                           struct pipe_texture *texture,
 269                                           unsigned face, unsigned level);
 270
 271    /**
 272     * Check whether a buffer is referenced by an unflushed hw command.
 273     * The state-tracker uses this function to optimize away unnecessary
 274     * flushes. It is safe (but wasteful) to always return
 275     * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
 276     * \param pipe  The pipe context whose unflushed hw commands will be
 277     *              checked.
 278     * \param buf  Buffer to check.
 279     */
 280    unsigned int (*is_buffer_referenced) (struct pipe_context *pipe,
 281                                          struct pipe_buffer *buf);
 282 };
 283
 284
 285 #ifdef __cplusplus
 286 }
 287 #endif
 288
 289 #endif /* PIPE_CONTEXT_H */