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