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