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