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
;
56 struct pipe_index_buffer
;
58 struct pipe_poly_stipple
;
59 struct pipe_rasterizer_state
;
60 struct pipe_resolve_info
;
62 struct pipe_sampler_state
;
63 struct pipe_sampler_view
;
64 struct pipe_scissor_state
;
65 struct pipe_shader_buffer
;
66 struct pipe_shader_state
;
67 struct pipe_stencil_ref
;
68 struct pipe_stream_output_target
;
71 struct pipe_vertex_buffer
;
72 struct pipe_vertex_element
;
73 struct pipe_video_buffer
;
74 struct pipe_video_codec
;
75 struct pipe_viewport_state
;
76 struct pipe_compute_state
;
77 union pipe_color_union
;
78 union pipe_query_result
;
81 * Gallium rendering context. Basically:
82 * - state setting functions
83 * - VBO drawing functions
87 struct pipe_screen
*screen
;
89 void *priv
; /**< context private data (for DRI for example) */
90 void *draw
; /**< private, for draw module (temporary?) */
92 void (*destroy
)( struct pipe_context
* );
98 void (*draw_vbo
)( struct pipe_context
*pipe
,
99 const struct pipe_draw_info
*info
);
103 * Predicate subsequent rendering on occlusion query result
104 * \param query the query predicate, or NULL if no predicate
105 * \param condition whether to skip on FALSE or TRUE query results
106 * \param mode one of PIPE_RENDER_COND_x
108 void (*render_condition
)( struct pipe_context
*pipe
,
109 struct pipe_query
*query
,
117 struct pipe_query
*(*create_query
)( struct pipe_context
*pipe
,
122 * Create a query object that queries all given query types simultaneously.
124 * This can only be used for those query types for which
125 * get_driver_query_info indicates that it must be used. Only one batch
126 * query object may be active at a time.
128 * There may be additional constraints on which query types can be used
129 * together, in particular those that are implied by
130 * get_driver_query_group_info.
132 * \param num_queries the number of query types
133 * \param query_types array of \p num_queries query types
134 * \return a query object, or NULL on error.
136 struct pipe_query
*(*create_batch_query
)( struct pipe_context
*pipe
,
137 unsigned num_queries
,
138 unsigned *query_types
);
140 void (*destroy_query
)(struct pipe_context
*pipe
,
141 struct pipe_query
*q
);
143 boolean (*begin_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
144 bool (*end_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
147 * Get results of a query.
148 * \param wait if true, this query will block until the result is ready
149 * \return TRUE if results are ready, FALSE otherwise
151 boolean (*get_query_result
)(struct pipe_context
*pipe
,
152 struct pipe_query
*q
,
154 union pipe_query_result
*result
);
157 * Get results of a query, storing into resource. Note that this may not
158 * be used with batch queries.
160 * \param wait if true, this query will block until the result is ready
161 * \param result_type the type of the value being stored:
162 * \param index for queries that return multiple pieces of data, which
163 * item of that data to store (e.g. for
164 * PIPE_QUERY_PIPELINE_STATISTICS).
165 * When the index is -1, instead of the value of the query
166 * the driver should instead write a 1 or 0 to the appropriate
167 * location with 1 meaning that the query result is available.
169 void (*get_query_result_resource
)(struct pipe_context
*pipe
,
170 struct pipe_query
*q
,
172 enum pipe_query_value_type result_type
,
174 struct pipe_resource
*resource
,
178 * Set whether all current non-driver queries except TIME_ELAPSED are
181 void (*set_active_query_state
)(struct pipe_context
*pipe
, boolean enable
);
186 * State functions (create/bind/destroy state objects)
189 void * (*create_blend_state
)(struct pipe_context
*,
190 const struct pipe_blend_state
*);
191 void (*bind_blend_state
)(struct pipe_context
*, void *);
192 void (*delete_blend_state
)(struct pipe_context
*, void *);
194 void * (*create_sampler_state
)(struct pipe_context
*,
195 const struct pipe_sampler_state
*);
196 void (*bind_sampler_states
)(struct pipe_context
*,
197 enum pipe_shader_type shader
,
198 unsigned start_slot
, unsigned num_samplers
,
200 void (*delete_sampler_state
)(struct pipe_context
*, void *);
202 void * (*create_rasterizer_state
)(struct pipe_context
*,
203 const struct pipe_rasterizer_state
*);
204 void (*bind_rasterizer_state
)(struct pipe_context
*, void *);
205 void (*delete_rasterizer_state
)(struct pipe_context
*, void *);
207 void * (*create_depth_stencil_alpha_state
)(struct pipe_context
*,
208 const struct pipe_depth_stencil_alpha_state
*);
209 void (*bind_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
210 void (*delete_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
212 void * (*create_fs_state
)(struct pipe_context
*,
213 const struct pipe_shader_state
*);
214 void (*bind_fs_state
)(struct pipe_context
*, void *);
215 void (*delete_fs_state
)(struct pipe_context
*, void *);
217 void * (*create_vs_state
)(struct pipe_context
*,
218 const struct pipe_shader_state
*);
219 void (*bind_vs_state
)(struct pipe_context
*, void *);
220 void (*delete_vs_state
)(struct pipe_context
*, void *);
222 void * (*create_gs_state
)(struct pipe_context
*,
223 const struct pipe_shader_state
*);
224 void (*bind_gs_state
)(struct pipe_context
*, void *);
225 void (*delete_gs_state
)(struct pipe_context
*, void *);
227 void * (*create_tcs_state
)(struct pipe_context
*,
228 const struct pipe_shader_state
*);
229 void (*bind_tcs_state
)(struct pipe_context
*, void *);
230 void (*delete_tcs_state
)(struct pipe_context
*, void *);
232 void * (*create_tes_state
)(struct pipe_context
*,
233 const struct pipe_shader_state
*);
234 void (*bind_tes_state
)(struct pipe_context
*, void *);
235 void (*delete_tes_state
)(struct pipe_context
*, void *);
237 void * (*create_vertex_elements_state
)(struct pipe_context
*,
238 unsigned num_elements
,
239 const struct pipe_vertex_element
*);
240 void (*bind_vertex_elements_state
)(struct pipe_context
*, void *);
241 void (*delete_vertex_elements_state
)(struct pipe_context
*, void *);
246 * Parameter-like state (or properties)
249 void (*set_blend_color
)( struct pipe_context
*,
250 const struct pipe_blend_color
* );
252 void (*set_stencil_ref
)( struct pipe_context
*,
253 const struct pipe_stencil_ref
* );
255 void (*set_sample_mask
)( struct pipe_context
*,
256 unsigned sample_mask
);
258 void (*set_min_samples
)( struct pipe_context
*,
259 unsigned min_samples
);
261 void (*set_clip_state
)( struct pipe_context
*,
262 const struct pipe_clip_state
* );
264 void (*set_constant_buffer
)( struct pipe_context
*,
265 uint shader
, uint index
,
266 const struct pipe_constant_buffer
*buf
);
268 void (*set_framebuffer_state
)( struct pipe_context
*,
269 const struct pipe_framebuffer_state
* );
271 void (*set_polygon_stipple
)( struct pipe_context
*,
272 const struct pipe_poly_stipple
* );
274 void (*set_scissor_states
)( struct pipe_context
*,
276 unsigned num_scissors
,
277 const struct pipe_scissor_state
* );
279 void (*set_window_rectangles
)( struct pipe_context
*,
281 unsigned num_rectangles
,
282 const struct pipe_scissor_state
* );
284 void (*set_viewport_states
)( struct pipe_context
*,
286 unsigned num_viewports
,
287 const struct pipe_viewport_state
*);
289 void (*set_sampler_views
)(struct pipe_context
*,
290 enum pipe_shader_type shader
,
291 unsigned start_slot
, unsigned num_views
,
292 struct pipe_sampler_view
**);
294 void (*set_tess_state
)(struct pipe_context
*,
295 const float default_outer_level
[4],
296 const float default_inner_level
[2]);
299 * Sets the debug callback. If the pointer is null, then no callback is
300 * set, otherwise a copy of the data should be made.
302 void (*set_debug_callback
)(struct pipe_context
*,
303 const struct pipe_debug_callback
*);
306 * Bind an array of shader buffers that will be used by a shader.
307 * Any buffers that were previously bound to the specified range
310 * \param shader selects shader stage
311 * \param start_slot first buffer slot to bind.
312 * \param count number of consecutive buffers to bind.
313 * \param buffers array of pointers to the buffers to bind, it
314 * should contain at least \a count elements
315 * unless it's NULL, in which case no buffers will
318 void (*set_shader_buffers
)(struct pipe_context
*,
319 enum pipe_shader_type shader
,
320 unsigned start_slot
, unsigned count
,
321 const struct pipe_shader_buffer
*buffers
);
324 * Bind an array of images that will be used by a shader.
325 * Any images that were previously bound to the specified range
328 * \param shader selects shader stage
329 * \param start_slot first image slot to bind.
330 * \param count number of consecutive images to bind.
331 * \param buffers array of the images to bind, it
332 * should contain at least \a count elements
333 * unless it's NULL, in which case no images will
336 void (*set_shader_images
)(struct pipe_context
*,
337 enum pipe_shader_type shader
,
338 unsigned start_slot
, unsigned count
,
339 const struct pipe_image_view
*images
);
341 void (*set_vertex_buffers
)( struct pipe_context
*,
343 unsigned num_buffers
,
344 const struct pipe_vertex_buffer
* );
346 void (*set_index_buffer
)( struct pipe_context
*pipe
,
347 const struct pipe_index_buffer
* );
352 * Stream output functions.
356 struct pipe_stream_output_target
*(*create_stream_output_target
)(
357 struct pipe_context
*,
358 struct pipe_resource
*,
359 unsigned buffer_offset
,
360 unsigned buffer_size
);
362 void (*stream_output_target_destroy
)(struct pipe_context
*,
363 struct pipe_stream_output_target
*);
365 void (*set_stream_output_targets
)(struct pipe_context
*,
366 unsigned num_targets
,
367 struct pipe_stream_output_target
**targets
,
368 const unsigned *offsets
);
374 * Resource functions for blit-like functionality
376 * If a driver supports multisampling, blit must implement color resolve.
381 * Copy a block of pixels from one resource to another.
382 * The resource must be of the same format.
383 * Resources with nr_samples > 1 are not allowed.
385 void (*resource_copy_region
)(struct pipe_context
*pipe
,
386 struct pipe_resource
*dst
,
388 unsigned dstx
, unsigned dsty
, unsigned dstz
,
389 struct pipe_resource
*src
,
391 const struct pipe_box
*src_box
);
393 /* Optimal hardware path for blitting pixels.
394 * Scaling, format conversion, up- and downsampling (resolve) are allowed.
396 void (*blit
)(struct pipe_context
*pipe
,
397 const struct pipe_blit_info
*info
);
402 * Clear the specified set of currently bound buffers to specified values.
403 * The entire buffers are cleared (no scissor, no colormask, etc).
405 * \param buffers bitfield of PIPE_CLEAR_* values.
406 * \param color pointer to a union of fiu array for each of r, g, b, a.
407 * \param depth depth clear value in [0,1].
408 * \param stencil stencil clear value
410 void (*clear
)(struct pipe_context
*pipe
,
412 const union pipe_color_union
*color
,
417 * Clear a color rendertarget surface.
418 * \param color pointer to an union of fiu array for each of r, g, b, a.
420 void (*clear_render_target
)(struct pipe_context
*pipe
,
421 struct pipe_surface
*dst
,
422 const union pipe_color_union
*color
,
423 unsigned dstx
, unsigned dsty
,
424 unsigned width
, unsigned height
,
425 bool render_condition_enabled
);
428 * Clear a depth-stencil surface.
429 * \param clear_flags bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
430 * \param depth depth clear value in [0,1].
431 * \param stencil stencil clear value
433 void (*clear_depth_stencil
)(struct pipe_context
*pipe
,
434 struct pipe_surface
*dst
,
435 unsigned clear_flags
,
438 unsigned dstx
, unsigned dsty
,
439 unsigned width
, unsigned height
,
440 bool render_condition_enabled
);
443 * Clear the texture with the specified texel. Not guaranteed to be a
444 * renderable format. Data provided in the resource's format.
446 void (*clear_texture
)(struct pipe_context
*pipe
,
447 struct pipe_resource
*res
,
449 const struct pipe_box
*box
,
453 * Clear a buffer. Runs a memset over the specified region with the element
454 * value passed in through clear_value of size clear_value_size.
456 void (*clear_buffer
)(struct pipe_context
*pipe
,
457 struct pipe_resource
*res
,
460 const void *clear_value
,
461 int clear_value_size
);
464 * Flush draw commands
466 * NOTE: use screen->fence_reference() (or equivalent) to transfer
467 * new fence ref to **fence, to ensure that previous fence is unref'd
469 * \param fence if not NULL, an old fence to unref and transfer a
470 * new fence reference to
471 * \param flags bitfield of enum pipe_flush_flags values.
473 void (*flush
)(struct pipe_context
*pipe
,
474 struct pipe_fence_handle
**fence
,
478 * Create a view on a texture to be used by a shader stage.
480 struct pipe_sampler_view
* (*create_sampler_view
)(struct pipe_context
*ctx
,
481 struct pipe_resource
*texture
,
482 const struct pipe_sampler_view
*templat
);
484 void (*sampler_view_destroy
)(struct pipe_context
*ctx
,
485 struct pipe_sampler_view
*view
);
489 * Get a surface which is a "view" into a resource, used by
490 * render target / depth stencil stages.
492 struct pipe_surface
*(*create_surface
)(struct pipe_context
*ctx
,
493 struct pipe_resource
*resource
,
494 const struct pipe_surface
*templat
);
496 void (*surface_destroy
)(struct pipe_context
*ctx
,
497 struct pipe_surface
*);
503 * Transfers are (by default) context-private and allow uploads to be
504 * interleaved with rendering.
506 * out_transfer will contain the transfer object that must be passed
507 * to all the other transfer functions. It also contains useful
508 * information (like texture strides).
510 void *(*transfer_map
)(struct pipe_context
*,
511 struct pipe_resource
*resource
,
513 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
514 const struct pipe_box
*,
515 struct pipe_transfer
**out_transfer
);
517 /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the
518 * regions specified with this call are guaranteed to be written to
521 void (*transfer_flush_region
)( struct pipe_context
*,
522 struct pipe_transfer
*transfer
,
523 const struct pipe_box
*);
525 void (*transfer_unmap
)(struct pipe_context
*,
526 struct pipe_transfer
*transfer
);
528 /* One-shot transfer operation with data supplied in a user
531 void (*buffer_subdata
)(struct pipe_context
*,
532 struct pipe_resource
*,
533 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
538 void (*texture_subdata
)(struct pipe_context
*,
539 struct pipe_resource
*,
541 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
542 const struct pipe_box
*,
545 unsigned layer_stride
);
548 * Flush any pending framebuffer writes and invalidate texture caches.
550 void (*texture_barrier
)(struct pipe_context
*);
553 * Flush caches according to flags.
555 void (*memory_barrier
)(struct pipe_context
*, unsigned flags
);
558 * Creates a video codec for a specific video format/profile
560 struct pipe_video_codec
*(*create_video_codec
)( struct pipe_context
*context
,
561 const struct pipe_video_codec
*templat
);
564 * Creates a video buffer as decoding target
566 struct pipe_video_buffer
*(*create_video_buffer
)( struct pipe_context
*context
,
567 const struct pipe_video_buffer
*templat
);
570 * Compute kernel execution
574 * Define the compute program and parameters to be used by
575 * pipe_context::launch_grid.
577 void *(*create_compute_state
)(struct pipe_context
*context
,
578 const struct pipe_compute_state
*);
579 void (*bind_compute_state
)(struct pipe_context
*, void *);
580 void (*delete_compute_state
)(struct pipe_context
*, void *);
583 * Bind an array of shader resources that will be used by the
584 * compute program. Any resources that were previously bound to
585 * the specified range will be unbound after this call.
587 * \param start first resource to bind.
588 * \param count number of consecutive resources to bind.
589 * \param resources array of pointers to the resources to bind, it
590 * should contain at least \a count elements
591 * unless it's NULL, in which case no new
592 * resources will be bound.
594 void (*set_compute_resources
)(struct pipe_context
*,
595 unsigned start
, unsigned count
,
596 struct pipe_surface
**resources
);
599 * Bind an array of buffers to be mapped into the address space of
600 * the GLOBAL resource. Any buffers that were previously bound
601 * between [first, first + count - 1] are unbound after this call.
603 * \param first first buffer to map.
604 * \param count number of consecutive buffers to map.
605 * \param resources array of pointers to the buffers to map, it
606 * should contain at least \a count elements
607 * unless it's NULL, in which case no new
608 * resources will be bound.
609 * \param handles array of pointers to the memory locations that
610 * will be updated with the address each buffer
611 * will be mapped to. The base memory address of
612 * each of the buffers will be added to the value
613 * pointed to by its corresponding handle to form
614 * the final address argument. It should contain
615 * at least \a count elements, unless \a
616 * resources is NULL in which case \a handles
617 * should be NULL as well.
619 * Note that the driver isn't required to make any guarantees about
620 * the contents of the \a handles array being valid anytime except
621 * during the subsequent calls to pipe_context::launch_grid. This
622 * means that the only sensible location handles[i] may point to is
623 * somewhere within the INPUT buffer itself. This is so to
624 * accommodate implementations that lack virtual memory but
625 * nevertheless migrate buffers on the fly, leading to resource
626 * base addresses that change on each kernel invocation or are
627 * unknown to the pipe driver.
629 void (*set_global_binding
)(struct pipe_context
*context
,
630 unsigned first
, unsigned count
,
631 struct pipe_resource
**resources
,
635 * Launch the compute kernel starting from instruction \a pc of the
636 * currently bound compute program.
638 void (*launch_grid
)(struct pipe_context
*context
,
639 const struct pipe_grid_info
*info
);
643 * Get sample position for an individual sample point.
645 * \param sample_count - total number of samples
646 * \param sample_index - sample to get the position values for
647 * \param out_value - return value of 2 floats for x and y position for
650 void (*get_sample_position
)(struct pipe_context
*context
,
651 unsigned sample_count
,
652 unsigned sample_index
,
656 * Query a timestamp in nanoseconds. This is completely equivalent to
657 * pipe_screen::get_timestamp() but takes a context handle for drivers
658 * that require a context.
660 uint64_t (*get_timestamp
)(struct pipe_context
*);
663 * Flush the resource cache, so that the resource can be used
664 * by an external client. Possible usage:
665 * - flushing a resource before presenting it on the screen
666 * - flushing a resource if some other process or device wants to use it
667 * This shouldn't be used to flush caches if the resource is only managed
668 * by a single pipe_screen and is not shared with another process.
669 * (i.e. you shouldn't use it to flush caches explicitly if you want to e.g.
670 * use the resource for texturing)
672 void (*flush_resource
)(struct pipe_context
*ctx
,
673 struct pipe_resource
*resource
);
676 * Invalidate the contents of the resource. This is used to
678 * (1) implement EGL's semantic of undefined depth/stencil
679 * contenst after a swapbuffers. This allows a tiled renderer (for
680 * example) to not store the depth buffer.
682 * (2) implement GL's InvalidateBufferData. For backwards compatibility,
683 * you must only rely on the usability for this purpose when
684 * PIPE_CAP_INVALIDATE_BUFFER is enabled.
686 void (*invalidate_resource
)(struct pipe_context
*ctx
,
687 struct pipe_resource
*resource
);
690 * Return information about unexpected device resets.
692 enum pipe_reset_status (*get_device_reset_status
)(struct pipe_context
*ctx
);
695 * Sets the reset status callback. If the pointer is null, then no callback
696 * is set, otherwise a copy of the data should be made.
698 void (*set_device_reset_callback
)(struct pipe_context
*ctx
,
699 const struct pipe_device_reset_callback
*cb
);
702 * Dump driver-specific debug information into a stream. This is
703 * used by debugging tools.
705 * \param ctx pipe context
706 * \param stream where the output should be written to
707 * \param flags a mask of PIPE_DUMP_* flags
709 void (*dump_debug_state
)(struct pipe_context
*ctx
, FILE *stream
,
713 * Emit string marker in cmdstream
715 void (*emit_string_marker
)(struct pipe_context
*ctx
,
721 * \return TRUE if mipmap generation succeeds, FALSE otherwise
723 boolean (*generate_mipmap
)(struct pipe_context
*ctx
,
724 struct pipe_resource
*resource
,
725 enum pipe_format format
,
728 unsigned first_layer
,
729 unsigned last_layer
);
737 #endif /* PIPE_CONTEXT_H */