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    boolean (*draw_arrays)( struct pipe_context *pipe,
  65                            unsigned mode, unsigned start, unsigned count);
  66
  67    boolean (*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    boolean (*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    /**
  89     * Query objects
  90     */
  91    /*@{*/
  92    struct pipe_query *(*create_query)( struct pipe_context *pipe,
  93                                        unsigned query_type );
  94
  95    void (*destroy_query)(struct pipe_context *pipe,
  96                          struct pipe_query *q);
  97
  98    void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
  99    void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
 100
 101    boolean (*get_query_result)(struct pipe_context *pipe,
 102                                struct pipe_query *q,
 103                                boolean wait,
 104                                uint64_t *result);
 105    /*@}*/
 106
 107    /**
 108     * State functions (create/bind/destroy state objects)
 109     */
 110    /*@{*/
 111    void * (*create_blend_state)(struct pipe_context *,
 112                                 const struct pipe_blend_state *);
 113    void   (*bind_blend_state)(struct pipe_context *, void *);
 114    void   (*delete_blend_state)(struct pipe_context *, void  *);
 115
 116    void * (*create_sampler_state)(struct pipe_context *,
 117                                   const struct pipe_sampler_state *);
 118    void   (*bind_fragment_sampler_states)(struct pipe_context *,
 119                                           unsigned num_samplers,
 120                                           void **samplers);
 121    void   (*bind_vertex_sampler_states)(struct pipe_context *,
 122                                         unsigned num_samplers,
 123                                         void **samplers);
 124    void   (*delete_sampler_state)(struct pipe_context *, void *);
 125
 126    void * (*create_rasterizer_state)(struct pipe_context *,
 127                                      const struct pipe_rasterizer_state *);
 128    void   (*bind_rasterizer_state)(struct pipe_context *, void *);
 129    void   (*delete_rasterizer_state)(struct pipe_context *, void *);
 130
 131    void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
 132                                         const struct pipe_depth_stencil_alpha_state *);
 133    void   (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
 134    void   (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
 135
 136    void * (*create_fs_state)(struct pipe_context *,
 137                              const struct pipe_shader_state *);
 138    void   (*bind_fs_state)(struct pipe_context *, void *);
 139    void   (*delete_fs_state)(struct pipe_context *, void *);
 140
 141    void * (*create_vs_state)(struct pipe_context *,
 142                              const struct pipe_shader_state *);
 143    void   (*bind_vs_state)(struct pipe_context *, void *);
 144    void   (*delete_vs_state)(struct pipe_context *, void *);
 145    /*@}*/
 146
 147    /**
 148     * Parameter-like state (or properties)
 149     */
 150    /*@{*/
 151    void (*set_blend_color)( struct pipe_context *,
 152                             const struct pipe_blend_color * );
 153
 154    void (*set_clip_state)( struct pipe_context *,
 155                            const struct pipe_clip_state * );
 156
 157    void (*set_constant_buffer)( struct pipe_context *,
 158                                 uint shader, uint index,
 159                                 const struct pipe_buffer *buf );
 160
 161    void (*set_framebuffer_state)( struct pipe_context *,
 162                                   const struct pipe_framebuffer_state * );
 163
 164    void (*set_polygon_stipple)( struct pipe_context *,
 165                                 const struct pipe_poly_stipple * );
 166
 167    void (*set_scissor_state)( struct pipe_context *,
 168                               const struct pipe_scissor_state * );
 169
 170    void (*set_viewport_state)( struct pipe_context *,
 171                                const struct pipe_viewport_state * );
 172
 173    void (*set_fragment_sampler_textures)(struct pipe_context *,
 174                                          unsigned num_textures,
 175                                          struct pipe_texture **);
 176
 177    void (*set_vertex_sampler_textures)(struct pipe_context *,
 178                                        unsigned num_textures,
 179                                        struct pipe_texture **);
 180
 181    void (*set_vertex_buffers)( struct pipe_context *,
 182                                unsigned num_buffers,
 183                                const struct pipe_vertex_buffer * );
 184
 185    void (*set_vertex_elements)( struct pipe_context *,
 186                                 unsigned num_elements,
 187                                 const struct pipe_vertex_element * );
 188    /*@}*/
 189
 190
 191    /**
 192     * Surface functions
 193     *
 194     * The pipe driver is allowed to set these functions to NULL, and in that
 195     * case, they will not be available.
 196     */
 197    /*@{*/
 198
 199    /**
 200     * Copy a block of pixels from one surface to another.
 201     * The surfaces must be of the same format.
 202     */
 203    void (*surface_copy)(struct pipe_context *pipe,
 204                         struct pipe_surface *dest,
 205                         unsigned destx, unsigned desty,
 206                         struct pipe_surface *src,
 207                         unsigned srcx, unsigned srcy,
 208                         unsigned width, unsigned height);
 209
 210    /**
 211     * Fill a region of a surface with a constant value.
 212     */
 213    void (*surface_fill)(struct pipe_context *pipe,
 214                         struct pipe_surface *dst,
 215                         unsigned dstx, unsigned dsty,
 216                         unsigned width, unsigned height,
 217                         unsigned value);
 218    /*@}*/
 219
 220    /**
 221     * Clear the specified set of currently bound buffers to specified values.
 222     * The entire buffers are cleared (no scissor, no colormask, etc).
 223     *
 224     * \param buffers  bitfield of PIPE_CLEAR_* values.
 225     * \param rgba  pointer to an array of one float for each of r, g, b, a.
 226     * \param depth  depth clear value in [0,1].
 227     * \param stencil  stencil clear value
 228     */
 229    void (*clear)(struct pipe_context *pipe,
 230                  unsigned buffers,
 231                  const float *rgba,
 232                  double depth,
 233                  unsigned stencil);
 234
 235    /** Flush rendering
 236     * \param flags  bitmask of PIPE_FLUSH_x tokens)
 237     */
 238    void (*flush)( struct pipe_context *pipe,
 239                   unsigned flags,
 240                   struct pipe_fence_handle **fence );
 241
 242    /**
 243     * Check whether a texture is referenced by an unflushed hw command.
 244     * The state-tracker uses this function to optimize away unnecessary
 245     * flushes. It is safe (but wasteful) to always return.
 246     * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
 247     * \param pipe  The pipe context whose unflushed hw commands will be
 248     *              checked.
 249     * \param level  mipmap level.
 250     * \param texture  texture to check.
 251     * \param face  cubemap face. Use 0 for non-cubemap texture.
 252     */
 253    unsigned int (*is_texture_referenced) (struct pipe_context *pipe,
 254                                           struct pipe_texture *texture,
 255                                           unsigned face, unsigned level);
 256
 257    /**
 258     * Check whether a buffer is referenced by an unflushed hw command.
 259     * The state-tracker uses this function to optimize away unnecessary
 260     * flushes. It is safe (but wasteful) to always return
 261     * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
 262     * \param pipe  The pipe context whose unflushed hw commands will be
 263     *              checked.
 264     * \param buf  Buffer to check.
 265     */
 266    unsigned int (*is_buffer_referenced) (struct pipe_context *pipe,
 267                                          struct pipe_buffer *buf);
 268 };
 269
 270
 271 #ifdef __cplusplus
 272 }
 273 #endif
 274
 275 #endif /* PIPE_CONTEXT_H */