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