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