src/gallium/include/pipe/p_context.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 VMware, Inc.
   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 VMWARE 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 #include "p_defines.h"
  35 #include <stdio.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41
  42 struct pipe_blend_color;
  43 struct pipe_blend_state;
  44 struct pipe_blit_info;
  45 struct pipe_box;
  46 struct pipe_clip_state;
  47 struct pipe_constant_buffer;
  48 struct pipe_debug_callback;
  49 struct pipe_depth_stencil_alpha_state;
  50 struct pipe_draw_info;
  51 struct pipe_grid_info;
  52 struct pipe_fence_handle;
  53 struct pipe_framebuffer_state;
  54 struct pipe_image_view;
  55 struct pipe_index_buffer;
  56 struct pipe_query;
  57 struct pipe_poly_stipple;
  58 struct pipe_rasterizer_state;
  59 struct pipe_resolve_info;
  60 struct pipe_resource;
  61 struct pipe_sampler_state;
  62 struct pipe_sampler_view;
  63 struct pipe_scissor_state;
  64 struct pipe_shader_buffer;
  65 struct pipe_shader_state;
  66 struct pipe_stencil_ref;
  67 struct pipe_stream_output_target;
  68 struct pipe_surface;
  69 struct pipe_transfer;
  70 struct pipe_vertex_buffer;
  71 struct pipe_vertex_element;
  72 struct pipe_video_buffer;
  73 struct pipe_video_codec;
  74 struct pipe_viewport_state;
  75 struct pipe_compute_state;
  76 union pipe_color_union;
  77 union pipe_query_result;
  78
  79 /**
  80  * Gallium rendering context.  Basically:
  81  *  - state setting functions
  82  *  - VBO drawing functions
  83  *  - surface functions
  84  */
  85 struct pipe_context {
  86    struct pipe_screen *screen;
  87
  88    void *priv;  /**< context private data (for DRI for example) */
  89    void *draw;  /**< private, for draw module (temporary?) */
  90
  91    void (*destroy)( struct pipe_context * );
  92
  93    /**
  94     * VBO drawing
  95     */
  96    /*@{*/
  97    void (*draw_vbo)( struct pipe_context *pipe,
  98                      const struct pipe_draw_info *info );
  99    /*@}*/
 100
 101    /**
 102     * Predicate subsequent rendering on occlusion query result
 103     * \param query  the query predicate, or NULL if no predicate
 104     * \param condition whether to skip on FALSE or TRUE query results
 105     * \param mode  one of PIPE_RENDER_COND_x
 106     */
 107    void (*render_condition)( struct pipe_context *pipe,
 108                              struct pipe_query *query,
 109                              boolean condition,
 110                              uint mode );
 111
 112    /**
 113     * Query objects
 114     */
 115    /*@{*/
 116    struct pipe_query *(*create_query)( struct pipe_context *pipe,
 117                                        unsigned query_type,
 118                                        unsigned index );
 119
 120    /**
 121     * Create a query object that queries all given query types simultaneously.
 122     *
 123     * This can only be used for those query types for which
 124     * get_driver_query_info indicates that it must be used. Only one batch
 125     * query object may be active at a time.
 126     *
 127     * There may be additional constraints on which query types can be used
 128     * together, in particular those that are implied by
 129     * get_driver_query_group_info.
 130     *
 131     * \param num_queries the number of query types
 132     * \param query_types array of \p num_queries query types
 133     * \return a query object, or NULL on error.
 134     */
 135    struct pipe_query *(*create_batch_query)( struct pipe_context *pipe,
 136                                              unsigned num_queries,
 137                                              unsigned *query_types );
 138
 139    void (*destroy_query)(struct pipe_context *pipe,
 140                          struct pipe_query *q);
 141
 142    boolean (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
 143    bool (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
 144
 145    /**
 146     * Get results of a query.
 147     * \param wait  if true, this query will block until the result is ready
 148     * \return TRUE if results are ready, FALSE otherwise
 149     */
 150    boolean (*get_query_result)(struct pipe_context *pipe,
 151                                struct pipe_query *q,
 152                                boolean wait,
 153                                union pipe_query_result *result);
 154
 155    /**
 156     * Get results of a query, storing into resource. Note that this may not
 157     * be used with batch queries.
 158     *
 159     * \param wait  if true, this query will block until the result is ready
 160     * \param result_type  the type of the value being stored:
 161     * \param index  for queries that return multiple pieces of data, which
 162     *               item of that data to store (e.g. for
 163     *               PIPE_QUERY_PIPELINE_STATISTICS).
 164     *               When the index is -1, instead of the value of the query
 165     *               the driver should instead write a 1 or 0 to the appropriate
 166     *               location with 1 meaning that the query result is available.
 167     */
 168    void (*get_query_result_resource)(struct pipe_context *pipe,
 169                                      struct pipe_query *q,
 170                                      boolean wait,
 171                                      enum pipe_query_value_type result_type,
 172                                      int index,
 173                                      struct pipe_resource *resource,
 174                                      unsigned offset);
 175
 176    /**
 177     * Set whether all current non-driver queries except TIME_ELAPSED are
 178     * active or paused.
 179     */
 180    void (*set_active_query_state)(struct pipe_context *pipe, boolean enable);
 181
 182    /*@}*/
 183
 184    /**
 185     * State functions (create/bind/destroy state objects)
 186     */
 187    /*@{*/
 188    void * (*create_blend_state)(struct pipe_context *,
 189                                 const struct pipe_blend_state *);
 190    void   (*bind_blend_state)(struct pipe_context *, void *);
 191    void   (*delete_blend_state)(struct pipe_context *, void  *);
 192
 193    void * (*create_sampler_state)(struct pipe_context *,
 194                                   const struct pipe_sampler_state *);
 195    void   (*bind_sampler_states)(struct pipe_context *,
 196                                  unsigned shader, unsigned start_slot,
 197                                  unsigned num_samplers, void **samplers);
 198    void   (*delete_sampler_state)(struct pipe_context *, void *);
 199
 200    void * (*create_rasterizer_state)(struct pipe_context *,
 201                                      const struct pipe_rasterizer_state *);
 202    void   (*bind_rasterizer_state)(struct pipe_context *, void *);
 203    void   (*delete_rasterizer_state)(struct pipe_context *, void *);
 204
 205    void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
 206                                         const struct pipe_depth_stencil_alpha_state *);
 207    void   (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
 208    void   (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
 209
 210    void * (*create_fs_state)(struct pipe_context *,
 211                              const struct pipe_shader_state *);
 212    void   (*bind_fs_state)(struct pipe_context *, void *);
 213    void   (*delete_fs_state)(struct pipe_context *, void *);
 214
 215    void * (*create_vs_state)(struct pipe_context *,
 216                              const struct pipe_shader_state *);
 217    void   (*bind_vs_state)(struct pipe_context *, void *);
 218    void   (*delete_vs_state)(struct pipe_context *, void *);
 219
 220    void * (*create_gs_state)(struct pipe_context *,
 221                              const struct pipe_shader_state *);
 222    void   (*bind_gs_state)(struct pipe_context *, void *);
 223    void   (*delete_gs_state)(struct pipe_context *, void *);
 224
 225    void * (*create_tcs_state)(struct pipe_context *,
 226                               const struct pipe_shader_state *);
 227    void   (*bind_tcs_state)(struct pipe_context *, void *);
 228    void   (*delete_tcs_state)(struct pipe_context *, void *);
 229
 230    void * (*create_tes_state)(struct pipe_context *,
 231                               const struct pipe_shader_state *);
 232    void   (*bind_tes_state)(struct pipe_context *, void *);
 233    void   (*delete_tes_state)(struct pipe_context *, void *);
 234
 235    void * (*create_vertex_elements_state)(struct pipe_context *,
 236                                           unsigned num_elements,
 237                                           const struct pipe_vertex_element *);
 238    void   (*bind_vertex_elements_state)(struct pipe_context *, void *);
 239    void   (*delete_vertex_elements_state)(struct pipe_context *, void *);
 240
 241    /*@}*/
 242
 243    /**
 244     * Parameter-like state (or properties)
 245     */
 246    /*@{*/
 247    void (*set_blend_color)( struct pipe_context *,
 248                             const struct pipe_blend_color * );
 249
 250    void (*set_stencil_ref)( struct pipe_context *,
 251                             const struct pipe_stencil_ref * );
 252
 253    void (*set_sample_mask)( struct pipe_context *,
 254                             unsigned sample_mask );
 255
 256    void (*set_min_samples)( struct pipe_context *,
 257                             unsigned min_samples );
 258
 259    void (*set_clip_state)( struct pipe_context *,
 260                             const struct pipe_clip_state * );
 261
 262    void (*set_constant_buffer)( struct pipe_context *,
 263                                 uint shader, uint index,
 264                                 const struct pipe_constant_buffer *buf );
 265
 266    void (*set_framebuffer_state)( struct pipe_context *,
 267                                   const struct pipe_framebuffer_state * );
 268
 269    void (*set_polygon_stipple)( struct pipe_context *,
 270                                 const struct pipe_poly_stipple * );
 271
 272    void (*set_scissor_states)( struct pipe_context *,
 273                                unsigned start_slot,
 274                                unsigned num_scissors,
 275                                const struct pipe_scissor_state * );
 276
 277    void (*set_window_rectangles)( struct pipe_context *,
 278                                   boolean include,
 279                                   unsigned num_rectangles,
 280                                   const struct pipe_scissor_state * );
 281
 282    void (*set_viewport_states)( struct pipe_context *,
 283                                 unsigned start_slot,
 284                                 unsigned num_viewports,
 285                                 const struct pipe_viewport_state *);
 286
 287    void (*set_sampler_views)(struct pipe_context *, unsigned shader,
 288                              unsigned start_slot, unsigned num_views,
 289                              struct pipe_sampler_view **);
 290
 291    void (*set_tess_state)(struct pipe_context *,
 292                           const float default_outer_level[4],
 293                           const float default_inner_level[2]);
 294
 295    /**
 296     * Sets the debug callback. If the pointer is null, then no callback is
 297     * set, otherwise a copy of the data should be made.
 298     */
 299    void (*set_debug_callback)(struct pipe_context *,
 300                               const struct pipe_debug_callback *);
 301
 302    /**
 303     * Bind an array of shader buffers that will be used by a shader.
 304     * Any buffers that were previously bound to the specified range
 305     * will be unbound.
 306     *
 307     * \param shader     selects shader stage
 308     * \param start_slot first buffer slot to bind.
 309     * \param count      number of consecutive buffers to bind.
 310     * \param buffers    array of pointers to the buffers to bind, it
 311     *                   should contain at least \a count elements
 312     *                   unless it's NULL, in which case no buffers will
 313     *                   be bound.
 314     */
 315    void (*set_shader_buffers)(struct pipe_context *, unsigned shader,
 316                               unsigned start_slot, unsigned count,
 317                               const struct pipe_shader_buffer *buffers);
 318
 319    /**
 320     * Bind an array of images that will be used by a shader.
 321     * Any images that were previously bound to the specified range
 322     * will be unbound.
 323     *
 324     * \param shader     selects shader stage
 325     * \param start_slot first image slot to bind.
 326     * \param count      number of consecutive images to bind.
 327     * \param buffers    array of the images to bind, it
 328     *                   should contain at least \a count elements
 329     *                   unless it's NULL, in which case no images will
 330     *                   be bound.
 331     */
 332    void (*set_shader_images)(struct pipe_context *, unsigned shader,
 333                              unsigned start_slot, unsigned count,
 334                              const struct pipe_image_view *images);
 335
 336    void (*set_vertex_buffers)( struct pipe_context *,
 337                                unsigned start_slot,
 338                                unsigned num_buffers,
 339                                const struct pipe_vertex_buffer * );
 340
 341    void (*set_index_buffer)( struct pipe_context *pipe,
 342                              const struct pipe_index_buffer * );
 343
 344    /*@}*/
 345
 346    /**
 347     * Stream output functions.
 348     */
 349    /*@{*/
 350
 351    struct pipe_stream_output_target *(*create_stream_output_target)(
 352                         struct pipe_context *,
 353                         struct pipe_resource *,
 354                         unsigned buffer_offset,
 355                         unsigned buffer_size);
 356
 357    void (*stream_output_target_destroy)(struct pipe_context *,
 358                                         struct pipe_stream_output_target *);
 359
 360    void (*set_stream_output_targets)(struct pipe_context *,
 361                               unsigned num_targets,
 362                               struct pipe_stream_output_target **targets,
 363                               const unsigned *offsets);
 364
 365    /*@}*/
 366
 367
 368    /**
 369     * Resource functions for blit-like functionality
 370     *
 371     * If a driver supports multisampling, blit must implement color resolve.
 372     */
 373    /*@{*/
 374
 375    /**
 376     * Copy a block of pixels from one resource to another.
 377     * The resource must be of the same format.
 378     * Resources with nr_samples > 1 are not allowed.
 379     */
 380    void (*resource_copy_region)(struct pipe_context *pipe,
 381                                 struct pipe_resource *dst,
 382                                 unsigned dst_level,
 383                                 unsigned dstx, unsigned dsty, unsigned dstz,
 384                                 struct pipe_resource *src,
 385                                 unsigned src_level,
 386                                 const struct pipe_box *src_box);
 387
 388    /* Optimal hardware path for blitting pixels.
 389     * Scaling, format conversion, up- and downsampling (resolve) are allowed.
 390     */
 391    void (*blit)(struct pipe_context *pipe,
 392                 const struct pipe_blit_info *info);
 393
 394    /*@}*/
 395
 396    /**
 397     * Clear the specified set of currently bound buffers to specified values.
 398     * The entire buffers are cleared (no scissor, no colormask, etc).
 399     *
 400     * \param buffers  bitfield of PIPE_CLEAR_* values.
 401     * \param color  pointer to a union of fiu array for each of r, g, b, a.
 402     * \param depth  depth clear value in [0,1].
 403     * \param stencil  stencil clear value
 404     */
 405    void (*clear)(struct pipe_context *pipe,
 406                  unsigned buffers,
 407                  const union pipe_color_union *color,
 408                  double depth,
 409                  unsigned stencil);
 410
 411    /**
 412     * Clear a color rendertarget surface.
 413     * \param color  pointer to an union of fiu array for each of r, g, b, a.
 414     */
 415    void (*clear_render_target)(struct pipe_context *pipe,
 416                                struct pipe_surface *dst,
 417                                const union pipe_color_union *color,
 418                                unsigned dstx, unsigned dsty,
 419                                unsigned width, unsigned height);
 420
 421    /**
 422     * Clear a depth-stencil surface.
 423     * \param clear_flags  bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
 424     * \param depth  depth clear value in [0,1].
 425     * \param stencil  stencil clear value
 426     */
 427    void (*clear_depth_stencil)(struct pipe_context *pipe,
 428                                struct pipe_surface *dst,
 429                                unsigned clear_flags,
 430                                double depth,
 431                                unsigned stencil,
 432                                unsigned dstx, unsigned dsty,
 433                                unsigned width, unsigned height);
 434
 435    /**
 436     * Clear the texture with the specified texel. Not guaranteed to be a
 437     * renderable format. Data provided in the resource's format.
 438     */
 439    void (*clear_texture)(struct pipe_context *pipe,
 440                          struct pipe_resource *res,
 441                          unsigned level,
 442                          const struct pipe_box *box,
 443                          const void *data);
 444
 445    /**
 446     * Clear a buffer. Runs a memset over the specified region with the element
 447     * value passed in through clear_value of size clear_value_size.
 448     */
 449    void (*clear_buffer)(struct pipe_context *pipe,
 450                         struct pipe_resource *res,
 451                         unsigned offset,
 452                         unsigned size,
 453                         const void *clear_value,
 454                         int clear_value_size);
 455
 456    /**
 457     * Flush draw commands
 458     *
 459     * NOTE: use screen->fence_reference() (or equivalent) to transfer
 460     * new fence ref to **fence, to ensure that previous fence is unref'd
 461     *
 462     * \param fence  if not NULL, an old fence to unref and transfer a
 463     *    new fence reference to
 464     * \param flags  bitfield of enum pipe_flush_flags values.
 465     */
 466    void (*flush)(struct pipe_context *pipe,
 467                  struct pipe_fence_handle **fence,
 468                  unsigned flags);
 469
 470    /**
 471     * Create a view on a texture to be used by a shader stage.
 472     */
 473    struct pipe_sampler_view * (*create_sampler_view)(struct pipe_context *ctx,
 474                                                      struct pipe_resource *texture,
 475                                                      const struct pipe_sampler_view *templat);
 476
 477    void (*sampler_view_destroy)(struct pipe_context *ctx,
 478                                 struct pipe_sampler_view *view);
 479
 480
 481    /**
 482     * Get a surface which is a "view" into a resource, used by
 483     * render target / depth stencil stages.
 484     */
 485    struct pipe_surface *(*create_surface)(struct pipe_context *ctx,
 486                                           struct pipe_resource *resource,
 487                                           const struct pipe_surface *templat);
 488
 489    void (*surface_destroy)(struct pipe_context *ctx,
 490                            struct pipe_surface *);
 491
 492
 493    /**
 494     * Map a resource.
 495     *
 496     * Transfers are (by default) context-private and allow uploads to be
 497     * interleaved with rendering.
 498     *
 499     * out_transfer will contain the transfer object that must be passed
 500     * to all the other transfer functions. It also contains useful
 501     * information (like texture strides).
 502     */
 503    void *(*transfer_map)(struct pipe_context *,
 504                          struct pipe_resource *resource,
 505                          unsigned level,
 506                          unsigned usage,  /* a combination of PIPE_TRANSFER_x */
 507                          const struct pipe_box *,
 508                          struct pipe_transfer **out_transfer);
 509
 510    /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the
 511     * regions specified with this call are guaranteed to be written to
 512     * the resource.
 513     */
 514    void (*transfer_flush_region)( struct pipe_context *,
 515                                   struct pipe_transfer *transfer,
 516                                   const struct pipe_box *);
 517
 518    void (*transfer_unmap)(struct pipe_context *,
 519                           struct pipe_transfer *transfer);
 520
 521    /* One-shot transfer operation with data supplied in a user
 522     * pointer.
 523     */
 524    void (*buffer_subdata)(struct pipe_context *,
 525                           struct pipe_resource *,
 526                           unsigned usage, /* a combination of PIPE_TRANSFER_x */
 527                           unsigned offset,
 528                           unsigned size,
 529                           const void *data);
 530
 531    void (*texture_subdata)(struct pipe_context *,
 532                            struct pipe_resource *,
 533                            unsigned level,
 534                            unsigned usage, /* a combination of PIPE_TRANSFER_x */
 535                            const struct pipe_box *,
 536                            const void *data,
 537                            unsigned stride,
 538                            unsigned layer_stride);
 539
 540    /**
 541     * Flush any pending framebuffer writes and invalidate texture caches.
 542     */
 543    void (*texture_barrier)(struct pipe_context *);
 544
 545    /**
 546     * Flush caches according to flags.
 547     */
 548    void (*memory_barrier)(struct pipe_context *, unsigned flags);
 549
 550    /**
 551     * Creates a video codec for a specific video format/profile
 552     */
 553    struct pipe_video_codec *(*create_video_codec)( struct pipe_context *context,
 554                                                    const struct pipe_video_codec *templat );
 555
 556    /**
 557     * Creates a video buffer as decoding target
 558     */
 559    struct pipe_video_buffer *(*create_video_buffer)( struct pipe_context *context,
 560                                                      const struct pipe_video_buffer *templat );
 561
 562    /**
 563     * Compute kernel execution
 564     */
 565    /*@{*/
 566    /**
 567     * Define the compute program and parameters to be used by
 568     * pipe_context::launch_grid.
 569     */
 570    void *(*create_compute_state)(struct pipe_context *context,
 571                                  const struct pipe_compute_state *);
 572    void (*bind_compute_state)(struct pipe_context *, void *);
 573    void (*delete_compute_state)(struct pipe_context *, void *);
 574
 575    /**
 576     * Bind an array of shader resources that will be used by the
 577     * compute program.  Any resources that were previously bound to
 578     * the specified range will be unbound after this call.
 579     *
 580     * \param start      first resource to bind.
 581     * \param count      number of consecutive resources to bind.
 582     * \param resources  array of pointers to the resources to bind, it
 583     *                   should contain at least \a count elements
 584     *                   unless it's NULL, in which case no new
 585     *                   resources will be bound.
 586     */
 587    void (*set_compute_resources)(struct pipe_context *,
 588                                  unsigned start, unsigned count,
 589                                  struct pipe_surface **resources);
 590
 591    /**
 592     * Bind an array of buffers to be mapped into the address space of
 593     * the GLOBAL resource.  Any buffers that were previously bound
 594     * between [first, first + count - 1] are unbound after this call.
 595     *
 596     * \param first      first buffer to map.
 597     * \param count      number of consecutive buffers to map.
 598     * \param resources  array of pointers to the buffers to map, it
 599     *                   should contain at least \a count elements
 600     *                   unless it's NULL, in which case no new
 601     *                   resources will be bound.
 602     * \param handles    array of pointers to the memory locations that
 603     *                   will be updated with the address each buffer
 604     *                   will be mapped to.  The base memory address of
 605     *                   each of the buffers will be added to the value
 606     *                   pointed to by its corresponding handle to form
 607     *                   the final address argument.  It should contain
 608     *                   at least \a count elements, unless \a
 609     *                   resources is NULL in which case \a handles
 610     *                   should be NULL as well.
 611     *
 612     * Note that the driver isn't required to make any guarantees about
 613     * the contents of the \a handles array being valid anytime except
 614     * during the subsequent calls to pipe_context::launch_grid.  This
 615     * means that the only sensible location handles[i] may point to is
 616     * somewhere within the INPUT buffer itself.  This is so to
 617     * accommodate implementations that lack virtual memory but
 618     * nevertheless migrate buffers on the fly, leading to resource
 619     * base addresses that change on each kernel invocation or are
 620     * unknown to the pipe driver.
 621     */
 622    void (*set_global_binding)(struct pipe_context *context,
 623                               unsigned first, unsigned count,
 624                               struct pipe_resource **resources,
 625                               uint32_t **handles);
 626
 627    /**
 628     * Launch the compute kernel starting from instruction \a pc of the
 629     * currently bound compute program.
 630     */
 631    void (*launch_grid)(struct pipe_context *context,
 632                        const struct pipe_grid_info *info);
 633    /*@}*/
 634
 635    /**
 636     * Get sample position for an individual sample point.
 637     *
 638     * \param sample_count - total number of samples
 639     * \param sample_index - sample to get the position values for
 640     * \param out_value - return value of 2 floats for x and y position for
 641     *                    requested sample.
 642     */
 643    void (*get_sample_position)(struct pipe_context *context,
 644                                unsigned sample_count,
 645                                unsigned sample_index,
 646                                float *out_value);
 647
 648    /**
 649     * Query a timestamp in nanoseconds.  This is completely equivalent to
 650     * pipe_screen::get_timestamp() but takes a context handle for drivers
 651     * that require a context.
 652     */
 653    uint64_t (*get_timestamp)(struct pipe_context *);
 654
 655    /**
 656     * Flush the resource cache, so that the resource can be used
 657     * by an external client. Possible usage:
 658     * - flushing a resource before presenting it on the screen
 659     * - flushing a resource if some other process or device wants to use it
 660     * This shouldn't be used to flush caches if the resource is only managed
 661     * by a single pipe_screen and is not shared with another process.
 662     * (i.e. you shouldn't use it to flush caches explicitly if you want to e.g.
 663     * use the resource for texturing)
 664     */
 665    void (*flush_resource)(struct pipe_context *ctx,
 666                           struct pipe_resource *resource);
 667
 668    /**
 669     * Invalidate the contents of the resource. This is used to
 670     *
 671     * (1) implement EGL's semantic of undefined depth/stencil
 672     * contenst after a swapbuffers.  This allows a tiled renderer (for
 673     * example) to not store the depth buffer.
 674     *
 675     * (2) implement GL's InvalidateBufferData. For backwards compatibility,
 676     * you must only rely on the usability for this purpose when
 677     * PIPE_CAP_INVALIDATE_BUFFER is enabled.
 678     */
 679    void (*invalidate_resource)(struct pipe_context *ctx,
 680                                struct pipe_resource *resource);
 681
 682    /**
 683     * Return information about unexpected device resets.
 684     */
 685    enum pipe_reset_status (*get_device_reset_status)(struct pipe_context *ctx);
 686
 687    /**
 688     * Dump driver-specific debug information into a stream. This is
 689     * used by debugging tools.
 690     *
 691     * \param ctx        pipe context
 692     * \param stream     where the output should be written to
 693     * \param flags      a mask of PIPE_DEBUG_* flags
 694     */
 695    void (*dump_debug_state)(struct pipe_context *ctx, FILE *stream,
 696                             unsigned flags);
 697
 698    /**
 699     * Emit string marker in cmdstream
 700     */
 701    void (*emit_string_marker)(struct pipe_context *ctx,
 702                               const char *string,
 703                               int len);
 704
 705    /**
 706     * Generate mipmap.
 707     * \return TRUE if mipmap generation succeeds, FALSE otherwise
 708     */
 709    boolean (*generate_mipmap)(struct pipe_context *ctx,
 710                               struct pipe_resource *resource,
 711                               enum pipe_format format,
 712                               unsigned base_level,
 713                               unsigned last_level,
 714                               unsigned first_layer,
 715                               unsigned last_layer);
 716 };
 717
 718
 719 #ifdef __cplusplus
 720 }
 721 #endif
 722
 723 #endif /* PIPE_CONTEXT_H */