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_state_cache;
  40
  41 /* Opaque driver handles:
  42  */
  43 struct pipe_query;
  44
  45 /**
  46  * Gallium rendering context.  Basically:
  47  *  - state setting functions
  48  *  - VBO drawing functions
  49  *  - surface functions
  50  *  - device queries
  51  */
  52 struct pipe_context {
  53    struct pipe_winsys *winsys;
  54
  55    void *priv;  /** context private data (for DRI for example) */
  56
  57    void (*destroy)( struct pipe_context * );
  58
  59    /*
  60     * Queries
  61     */
  62    /** type is one of PIPE_SURFACE, PIPE_TEXTURE, etc. */
  63    boolean (*is_format_supported)( struct pipe_context *pipe,
  64                                    enum pipe_format format, uint type );
  65
  66    const char *(*get_name)( struct pipe_context *pipe );
  67
  68    const char *(*get_vendor)( struct pipe_context *pipe );
  69
  70    int (*get_param)( struct pipe_context *pipe, int param );
  71    float (*get_paramf)( struct pipe_context *pipe, int param );
  72
  73
  74    /*
  75     * Drawing.
  76     * Return false on fallbacks (temporary??)
  77     */
  78    boolean (*draw_arrays)( struct pipe_context *pipe,
  79                            unsigned mode, unsigned start, unsigned count);
  80
  81    boolean (*draw_elements)( struct pipe_context *pipe,
  82                              struct pipe_buffer *indexBuffer,
  83                              unsigned indexSize,
  84                              unsigned mode, unsigned start, unsigned count);
  85
  86
  87    /**
  88     * Query objects
  89     */
  90    struct pipe_query *(*create_query)( struct pipe_context *pipe,
  91                                               unsigned query_type );
  92
  93    void (*destroy_query)(struct pipe_context *pipe,
  94                          struct pipe_query *q);
  95
  96    void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
  97    void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
  98
  99    boolean (*get_query_result)(struct pipe_context *pipe,
 100                                struct pipe_query *q,
 101                                boolean wait,
 102                                uint64 *result);
 103
 104    /*
 105     * State functions
 106     */
 107    void * (*create_blend_state)(struct pipe_context *,
 108                                 const struct pipe_blend_state *);
 109    void   (*bind_blend_state)(struct pipe_context *, void *);
 110    void   (*delete_blend_state)(struct pipe_context *, void  *);
 111
 112    void * (*create_sampler_state)(struct pipe_context *,
 113                                   const struct pipe_sampler_state *);
 114    void   (*bind_sampler_state)(struct pipe_context *, unsigned unit, void *);
 115    void   (*delete_sampler_state)(struct pipe_context *, void *);
 116
 117    void * (*create_rasterizer_state)(struct pipe_context *,
 118                                      const struct pipe_rasterizer_state *);
 119    void   (*bind_rasterizer_state)(struct pipe_context *, void *);
 120    void   (*delete_rasterizer_state)(struct pipe_context *, void *);
 121
 122    void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
 123                                         const struct pipe_depth_stencil_alpha_state *);
 124    void   (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
 125    void   (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
 126
 127    void * (*create_fs_state)(struct pipe_context *,
 128                              const struct pipe_shader_state *);
 129    void   (*bind_fs_state)(struct pipe_context *, void *);
 130    void   (*delete_fs_state)(struct pipe_context *, void *);
 131
 132    void * (*create_vs_state)(struct pipe_context *,
 133                              const struct pipe_shader_state *);
 134    void   (*bind_vs_state)(struct pipe_context *, void *);
 135    void   (*delete_vs_state)(struct pipe_context *, void *);
 136
 137    /* The following look more properties than states.
 138     * maybe combine a few of them into states or pass them
 139     * in the bind calls to the state */
 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
 160    /* Currently a sampler is constrained to sample from a single texture:
 161     */
 162    void (*set_sampler_texture)( struct pipe_context *,
 163                                 unsigned sampler,
 164                                 struct pipe_texture * );
 165
 166    void (*set_viewport_state)( struct pipe_context *,
 167                                const struct pipe_viewport_state * );
 168
 169    /*
 170     * Vertex arrays
 171     */
 172    void (*set_vertex_buffer)( struct pipe_context *,
 173                               unsigned index,
 174                               const struct pipe_vertex_buffer * );
 175
 176    void (*set_vertex_element)( struct pipe_context *,
 177                                unsigned index,
 178                                const struct pipe_vertex_element * );
 179
 180
 181    /*
 182     * Surface functions
 183     */
 184
 185    void (*surface_copy)(struct pipe_context *pipe,
 186                         unsigned do_flip,       /*<< flip surface contents vertically */
 187                         struct pipe_surface *dest,
 188                         unsigned destx, unsigned desty,
 189                         struct pipe_surface *src, /* don't make this const -
 190                                                      need to map/unmap */
 191                         unsigned srcx, unsigned srcy,
 192                         unsigned width, unsigned height);
 193
 194    void (*surface_fill)(struct pipe_context *pipe,
 195                         struct pipe_surface *dst,
 196                         unsigned dstx, unsigned dsty,
 197                         unsigned width, unsigned height,
 198                         unsigned value);
 199
 200    void (*clear)(struct pipe_context *pipe,
 201                  struct pipe_surface *ps,
 202                  unsigned clearValue);
 203
 204
 205    /*
 206     * Texture functions
 207     */
 208    struct pipe_texture * (*texture_create)(struct pipe_context *pipe,
 209                                            const struct pipe_texture *templat);
 210
 211    void (*texture_release)(struct pipe_context *pipe,
 212                            struct pipe_texture **pt);
 213
 214    /**
 215     * Called when texture data is changed.
 216     * Note: we could pass some hints about which mip levels or cube faces
 217     * have changed...
 218     */
 219    void (*texture_update)(struct pipe_context *pipe,
 220                           struct pipe_texture *texture);
 221
 222    /** Get a surface which is a "view" into a texture */
 223    struct pipe_surface *(*get_tex_surface)(struct pipe_context *pipe,
 224                                            struct pipe_texture *texture,
 225                                            unsigned face, unsigned level,
 226                                            unsigned zslice);
 227
 228    /* Flush rendering:
 229     */
 230    void (*flush)( struct pipe_context *pipe,
 231                   unsigned flags );
 232 };
 233
 234
 235 #ifdef __cplusplus
 236 }
 237 #endif
 238
 239 #endif /* PIPE_CONTEXT_H */