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 /**
  47  * Gallium rendering context.  Basically:
  48  *  - state setting functions
  49  *  - VBO drawing functions
  50  *  - surface functions
  51  */
  52 struct pipe_context {
  53    struct pipe_winsys *winsys;
  54    struct pipe_screen *screen;
  55
  56    void *priv;  /**< context private data (for DRI for example) */
  57    void *draw;  /**< private, for draw module (temporary?) */
  58
  59    void (*destroy)( struct pipe_context * );
  60
  61
  62    /* Possible interface for setting edgeflags.  These aren't really
  63     * vertex elements, so don't fit there.
  64     */
  65    void (*set_edgeflags)( struct pipe_context *,
  66                           const unsigned *bitfield );
  67
  68
  69    /**
  70     * VBO drawing (return false on fallbacks (temporary??))
  71     */
  72    /*@{*/
  73    boolean (*draw_arrays)( struct pipe_context *pipe,
  74                            unsigned mode, unsigned start, unsigned count);
  75
  76    boolean (*draw_elements)( struct pipe_context *pipe,
  77                              struct pipe_buffer *indexBuffer,
  78                              unsigned indexSize,
  79                              unsigned mode, unsigned start, unsigned count);
  80
  81    /* XXX: this is (probably) a temporary entrypoint, as the range
  82     * information should be available from the vertex_buffer state.
  83     * Using this to quickly evaluate a specialized path in the draw
  84     * module.
  85     */
  86    boolean (*draw_range_elements)( struct pipe_context *pipe,
  87                                    struct pipe_buffer *indexBuffer,
  88                                    unsigned indexSize,
  89                                    unsigned minIndex,
  90                                    unsigned maxIndex,
  91                                    unsigned mode,
  92                                    unsigned start,
  93                                    unsigned count);
  94    /*@}*/
  95
  96
  97    /**
  98     * Query objects
  99     */
 100    /*@{*/
 101    struct pipe_query *(*create_query)( struct pipe_context *pipe,
 102                                               unsigned query_type );
 103
 104    void (*destroy_query)(struct pipe_context *pipe,
 105                          struct pipe_query *q);
 106
 107    void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
 108    void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
 109
 110    boolean (*get_query_result)(struct pipe_context *pipe,
 111                                struct pipe_query *q,
 112                                boolean wait,
 113                                uint64_t *result);
 114    /*@}*/
 115
 116    /**
 117     * State functions (create/bind/destroy state objects)
 118     */
 119    /*@{*/
 120    void * (*create_blend_state)(struct pipe_context *,
 121                                 const struct pipe_blend_state *);
 122    void   (*bind_blend_state)(struct pipe_context *, void *);
 123    void   (*delete_blend_state)(struct pipe_context *, void  *);
 124
 125    void * (*create_sampler_state)(struct pipe_context *,
 126                                   const struct pipe_sampler_state *);
 127    void   (*bind_sampler_states)(struct pipe_context *, unsigned num, void **);
 128    void   (*delete_sampler_state)(struct pipe_context *, void *);
 129
 130    void * (*create_rasterizer_state)(struct pipe_context *,
 131                                      const struct pipe_rasterizer_state *);
 132    void   (*bind_rasterizer_state)(struct pipe_context *, void *);
 133    void   (*delete_rasterizer_state)(struct pipe_context *, void *);
 134
 135    void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
 136                                         const struct pipe_depth_stencil_alpha_state *);
 137    void   (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
 138    void   (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
 139
 140    void * (*create_fs_state)(struct pipe_context *,
 141                              const struct pipe_shader_state *);
 142    void   (*bind_fs_state)(struct pipe_context *, void *);
 143    void   (*delete_fs_state)(struct pipe_context *, void *);
 144
 145    void * (*create_vs_state)(struct pipe_context *,
 146                              const struct pipe_shader_state *);
 147    void   (*bind_vs_state)(struct pipe_context *, void *);
 148    void   (*delete_vs_state)(struct pipe_context *, void *);
 149    /*@}*/
 150
 151    /**
 152     * Parameter-like state (or properties)
 153     */
 154    /*@{*/
 155    void (*set_blend_color)( struct pipe_context *,
 156                             const struct pipe_blend_color * );
 157
 158    void (*set_clip_state)( struct pipe_context *,
 159                            const struct pipe_clip_state * );
 160
 161    void (*set_constant_buffer)( struct pipe_context *,
 162                                 uint shader, uint index,
 163                                 const struct pipe_constant_buffer *buf );
 164
 165    void (*set_framebuffer_state)( struct pipe_context *,
 166                                   const struct pipe_framebuffer_state * );
 167
 168    void (*set_polygon_stipple)( struct pipe_context *,
 169                                 const struct pipe_poly_stipple * );
 170
 171    void (*set_scissor_state)( struct pipe_context *,
 172                               const struct pipe_scissor_state * );
 173
 174    void (*set_viewport_state)( struct pipe_context *,
 175                                const struct pipe_viewport_state * );
 176
 177    void (*set_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    /*@{*/
 195    void (*surface_copy)(struct pipe_context *pipe,
 196                         boolean do_flip,/**< flip surface contents vertically */
 197                         struct pipe_surface *dest,
 198                         unsigned destx, unsigned desty,
 199                         struct pipe_surface *src, /* don't make this const -
 200                                                      need to map/unmap */
 201                         unsigned srcx, unsigned srcy,
 202                         unsigned width, unsigned height);
 203
 204    void (*surface_fill)(struct pipe_context *pipe,
 205                         struct pipe_surface *dst,
 206                         unsigned dstx, unsigned dsty,
 207                         unsigned width, unsigned height,
 208                         unsigned value);
 209
 210    void (*clear)(struct pipe_context *pipe,
 211                  struct pipe_surface *ps,
 212                  unsigned clearValue);
 213    /*@}*/
 214
 215
 216    /** Flush rendering (flags = bitmask of PIPE_FLUSH_x tokens) */
 217    void (*flush)( struct pipe_context *pipe,
 218                   unsigned flags,
 219                   struct pipe_fence_handle **fence );
 220 };
 221
 222
 223 #ifdef __cplusplus
 224 }
 225 #endif
 226
 227 #endif /* PIPE_CONTEXT_H */