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
  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
  73
  74    /**
  75     * Query objects
  76     */
  77    /*@{*/
  78    struct pipe_query *(*create_query)( struct pipe_context *pipe,
  79                                               unsigned query_type );
  80
  81    void (*destroy_query)(struct pipe_context *pipe,
  82                          struct pipe_query *q);
  83
  84    void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
  85    void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
  86
  87    boolean (*get_query_result)(struct pipe_context *pipe,
  88                                struct pipe_query *q,
  89                                boolean wait,
  90                                uint64 *result);
  91    /*@}*/
  92
  93    /**
  94     * State functions (create/bind/destroy state objects)
  95     */
  96    /*@{*/
  97    void * (*create_blend_state)(struct pipe_context *,
  98                                 const struct pipe_blend_state *);
  99    void   (*bind_blend_state)(struct pipe_context *, void *);
 100    void   (*delete_blend_state)(struct pipe_context *, void  *);
 101
 102    void * (*create_sampler_state)(struct pipe_context *,
 103                                   const struct pipe_sampler_state *);
 104    void   (*bind_sampler_states)(struct pipe_context *, unsigned num, void **);
 105    void   (*delete_sampler_state)(struct pipe_context *, void *);
 106
 107    void * (*create_rasterizer_state)(struct pipe_context *,
 108                                      const struct pipe_rasterizer_state *);
 109    void   (*bind_rasterizer_state)(struct pipe_context *, void *);
 110    void   (*delete_rasterizer_state)(struct pipe_context *, void *);
 111
 112    void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
 113                                         const struct pipe_depth_stencil_alpha_state *);
 114    void   (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
 115    void   (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
 116
 117    void * (*create_fs_state)(struct pipe_context *,
 118                              const struct pipe_shader_state *);
 119    void   (*bind_fs_state)(struct pipe_context *, void *);
 120    void   (*delete_fs_state)(struct pipe_context *, void *);
 121
 122    void * (*create_vs_state)(struct pipe_context *,
 123                              const struct pipe_shader_state *);
 124    void   (*bind_vs_state)(struct pipe_context *, void *);
 125    void   (*delete_vs_state)(struct pipe_context *, void *);
 126    /*@}*/
 127
 128    /**
 129     * Parameter-like state (or properties)
 130     */
 131    /*@{*/
 132    void (*set_blend_color)( struct pipe_context *,
 133                             const struct pipe_blend_color * );
 134
 135    void (*set_clip_state)( struct pipe_context *,
 136                            const struct pipe_clip_state * );
 137
 138    void (*set_constant_buffer)( struct pipe_context *,
 139                                 uint shader, uint index,
 140                                 const struct pipe_constant_buffer *buf );
 141
 142    void (*set_framebuffer_state)( struct pipe_context *,
 143                                   const struct pipe_framebuffer_state * );
 144
 145    void (*set_polygon_stipple)( struct pipe_context *,
 146                                 const struct pipe_poly_stipple * );
 147
 148    void (*set_scissor_state)( struct pipe_context *,
 149                               const struct pipe_scissor_state * );
 150
 151    void (*set_viewport_state)( struct pipe_context *,
 152                                const struct pipe_viewport_state * );
 153
 154    void (*set_sampler_textures)( struct pipe_context *,
 155                                  unsigned num_textures,
 156                                  struct pipe_texture ** );
 157
 158    void (*set_vertex_buffer)( struct pipe_context *,
 159                               unsigned index,
 160                               const struct pipe_vertex_buffer * );
 161
 162    void (*set_vertex_element)( struct pipe_context *,
 163                                unsigned index,
 164                                const struct pipe_vertex_element * );
 165    /*@}*/
 166
 167
 168    /**
 169     * Surface functions
 170     */
 171    /*@{*/
 172    void (*surface_copy)(struct pipe_context *pipe,
 173                         unsigned do_flip,       /*<< flip surface contents vertically */
 174                         struct pipe_surface *dest,
 175                         unsigned destx, unsigned desty,
 176                         struct pipe_surface *src, /* don't make this const -
 177                                                      need to map/unmap */
 178                         unsigned srcx, unsigned srcy,
 179                         unsigned width, unsigned height);
 180
 181    void (*surface_fill)(struct pipe_context *pipe,
 182                         struct pipe_surface *dst,
 183                         unsigned dstx, unsigned dsty,
 184                         unsigned width, unsigned height,
 185                         unsigned value);
 186
 187    void (*clear)(struct pipe_context *pipe,
 188                  struct pipe_surface *ps,
 189                  unsigned clearValue);
 190    /*@}*/
 191
 192
 193    /** Called when texture data is changed */
 194    void (*texture_update)(struct pipe_context *pipe,
 195                           struct pipe_texture *texture,
 196                           uint face, uint dirtyLevelsMask);
 197
 198
 199    /** Flush rendering (flags = bitmask of PIPE_FLUSH_x tokens) */
 200    void (*flush)( struct pipe_context *pipe,
 201                   unsigned flags,
 202                   struct pipe_fence_handle **fence );
 203 };
 204
 205
 206 #ifdef __cplusplus
 207 }
 208 #endif
 209
 210 #endif /* PIPE_CONTEXT_H */