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_compiler.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37
  38 struct pipe_blend_color;
  39 struct pipe_blend_state;
  40 struct pipe_box;
  41 struct pipe_clip_state;
  42 struct pipe_depth_stencil_alpha_state;
  43 struct pipe_draw_info;
  44 struct pipe_fence_handle;
  45 struct pipe_framebuffer_state;
  46 struct pipe_index_buffer;
  47 struct pipe_query;
  48 struct pipe_poly_stipple;
  49 struct pipe_rasterizer_state;
  50 struct pipe_resource;
  51 struct pipe_sampler_state;
  52 struct pipe_sampler_view;
  53 struct pipe_scissor_state;
  54 struct pipe_shader_state;
  55 struct pipe_stencil_ref;
  56 struct pipe_stream_output_state;
  57 struct pipe_surface;
  58 struct pipe_vertex_buffer;
  59 struct pipe_vertex_element;
  60 struct pipe_viewport_state;
  61
  62 /**
  63  * Gallium rendering context.  Basically:
  64  *  - state setting functions
  65  *  - VBO drawing functions
  66  *  - surface functions
  67  */
  68 struct pipe_context {
  69    struct pipe_winsys *winsys;
  70    struct pipe_screen *screen;
  71
  72    void *priv;  /**< context private data (for DRI for example) */
  73    void *draw;  /**< private, for draw module (temporary?) */
  74
  75    void (*destroy)( struct pipe_context * );
  76
  77    /**
  78     * VBO drawing
  79     */
  80    /*@{*/
  81    void (*draw_vbo)( struct pipe_context *pipe,
  82                      const struct pipe_draw_info *info );
  83
  84    /**
  85     * Draw the stream output buffer at index 0
  86     */
  87    void (*draw_stream_output)( struct pipe_context *pipe, unsigned mode );
  88    /*@}*/
  89
  90    /**
  91     * Predicate subsequent rendering on occlusion query result
  92     * \param query  the query predicate, or NULL if no predicate
  93     * \param mode  one of PIPE_RENDER_COND_x
  94     */
  95    void (*render_condition)( struct pipe_context *pipe,
  96                              struct pipe_query *query,
  97                              uint mode );
  98
  99    /**
 100     * Query objects
 101     */
 102    /*@{*/
 103    struct pipe_query *(*create_query)( struct pipe_context *pipe,
 104                                        unsigned query_type );
 105
 106    void (*destroy_query)(struct pipe_context *pipe,
 107                          struct pipe_query *q);
 108
 109    void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
 110    void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
 111
 112    /**
 113     * Get results of a query.
 114     * \param wait  if true, this query will block until the result is ready
 115     * \return TRUE if results are ready, FALSE otherwise
 116     */
 117    boolean (*get_query_result)(struct pipe_context *pipe,
 118                                struct pipe_query *q,
 119                                boolean wait,
 120                                void *result);
 121    /*@}*/
 122
 123    /**
 124     * State functions (create/bind/destroy state objects)
 125     */
 126    /*@{*/
 127    void * (*create_blend_state)(struct pipe_context *,
 128                                 const struct pipe_blend_state *);
 129    void   (*bind_blend_state)(struct pipe_context *, void *);
 130    void   (*delete_blend_state)(struct pipe_context *, void  *);
 131
 132    void * (*create_sampler_state)(struct pipe_context *,
 133                                   const struct pipe_sampler_state *);
 134    void   (*bind_fragment_sampler_states)(struct pipe_context *,
 135                                           unsigned num_samplers,
 136                                           void **samplers);
 137    void   (*bind_vertex_sampler_states)(struct pipe_context *,
 138                                         unsigned num_samplers,
 139                                         void **samplers);
 140    void   (*bind_geometry_sampler_states)(struct pipe_context *,
 141                                           unsigned num_samplers,
 142                                           void **samplers);
 143    void   (*delete_sampler_state)(struct pipe_context *, void *);
 144
 145    void * (*create_rasterizer_state)(struct pipe_context *,
 146                                      const struct pipe_rasterizer_state *);
 147    void   (*bind_rasterizer_state)(struct pipe_context *, void *);
 148    void   (*delete_rasterizer_state)(struct pipe_context *, void *);
 149
 150    void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
 151                                         const struct pipe_depth_stencil_alpha_state *);
 152    void   (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
 153    void   (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
 154
 155    void * (*create_fs_state)(struct pipe_context *,
 156                              const struct pipe_shader_state *);
 157    void   (*bind_fs_state)(struct pipe_context *, void *);
 158    void   (*delete_fs_state)(struct pipe_context *, void *);
 159
 160    void * (*create_vs_state)(struct pipe_context *,
 161                              const struct pipe_shader_state *);
 162    void   (*bind_vs_state)(struct pipe_context *, void *);
 163    void   (*delete_vs_state)(struct pipe_context *, void *);
 164
 165    void * (*create_gs_state)(struct pipe_context *,
 166                              const struct pipe_shader_state *);
 167    void   (*bind_gs_state)(struct pipe_context *, void *);
 168    void   (*delete_gs_state)(struct pipe_context *, void *);
 169
 170    void * (*create_vertex_elements_state)(struct pipe_context *,
 171                                           unsigned num_elements,
 172                                           const struct pipe_vertex_element *);
 173    void   (*bind_vertex_elements_state)(struct pipe_context *, void *);
 174    void   (*delete_vertex_elements_state)(struct pipe_context *, void *);
 175
 176    void * (*create_stream_output_state)(struct pipe_context *,
 177                                         const struct pipe_stream_output_state *);
 178    void   (*bind_stream_output_state)(struct pipe_context *, void *);
 179    void   (*delete_stream_output_state)(struct pipe_context*, void*);
 180
 181    /*@}*/
 182
 183    /**
 184     * Parameter-like state (or properties)
 185     */
 186    /*@{*/
 187    void (*set_blend_color)( struct pipe_context *,
 188                             const struct pipe_blend_color * );
 189
 190    void (*set_stencil_ref)( struct pipe_context *,
 191                             const struct pipe_stencil_ref * );
 192
 193    void (*set_sample_mask)( struct pipe_context *,
 194                             unsigned sample_mask );
 195
 196    void (*set_clip_state)( struct pipe_context *,
 197                             const struct pipe_clip_state * );
 198
 199    void (*set_constant_buffer)( struct pipe_context *,
 200                                 uint shader, uint index,
 201                                 struct pipe_resource *buf );
 202
 203    void (*set_framebuffer_state)( struct pipe_context *,
 204                                   const struct pipe_framebuffer_state * );
 205
 206    void (*set_polygon_stipple)( struct pipe_context *,
 207                                 const struct pipe_poly_stipple * );
 208
 209    void (*set_scissor_state)( struct pipe_context *,
 210                               const struct pipe_scissor_state * );
 211
 212    void (*set_viewport_state)( struct pipe_context *,
 213                                const struct pipe_viewport_state * );
 214
 215    void (*set_fragment_sampler_views)(struct pipe_context *,
 216                                       unsigned num_views,
 217                                       struct pipe_sampler_view **);
 218
 219    void (*set_vertex_sampler_views)(struct pipe_context *,
 220                                     unsigned num_views,
 221                                     struct pipe_sampler_view **);
 222
 223    void (*set_geometry_sampler_views)(struct pipe_context *,
 224                                       unsigned num_views,
 225                                       struct pipe_sampler_view **);
 226
 227    void (*set_vertex_buffers)( struct pipe_context *,
 228                                unsigned num_buffers,
 229                                const struct pipe_vertex_buffer * );
 230
 231    void (*set_index_buffer)( struct pipe_context *pipe,
 232                              const struct pipe_index_buffer * );
 233
 234    void (*set_stream_output_buffers)(struct pipe_context *,
 235                                      struct pipe_resource **buffers,
 236                                      int *offsets, /*array of offsets
 237                                                      from the start of each
 238                                                      of the buffers */
 239                                      int num_buffers);
 240
 241    /*@}*/
 242
 243
 244    /**
 245     * Resource functions for blit-like functionality
 246     *
 247     * If a driver supports multisampling, resource_resolve must be available.
 248     */
 249    /*@{*/
 250
 251    /**
 252     * Copy a block of pixels from one resource to another.
 253     * The resource must be of the same format.
 254     * Resources with nr_samples > 1 are not allowed.
 255     */
 256    void (*resource_copy_region)(struct pipe_context *pipe,
 257                                 struct pipe_resource *dst,
 258                                 unsigned dst_level,
 259                                 unsigned dstx, unsigned dsty, unsigned dstz,
 260                                 struct pipe_resource *src,
 261                                 unsigned src_level,
 262                                 const struct pipe_box *src_box);
 263
 264    /**
 265     * Resolve a multisampled resource into a non-multisampled one.
 266     * Source and destination must have the same size and same format.
 267     */
 268    void (*resource_resolve)(struct pipe_context *pipe,
 269                             struct pipe_resource *dst,
 270                             unsigned dst_layer,
 271                             struct pipe_resource *src,
 272                             unsigned src_layer);
 273
 274    /*@}*/
 275
 276    /**
 277     * Clear the specified set of currently bound buffers to specified values.
 278     * The entire buffers are cleared (no scissor, no colormask, etc).
 279     *
 280     * \param buffers  bitfield of PIPE_CLEAR_* values.
 281     * \param rgba  pointer to an array of one float for each of r, g, b, a.
 282     * \param depth  depth clear value in [0,1].
 283     * \param stencil  stencil clear value
 284     */
 285    void (*clear)(struct pipe_context *pipe,
 286                  unsigned buffers,
 287                  const float *rgba,
 288                  double depth,
 289                  unsigned stencil);
 290
 291    /**
 292     * Clear a color rendertarget surface.
 293     * \param rgba  pointer to an array of one float for each of r, g, b, a.
 294     */
 295    void (*clear_render_target)(struct pipe_context *pipe,
 296                                struct pipe_surface *dst,
 297                                const float *rgba,
 298                                unsigned dstx, unsigned dsty,
 299                                unsigned width, unsigned height);
 300
 301    /**
 302     * Clear a depth-stencil surface.
 303     * \param clear_flags  bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
 304     * \param depth  depth clear value in [0,1].
 305     * \param stencil  stencil clear value
 306     */
 307    void (*clear_depth_stencil)(struct pipe_context *pipe,
 308                                struct pipe_surface *dst,
 309                                unsigned clear_flags,
 310                                double depth,
 311                                unsigned stencil,
 312                                unsigned dstx, unsigned dsty,
 313                                unsigned width, unsigned height);
 314
 315    /** Flush draw commands
 316     */
 317    void (*flush)( struct pipe_context *pipe,
 318                   struct pipe_fence_handle **fence );
 319
 320    /**
 321     * Create a view on a texture to be used by a shader stage.
 322     */
 323    struct pipe_sampler_view * (*create_sampler_view)(struct pipe_context *ctx,
 324                                                      struct pipe_resource *texture,
 325                                                      const struct pipe_sampler_view *templat);
 326
 327    void (*sampler_view_destroy)(struct pipe_context *ctx,
 328                                 struct pipe_sampler_view *view);
 329
 330
 331    /**
 332     * Get a surface which is a "view" into a resource, used by
 333     * render target / depth stencil stages.
 334     * \param usage  bitmaks of PIPE_BIND_* flags
 335     */
 336    struct pipe_surface *(*create_surface)(struct pipe_context *ctx,
 337                                           struct pipe_resource *resource,
 338                                           const struct pipe_surface *templat);
 339
 340    void (*surface_destroy)(struct pipe_context *ctx,
 341                            struct pipe_surface *);
 342
 343    /**
 344     * Get a transfer object for transferring data to/from a texture.
 345     *
 346     * Transfers are (by default) context-private and allow uploads to be
 347     * interleaved with
 348     */
 349    struct pipe_transfer *(*get_transfer)(struct pipe_context *,
 350                                          struct pipe_resource *resource,
 351                                          unsigned level,
 352                                          unsigned usage,  /* a combination of PIPE_TRANSFER_x */
 353                                          const struct pipe_box *);
 354
 355    void (*transfer_destroy)(struct pipe_context *,
 356                             struct pipe_transfer *);
 357
 358    void *(*transfer_map)( struct pipe_context *,
 359                           struct pipe_transfer *transfer );
 360
 361    /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the
 362     * regions specified with this call are guaranteed to be written to
 363     * the resource.
 364     */
 365    void (*transfer_flush_region)( struct pipe_context *,
 366                                   struct pipe_transfer *transfer,
 367                                   const struct pipe_box *);
 368
 369    void (*transfer_unmap)( struct pipe_context *,
 370                            struct pipe_transfer *transfer );
 371
 372
 373    /* One-shot transfer operation with data supplied in a user
 374     * pointer.  XXX: strides??
 375     */
 376    void (*transfer_inline_write)( struct pipe_context *,
 377                                   struct pipe_resource *,
 378                                   unsigned level,
 379                                   unsigned usage, /* a combination of PIPE_TRANSFER_x */
 380                                   const struct pipe_box *,
 381                                   const void *data,
 382                                   unsigned stride,
 383                                   unsigned layer_stride);
 384
 385
 386    /* Notify a driver that a content of a user buffer has been changed.
 387     * The changed range is [offset, offset+size-1].
 388     * The new width0 of the buffer is offset+size. */
 389    void (*redefine_user_buffer)(struct pipe_context *,
 390                                 struct pipe_resource *,
 391                                 unsigned offset,
 392                                 unsigned size);
 393 };
 394
 395
 396 #ifdef __cplusplus
 397 }
 398 #endif
 399
 400 #endif /* PIPE_CONTEXT_H */