1 /**************************************************************************
3 * Copyright 2007 VMware, Inc.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
28 #ifndef PIPE_CONTEXT_H
29 #define PIPE_CONTEXT_H
31 #include "p_compiler.h"
33 #include "p_video_enums.h"
34 #include "p_defines.h"
42 struct pipe_blend_color
;
43 struct pipe_blend_state
;
44 struct pipe_blit_info
;
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_device_reset_callback
;
51 struct pipe_draw_info
;
52 struct pipe_grid_info
;
53 struct pipe_fence_handle
;
54 struct pipe_framebuffer_state
;
55 struct pipe_image_view
;
57 struct pipe_poly_stipple
;
58 struct pipe_rasterizer_state
;
59 struct pipe_resolve_info
;
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
;
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
;
82 * Gallium rendering context. Basically:
83 * - state setting functions
84 * - VBO drawing functions
88 struct pipe_screen
*screen
;
90 void *priv
; /**< context private data (for DRI for example) */
91 void *draw
; /**< private, for draw module (temporary?) */
94 * Stream uploaders created by the driver. All drivers, state trackers, and
95 * modules should use them.
97 * Use u_upload_alloc or u_upload_data as many times as you want.
98 * Once you are done, use u_upload_unmap.
100 struct u_upload_mgr
*stream_uploader
; /* everything but shader constants */
101 struct u_upload_mgr
*const_uploader
; /* shader constants only */
103 void (*destroy
)( struct pipe_context
* );
109 void (*draw_vbo
)( struct pipe_context
*pipe
,
110 const struct pipe_draw_info
*info
);
114 * Predicate subsequent rendering on occlusion query result
115 * \param query the query predicate, or NULL if no predicate
116 * \param condition whether to skip on FALSE or TRUE query results
117 * \param mode one of PIPE_RENDER_COND_x
119 void (*render_condition
)( struct pipe_context
*pipe
,
120 struct pipe_query
*query
,
122 enum pipe_render_cond_flag mode
);
128 struct pipe_query
*(*create_query
)( struct pipe_context
*pipe
,
133 * Create a query object that queries all given query types simultaneously.
135 * This can only be used for those query types for which
136 * get_driver_query_info indicates that it must be used. Only one batch
137 * query object may be active at a time.
139 * There may be additional constraints on which query types can be used
140 * together, in particular those that are implied by
141 * get_driver_query_group_info.
143 * \param num_queries the number of query types
144 * \param query_types array of \p num_queries query types
145 * \return a query object, or NULL on error.
147 struct pipe_query
*(*create_batch_query
)( struct pipe_context
*pipe
,
148 unsigned num_queries
,
149 unsigned *query_types
);
151 void (*destroy_query
)(struct pipe_context
*pipe
,
152 struct pipe_query
*q
);
154 bool (*begin_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
155 bool (*end_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
158 * Get results of a query.
159 * \param wait if true, this query will block until the result is ready
160 * \return TRUE if results are ready, FALSE otherwise
162 bool (*get_query_result
)(struct pipe_context
*pipe
,
163 struct pipe_query
*q
,
165 union pipe_query_result
*result
);
168 * Get results of a query, storing into resource. Note that this may not
169 * be used with batch queries.
171 * \param wait if true, this query will block until the result is ready
172 * \param result_type the type of the value being stored:
173 * \param index for queries that return multiple pieces of data, which
174 * item of that data to store (e.g. for
175 * PIPE_QUERY_PIPELINE_STATISTICS).
176 * When the index is -1, instead of the value of the query
177 * the driver should instead write a 1 or 0 to the appropriate
178 * location with 1 meaning that the query result is available.
180 void (*get_query_result_resource
)(struct pipe_context
*pipe
,
181 struct pipe_query
*q
,
183 enum pipe_query_value_type result_type
,
185 struct pipe_resource
*resource
,
189 * Set whether all current non-driver queries except TIME_ELAPSED are
192 void (*set_active_query_state
)(struct pipe_context
*pipe
, bool enable
);
197 * State functions (create/bind/destroy state objects)
200 void * (*create_blend_state
)(struct pipe_context
*,
201 const struct pipe_blend_state
*);
202 void (*bind_blend_state
)(struct pipe_context
*, void *);
203 void (*delete_blend_state
)(struct pipe_context
*, void *);
205 void * (*create_sampler_state
)(struct pipe_context
*,
206 const struct pipe_sampler_state
*);
207 void (*bind_sampler_states
)(struct pipe_context
*,
208 enum pipe_shader_type shader
,
209 unsigned start_slot
, unsigned num_samplers
,
211 void (*delete_sampler_state
)(struct pipe_context
*, void *);
213 void * (*create_rasterizer_state
)(struct pipe_context
*,
214 const struct pipe_rasterizer_state
*);
215 void (*bind_rasterizer_state
)(struct pipe_context
*, void *);
216 void (*delete_rasterizer_state
)(struct pipe_context
*, void *);
218 void * (*create_depth_stencil_alpha_state
)(struct pipe_context
*,
219 const struct pipe_depth_stencil_alpha_state
*);
220 void (*bind_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
221 void (*delete_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
223 void * (*create_fs_state
)(struct pipe_context
*,
224 const struct pipe_shader_state
*);
225 void (*bind_fs_state
)(struct pipe_context
*, void *);
226 void (*delete_fs_state
)(struct pipe_context
*, void *);
228 void * (*create_vs_state
)(struct pipe_context
*,
229 const struct pipe_shader_state
*);
230 void (*bind_vs_state
)(struct pipe_context
*, void *);
231 void (*delete_vs_state
)(struct pipe_context
*, void *);
233 void * (*create_gs_state
)(struct pipe_context
*,
234 const struct pipe_shader_state
*);
235 void (*bind_gs_state
)(struct pipe_context
*, void *);
236 void (*delete_gs_state
)(struct pipe_context
*, void *);
238 void * (*create_tcs_state
)(struct pipe_context
*,
239 const struct pipe_shader_state
*);
240 void (*bind_tcs_state
)(struct pipe_context
*, void *);
241 void (*delete_tcs_state
)(struct pipe_context
*, void *);
243 void * (*create_tes_state
)(struct pipe_context
*,
244 const struct pipe_shader_state
*);
245 void (*bind_tes_state
)(struct pipe_context
*, void *);
246 void (*delete_tes_state
)(struct pipe_context
*, void *);
248 void * (*create_vertex_elements_state
)(struct pipe_context
*,
249 unsigned num_elements
,
250 const struct pipe_vertex_element
*);
251 void (*bind_vertex_elements_state
)(struct pipe_context
*, void *);
252 void (*delete_vertex_elements_state
)(struct pipe_context
*, void *);
257 * Parameter-like state (or properties)
260 void (*set_blend_color
)( struct pipe_context
*,
261 const struct pipe_blend_color
* );
263 void (*set_stencil_ref
)( struct pipe_context
*,
264 const struct pipe_stencil_ref
* );
266 void (*set_sample_mask
)( struct pipe_context
*,
267 unsigned sample_mask
);
269 void (*set_min_samples
)( struct pipe_context
*,
270 unsigned min_samples
);
272 void (*set_clip_state
)( struct pipe_context
*,
273 const struct pipe_clip_state
* );
275 void (*set_constant_buffer
)( struct pipe_context
*,
276 enum pipe_shader_type shader
, uint index
,
277 const struct pipe_constant_buffer
*buf
);
279 void (*set_framebuffer_state
)( struct pipe_context
*,
280 const struct pipe_framebuffer_state
* );
283 * Set the sample locations used during rasterization. When NULL or sized
284 * zero, the default locations are used.
286 * Note that get_sample_position() still returns the default locations.
288 * The samples are accessed with
289 * locations[(pixel_y*grid_w+pixel_x)*ms+i],
291 * ms = the sample count
292 * grid_w = the pixel grid width for the sample count
293 * grid_w = the pixel grid height for the sample count
294 * pixel_x = the window x coordinate modulo grid_w
295 * pixel_y = the window y coordinate modulo grid_w
296 * i = the sample index
297 * This gives a result with the x coordinate as the low 4 bits and the y
298 * coordinate as the high 4 bits. For each coordinate 0 is the left or top
299 * edge of the pixel's rectangle and 16 (not 15) is the right or bottom edge.
301 * Out of bounds accesses are return undefined values.
303 * The pixel grid is used to vary sample locations across pixels and its
304 * size can be queried with get_sample_pixel_grid().
306 void (*set_sample_locations
)( struct pipe_context
*,
307 size_t size
, const uint8_t *locations
);
309 void (*set_polygon_stipple
)( struct pipe_context
*,
310 const struct pipe_poly_stipple
* );
312 void (*set_scissor_states
)( struct pipe_context
*,
314 unsigned num_scissors
,
315 const struct pipe_scissor_state
* );
317 void (*set_window_rectangles
)( struct pipe_context
*,
319 unsigned num_rectangles
,
320 const struct pipe_scissor_state
* );
322 void (*set_viewport_states
)( struct pipe_context
*,
324 unsigned num_viewports
,
325 const struct pipe_viewport_state
*);
327 void (*set_sampler_views
)(struct pipe_context
*,
328 enum pipe_shader_type shader
,
329 unsigned start_slot
, unsigned num_views
,
330 struct pipe_sampler_view
**views
);
332 void (*set_tess_state
)(struct pipe_context
*,
333 const float default_outer_level
[4],
334 const float default_inner_level
[2]);
337 * Sets the debug callback. If the pointer is null, then no callback is
338 * set, otherwise a copy of the data should be made.
340 void (*set_debug_callback
)(struct pipe_context
*,
341 const struct pipe_debug_callback
*);
344 * Bind an array of shader buffers that will be used by a shader.
345 * Any buffers that were previously bound to the specified range
348 * \param shader selects shader stage
349 * \param start_slot first buffer slot to bind.
350 * \param count number of consecutive buffers to bind.
351 * \param buffers array of pointers to the buffers to bind, it
352 * should contain at least \a count elements
353 * unless it's NULL, in which case no buffers will
355 * \param writable_bitmask If bit i is not set, buffers[i] will only be
356 * used with loads. If unsure, set to ~0.
358 void (*set_shader_buffers
)(struct pipe_context
*,
359 enum pipe_shader_type shader
,
360 unsigned start_slot
, unsigned count
,
361 const struct pipe_shader_buffer
*buffers
,
362 unsigned writable_bitmask
);
365 * Bind an array of hw atomic buffers for use by all shaders.
366 * And buffers that were previously bound to the specified range
369 * \param start_slot first buffer slot to bind.
370 * \param count number of consecutive buffers to bind.
371 * \param buffers array of pointers to the buffers to bind, it
372 * should contain at least \a count elements
373 * unless it's NULL, in which case no buffers will
376 void (*set_hw_atomic_buffers
)(struct pipe_context
*,
377 unsigned start_slot
, unsigned count
,
378 const struct pipe_shader_buffer
*buffers
);
381 * Bind an array of images that will be used by a shader.
382 * Any images that were previously bound to the specified range
385 * \param shader selects shader stage
386 * \param start_slot first image slot to bind.
387 * \param count number of consecutive images to bind.
388 * \param buffers array of the images to bind, it
389 * should contain at least \a count elements
390 * unless it's NULL, in which case no images will
393 void (*set_shader_images
)(struct pipe_context
*,
394 enum pipe_shader_type shader
,
395 unsigned start_slot
, unsigned count
,
396 const struct pipe_image_view
*images
);
398 void (*set_vertex_buffers
)( struct pipe_context
*,
400 unsigned num_buffers
,
401 const struct pipe_vertex_buffer
* );
406 * Stream output functions.
410 struct pipe_stream_output_target
*(*create_stream_output_target
)(
411 struct pipe_context
*,
412 struct pipe_resource
*,
413 unsigned buffer_offset
,
414 unsigned buffer_size
);
416 void (*stream_output_target_destroy
)(struct pipe_context
*,
417 struct pipe_stream_output_target
*);
419 void (*set_stream_output_targets
)(struct pipe_context
*,
420 unsigned num_targets
,
421 struct pipe_stream_output_target
**targets
,
422 const unsigned *offsets
);
428 * Resource functions for blit-like functionality
430 * If a driver supports multisampling, blit must implement color resolve.
435 * Copy a block of pixels from one resource to another.
436 * The resource must be of the same format.
437 * Resources with nr_samples > 1 are not allowed.
439 void (*resource_copy_region
)(struct pipe_context
*pipe
,
440 struct pipe_resource
*dst
,
442 unsigned dstx
, unsigned dsty
, unsigned dstz
,
443 struct pipe_resource
*src
,
445 const struct pipe_box
*src_box
);
447 /* Optimal hardware path for blitting pixels.
448 * Scaling, format conversion, up- and downsampling (resolve) are allowed.
450 void (*blit
)(struct pipe_context
*pipe
,
451 const struct pipe_blit_info
*info
);
456 * Clear the specified set of currently bound buffers to specified values.
457 * The entire buffers are cleared (no scissor, no colormask, etc).
459 * \param buffers bitfield of PIPE_CLEAR_* values.
460 * \param color pointer to a union of fiu array for each of r, g, b, a.
461 * \param depth depth clear value in [0,1].
462 * \param stencil stencil clear value
464 void (*clear
)(struct pipe_context
*pipe
,
466 const union pipe_color_union
*color
,
471 * Clear a color rendertarget surface.
472 * \param color pointer to an union of fiu array for each of r, g, b, a.
474 void (*clear_render_target
)(struct pipe_context
*pipe
,
475 struct pipe_surface
*dst
,
476 const union pipe_color_union
*color
,
477 unsigned dstx
, unsigned dsty
,
478 unsigned width
, unsigned height
,
479 bool render_condition_enabled
);
482 * Clear a depth-stencil surface.
483 * \param clear_flags bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
484 * \param depth depth clear value in [0,1].
485 * \param stencil stencil clear value
487 void (*clear_depth_stencil
)(struct pipe_context
*pipe
,
488 struct pipe_surface
*dst
,
489 unsigned clear_flags
,
492 unsigned dstx
, unsigned dsty
,
493 unsigned width
, unsigned height
,
494 bool render_condition_enabled
);
497 * Clear the texture with the specified texel. Not guaranteed to be a
498 * renderable format. Data provided in the resource's format.
500 void (*clear_texture
)(struct pipe_context
*pipe
,
501 struct pipe_resource
*res
,
503 const struct pipe_box
*box
,
507 * Clear a buffer. Runs a memset over the specified region with the element
508 * value passed in through clear_value of size clear_value_size.
510 void (*clear_buffer
)(struct pipe_context
*pipe
,
511 struct pipe_resource
*res
,
514 const void *clear_value
,
515 int clear_value_size
);
518 * If a depth buffer is rendered with different sample location state than
519 * what is current at the time of reading, the values may differ because
520 * depth buffer compression can depend the sample locations.
522 * This function is a hint to decompress the current depth buffer to avoid
525 void (*evaluate_depth_buffer
)(struct pipe_context
*pipe
);
528 * Flush draw commands.
530 * This guarantees that the new fence (if any) will finish in finite time,
531 * unless PIPE_FLUSH_DEFERRED is used.
533 * Subsequent operations on other contexts of the same screen are guaranteed
534 * to execute after the flushed commands, unless PIPE_FLUSH_ASYNC is used.
536 * NOTE: use screen->fence_reference() (or equivalent) to transfer
537 * new fence ref to **fence, to ensure that previous fence is unref'd
539 * \param fence if not NULL, an old fence to unref and transfer a
540 * new fence reference to
541 * \param flags bitfield of enum pipe_flush_flags values.
543 void (*flush
)(struct pipe_context
*pipe
,
544 struct pipe_fence_handle
**fence
,
548 * Create a fence from a fd.
550 * This is used for importing a foreign/external fence fd.
552 * \param fence if not NULL, an old fence to unref and transfer a
553 * new fence reference to
554 * \param fd fd representing the fence object
555 * \param type indicates which fence types backs fd
557 void (*create_fence_fd
)(struct pipe_context
*pipe
,
558 struct pipe_fence_handle
**fence
,
560 enum pipe_fd_type type
);
563 * Insert commands to have GPU wait for fence to be signaled.
565 void (*fence_server_sync
)(struct pipe_context
*pipe
,
566 struct pipe_fence_handle
*fence
);
569 * Insert commands to have the GPU signal a fence.
571 void (*fence_server_signal
)(struct pipe_context
*pipe
,
572 struct pipe_fence_handle
*fence
);
575 * Create a view on a texture to be used by a shader stage.
577 struct pipe_sampler_view
* (*create_sampler_view
)(struct pipe_context
*ctx
,
578 struct pipe_resource
*texture
,
579 const struct pipe_sampler_view
*templat
);
582 * Destroy a view on a texture.
584 * \param ctx the current context
585 * \param view the view to be destroyed
587 * \note The current context may not be the context in which the view was
588 * created (view->context). However, the caller must guarantee that
589 * the context which created the view is still alive.
591 void (*sampler_view_destroy
)(struct pipe_context
*ctx
,
592 struct pipe_sampler_view
*view
);
596 * Get a surface which is a "view" into a resource, used by
597 * render target / depth stencil stages.
599 struct pipe_surface
*(*create_surface
)(struct pipe_context
*ctx
,
600 struct pipe_resource
*resource
,
601 const struct pipe_surface
*templat
);
603 void (*surface_destroy
)(struct pipe_context
*ctx
,
604 struct pipe_surface
*);
610 * Transfers are (by default) context-private and allow uploads to be
611 * interleaved with rendering.
613 * out_transfer will contain the transfer object that must be passed
614 * to all the other transfer functions. It also contains useful
615 * information (like texture strides).
617 void *(*transfer_map
)(struct pipe_context
*,
618 struct pipe_resource
*resource
,
620 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
621 const struct pipe_box
*,
622 struct pipe_transfer
**out_transfer
);
624 /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the
625 * regions specified with this call are guaranteed to be written to
628 void (*transfer_flush_region
)( struct pipe_context
*,
629 struct pipe_transfer
*transfer
,
630 const struct pipe_box
*);
632 void (*transfer_unmap
)(struct pipe_context
*,
633 struct pipe_transfer
*transfer
);
635 /* One-shot transfer operation with data supplied in a user
638 void (*buffer_subdata
)(struct pipe_context
*,
639 struct pipe_resource
*,
640 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
645 void (*texture_subdata
)(struct pipe_context
*,
646 struct pipe_resource
*,
648 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
649 const struct pipe_box
*,
652 unsigned layer_stride
);
655 * Flush any pending framebuffer writes and invalidate texture caches.
657 void (*texture_barrier
)(struct pipe_context
*, unsigned flags
);
660 * Flush caches according to flags.
662 void (*memory_barrier
)(struct pipe_context
*, unsigned flags
);
665 * Change the commitment status of a part of the given resource, which must
666 * have been created with the PIPE_RESOURCE_FLAG_SPARSE bit.
668 * \param level The texture level whose commitment should be changed.
669 * \param box The region of the resource whose commitment should be changed.
670 * \param commit Whether memory should be committed or un-committed.
672 * \return false if out of memory, true on success.
674 bool (*resource_commit
)(struct pipe_context
*, struct pipe_resource
*,
675 unsigned level
, struct pipe_box
*box
, bool commit
);
678 * Creates a video codec for a specific video format/profile
680 struct pipe_video_codec
*(*create_video_codec
)( struct pipe_context
*context
,
681 const struct pipe_video_codec
*templat
);
684 * Creates a video buffer as decoding target
686 struct pipe_video_buffer
*(*create_video_buffer
)( struct pipe_context
*context
,
687 const struct pipe_video_buffer
*templat
);
690 * Compute kernel execution
694 * Define the compute program and parameters to be used by
695 * pipe_context::launch_grid.
697 void *(*create_compute_state
)(struct pipe_context
*context
,
698 const struct pipe_compute_state
*);
699 void (*bind_compute_state
)(struct pipe_context
*, void *);
700 void (*delete_compute_state
)(struct pipe_context
*, void *);
703 * Bind an array of shader resources that will be used by the
704 * compute program. Any resources that were previously bound to
705 * the specified range will be unbound after this call.
707 * \param start first resource to bind.
708 * \param count number of consecutive resources to bind.
709 * \param resources array of pointers to the resources to bind, it
710 * should contain at least \a count elements
711 * unless it's NULL, in which case no new
712 * resources will be bound.
714 void (*set_compute_resources
)(struct pipe_context
*,
715 unsigned start
, unsigned count
,
716 struct pipe_surface
**resources
);
719 * Bind an array of buffers to be mapped into the address space of
720 * the GLOBAL resource. Any buffers that were previously bound
721 * between [first, first + count - 1] are unbound after this call.
723 * \param first first buffer to map.
724 * \param count number of consecutive buffers to map.
725 * \param resources array of pointers to the buffers to map, it
726 * should contain at least \a count elements
727 * unless it's NULL, in which case no new
728 * resources will be bound.
729 * \param handles array of pointers to the memory locations that
730 * will be updated with the address each buffer
731 * will be mapped to. The base memory address of
732 * each of the buffers will be added to the value
733 * pointed to by its corresponding handle to form
734 * the final address argument. It should contain
735 * at least \a count elements, unless \a
736 * resources is NULL in which case \a handles
737 * should be NULL as well.
739 * Note that the driver isn't required to make any guarantees about
740 * the contents of the \a handles array being valid anytime except
741 * during the subsequent calls to pipe_context::launch_grid. This
742 * means that the only sensible location handles[i] may point to is
743 * somewhere within the INPUT buffer itself. This is so to
744 * accommodate implementations that lack virtual memory but
745 * nevertheless migrate buffers on the fly, leading to resource
746 * base addresses that change on each kernel invocation or are
747 * unknown to the pipe driver.
749 void (*set_global_binding
)(struct pipe_context
*context
,
750 unsigned first
, unsigned count
,
751 struct pipe_resource
**resources
,
755 * Launch the compute kernel starting from instruction \a pc of the
756 * currently bound compute program.
758 void (*launch_grid
)(struct pipe_context
*context
,
759 const struct pipe_grid_info
*info
);
763 * Get the default sample position for an individual sample point.
765 * \param sample_count - total number of samples
766 * \param sample_index - sample to get the position values for
767 * \param out_value - return value of 2 floats for x and y position for
770 void (*get_sample_position
)(struct pipe_context
*context
,
771 unsigned sample_count
,
772 unsigned sample_index
,
776 * Query a timestamp in nanoseconds. This is completely equivalent to
777 * pipe_screen::get_timestamp() but takes a context handle for drivers
778 * that require a context.
780 uint64_t (*get_timestamp
)(struct pipe_context
*);
783 * Flush the resource cache, so that the resource can be used
784 * by an external client. Possible usage:
785 * - flushing a resource before presenting it on the screen
786 * - flushing a resource if some other process or device wants to use it
787 * This shouldn't be used to flush caches if the resource is only managed
788 * by a single pipe_screen and is not shared with another process.
789 * (i.e. you shouldn't use it to flush caches explicitly if you want to e.g.
790 * use the resource for texturing)
792 void (*flush_resource
)(struct pipe_context
*ctx
,
793 struct pipe_resource
*resource
);
796 * Invalidate the contents of the resource. This is used to
798 * (1) implement EGL's semantic of undefined depth/stencil
799 * contents after a swapbuffers. This allows a tiled renderer (for
800 * example) to not store the depth buffer.
802 * (2) implement GL's InvalidateBufferData. For backwards compatibility,
803 * you must only rely on the usability for this purpose when
804 * PIPE_CAP_INVALIDATE_BUFFER is enabled.
806 void (*invalidate_resource
)(struct pipe_context
*ctx
,
807 struct pipe_resource
*resource
);
810 * Return information about unexpected device resets.
812 enum pipe_reset_status (*get_device_reset_status
)(struct pipe_context
*ctx
);
815 * Sets the reset status callback. If the pointer is null, then no callback
816 * is set, otherwise a copy of the data should be made.
818 void (*set_device_reset_callback
)(struct pipe_context
*ctx
,
819 const struct pipe_device_reset_callback
*cb
);
822 * Dump driver-specific debug information into a stream. This is
823 * used by debugging tools.
825 * \param ctx pipe context
826 * \param stream where the output should be written to
827 * \param flags a mask of PIPE_DUMP_* flags
829 void (*dump_debug_state
)(struct pipe_context
*ctx
, FILE *stream
,
833 * Set the log context to which the driver should write internal debug logs
834 * (internal states, command streams).
836 * The caller must ensure that the log context is destroyed and reset to
837 * NULL before the pipe context is destroyed, and that log context functions
838 * are only called from the driver thread.
840 * \param ctx pipe context
841 * \param log logging context
843 void (*set_log_context
)(struct pipe_context
*ctx
, struct u_log_context
*log
);
846 * Emit string marker in cmdstream
848 void (*emit_string_marker
)(struct pipe_context
*ctx
,
854 * \return TRUE if mipmap generation succeeds, FALSE otherwise
856 bool (*generate_mipmap
)(struct pipe_context
*ctx
,
857 struct pipe_resource
*resource
,
858 enum pipe_format format
,
861 unsigned first_layer
,
862 unsigned last_layer
);
865 * Create a 64-bit texture handle.
867 * \param ctx pipe context
868 * \param view pipe sampler view object
869 * \param state pipe sampler state template
870 * \return a 64-bit texture handle if success, 0 otherwise
872 uint64_t (*create_texture_handle
)(struct pipe_context
*ctx
,
873 struct pipe_sampler_view
*view
,
874 const struct pipe_sampler_state
*state
);
877 * Delete a texture handle.
879 * \param ctx pipe context
880 * \param handle 64-bit texture handle
882 void (*delete_texture_handle
)(struct pipe_context
*ctx
, uint64_t handle
);
885 * Make a texture handle resident.
887 * \param ctx pipe context
888 * \param handle 64-bit texture handle
889 * \param resident TRUE for resident, FALSE otherwise
891 void (*make_texture_handle_resident
)(struct pipe_context
*ctx
,
892 uint64_t handle
, bool resident
);
895 * Create a 64-bit image handle.
897 * \param ctx pipe context
898 * \param image pipe image view template
899 * \return a 64-bit image handle if success, 0 otherwise
901 uint64_t (*create_image_handle
)(struct pipe_context
*ctx
,
902 const struct pipe_image_view
*image
);
905 * Delete an image handle.
907 * \param ctx pipe context
908 * \param handle 64-bit image handle
910 void (*delete_image_handle
)(struct pipe_context
*ctx
, uint64_t handle
);
913 * Make an image handle resident.
915 * \param ctx pipe context
916 * \param handle 64-bit image handle
917 * \param access GL_READ_ONLY, GL_WRITE_ONLY or GL_READ_WRITE
918 * \param resident TRUE for resident, FALSE otherwise
920 void (*make_image_handle_resident
)(struct pipe_context
*ctx
, uint64_t handle
,
921 unsigned access
, bool resident
);
924 * Call the given function from the driver thread.
926 * This is set by threaded contexts for use by debugging wrappers.
928 * \param asap if true, run the callback immediately if there are no pending
929 * commands to be processed by the driver thread
931 void (*callback
)(struct pipe_context
*ctx
, void (*fn
)(void *), void *data
,
935 * Set a context parameter See enum pipe_context_param for more details.
937 void (*set_context_param
)(struct pipe_context
*ctx
,
938 enum pipe_context_param param
,
947 #endif /* PIPE_CONTEXT_H */