src/mesa/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 #include <stdint.h>
  33
  34 struct pipe_state_cache;
  35
  36 /* Opaque driver handles:
  37  */
  38 struct pipe_query;
  39
  40 /**
  41  * Gallium rendering context.  Basically:
  42  *  - state setting functions
  43  *  - VBO drawing functions
  44  *  - surface functions
  45  *  - device queries
  46  */
  47 struct pipe_context {
  48    struct pipe_winsys *winsys;
  49
  50    void *priv;  /** context private data (for DRI for example) */
  51
  52    void (*destroy)( struct pipe_context * );
  53
  54    /*
  55     * Queries
  56     */
  57    /** type is one of PIPE_SURFACE, PIPE_TEXTURE, etc. */
  58    boolean (*is_format_supported)( struct pipe_context *pipe,
  59                                    enum pipe_format format, uint type );
  60
  61    const char *(*get_name)( struct pipe_context *pipe );
  62
  63    const char *(*get_vendor)( struct pipe_context *pipe );
  64
  65    int (*get_param)( struct pipe_context *pipe, int param );
  66    float (*get_paramf)( struct pipe_context *pipe, int param );
  67
  68
  69    /*
  70     * Drawing.
  71     * Return false on fallbacks (temporary??)
  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_handle *indexBuffer,
  78                              unsigned indexSize,
  79                              unsigned mode, unsigned start, unsigned count);
  80
  81    /** Clear a surface to given value (no scissor; clear whole surface) */
  82    void (*clear)(struct pipe_context *pipe, struct pipe_surface *ps,
  83                  unsigned clearValue);
  84
  85    /**
  86     * Query objects
  87     */
  88    struct pipe_query *(*create_query)( struct pipe_context *pipe,
  89                                               unsigned query_type );
  90
  91    void (*destroy_query)(struct pipe_context *pipe,
  92                          struct pipe_query *q);
  93
  94    void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
  95    void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
  96
  97    boolean (*get_query_result)(struct pipe_context *pipe,
  98                                struct pipe_query *q,
  99                                boolean wait,
 100                                uint64_t *result);
 101
 102    /*
 103     * State functions
 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_state)(struct pipe_context *, unsigned unit, 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    /* The following look more properties than states.
 136     * maybe combine a few of them into states or pass them
 137     * in the bind calls to the state */
 138    void (*set_blend_color)( struct pipe_context *,
 139                             const struct pipe_blend_color * );
 140
 141    void (*set_clip_state)( struct pipe_context *,
 142                            const struct pipe_clip_state * );
 143
 144    void (*set_constant_buffer)( struct pipe_context *,
 145                                 uint shader, uint index,
 146                                 const struct pipe_constant_buffer *buf );
 147
 148    void (*set_framebuffer_state)( struct pipe_context *,
 149                                   const struct pipe_framebuffer_state * );
 150
 151    void (*set_polygon_stipple)( struct pipe_context *,
 152                                 const struct pipe_poly_stipple * );
 153
 154    void (*set_scissor_state)( struct pipe_context *,
 155                               const struct pipe_scissor_state * );
 156
 157
 158    /* Currently a sampler is constrained to sample from a single texture:
 159     */
 160    void (*set_sampler_texture)( struct pipe_context *,
 161                                 unsigned sampler,
 162                                 struct pipe_texture * );
 163
 164    void (*set_viewport_state)( struct pipe_context *,
 165                                const struct pipe_viewport_state * );
 166
 167    /*
 168     * Vertex arrays
 169     */
 170    void (*set_vertex_buffer)( struct pipe_context *,
 171                               unsigned index,
 172                               const struct pipe_vertex_buffer * );
 173
 174    void (*set_vertex_element)( struct pipe_context *,
 175                                unsigned index,
 176                                const struct pipe_vertex_element * );
 177
 178
 179    /** Get a surface which is a "view" into a texture */
 180    struct pipe_surface *(*get_tex_surface)(struct pipe_context *pipe,
 181                                            struct pipe_texture *texture,
 182                                            unsigned face, unsigned level,
 183                                            unsigned zslice);
 184
 185    /** Get a block of raw pixel data from a surface */
 186    void (*get_tile)(struct pipe_context *pipe,
 187                     struct pipe_surface *ps,
 188                     uint x, uint y, uint w, uint h,
 189                     void *p, int dst_stride);
 190    /** Put a block of raw pixel data into a surface */
 191    void (*put_tile)(struct pipe_context *pipe,
 192                     struct pipe_surface *ps,
 193                     uint x, uint y, uint w, uint h,
 194                     const void *p, int src_stride);
 195    /* XXX temporary here, move these to softpipe */
 196    void (*get_tile_rgba)(struct pipe_context *pipe, struct pipe_surface *ps,
 197                          uint x, uint y, uint w, uint h, float *p);
 198    void (*put_tile_rgba)(struct pipe_context *pipe, struct pipe_surface *ps,
 199                          uint x, uint y, uint w, uint h, const float *p);
 200
 201
 202    /*
 203     * Surface functions
 204     */
 205    void (*surface_data)(struct pipe_context *pipe,
 206                         struct pipe_surface *dest,
 207                         unsigned destx, unsigned desty,
 208                         const void *src, unsigned src_stride,
 209                         unsigned srcx, unsigned srcy,
 210                         unsigned width, unsigned height);
 211
 212    void (*surface_copy)(struct pipe_context *pipe,
 213                         struct pipe_surface *dest,
 214                         unsigned destx, unsigned desty,
 215                         struct pipe_surface *src, /* don't make this const -
 216                                                      need to map/unmap */
 217                         unsigned srcx, unsigned srcy,
 218                         unsigned width, unsigned height);
 219
 220    void (*surface_fill)(struct pipe_context *pipe,
 221                         struct pipe_surface *dst,
 222                         unsigned dstx, unsigned dsty,
 223                         unsigned width, unsigned height,
 224                         unsigned value);
 225
 226
 227    /*
 228     * Texture functions
 229     */
 230    void (*texture_create)(struct pipe_context *pipe,
 231                           struct pipe_texture **pt);
 232
 233    void (*texture_release)(struct pipe_context *pipe,
 234                            struct pipe_texture **pt);
 235
 236
 237    /* Flush rendering:
 238     */
 239    void (*flush)( struct pipe_context *pipe,
 240                   unsigned flags );
 241 };
 242
 243 #endif /* PIPE_CONTEXT_H */