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