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_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
;
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
;
80 * Gallium rendering context. Basically:
81 * - state setting functions
82 * - VBO drawing functions
86 struct pipe_screen
*screen
;
88 void *priv
; /**< context private data (for DRI for example) */
89 void *draw
; /**< private, for draw module (temporary?) */
91 void (*destroy
)( struct pipe_context
* );
97 void (*draw_vbo
)( struct pipe_context
*pipe
,
98 const struct pipe_draw_info
*info
);
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
107 void (*render_condition
)( struct pipe_context
*pipe
,
108 struct pipe_query
*query
,
116 struct pipe_query
*(*create_query
)( struct pipe_context
*pipe
,
121 * Create a query object that queries all given query types simultaneously.
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.
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.
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.
135 struct pipe_query
*(*create_batch_query
)( struct pipe_context
*pipe
,
136 unsigned num_queries
,
137 unsigned *query_types
);
139 void (*destroy_query
)(struct pipe_context
*pipe
,
140 struct pipe_query
*q
);
142 boolean (*begin_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
143 void (*end_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
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
150 boolean (*get_query_result
)(struct pipe_context
*pipe
,
151 struct pipe_query
*q
,
153 union pipe_query_result
*result
);
156 * Get results of a query, storing into resource. Note that this may not
157 * be used with batch queries.
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.
168 void (*get_query_result_resource
)(struct pipe_context
*pipe
,
169 struct pipe_query
*q
,
171 enum pipe_query_value_type result_type
,
173 struct pipe_resource
*resource
,
177 * Set whether all current non-driver queries except TIME_ELAPSED are
180 void (*set_active_query_state
)(struct pipe_context
*pipe
, boolean enable
);
185 * State functions (create/bind/destroy state objects)
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 *);
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 *);
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 *);
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 *);
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 *);
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 *);
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 *);
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 *);
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 *);
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 *);
244 * Parameter-like state (or properties)
247 void (*set_blend_color
)( struct pipe_context
*,
248 const struct pipe_blend_color
* );
250 void (*set_stencil_ref
)( struct pipe_context
*,
251 const struct pipe_stencil_ref
* );
253 void (*set_sample_mask
)( struct pipe_context
*,
254 unsigned sample_mask
);
256 void (*set_min_samples
)( struct pipe_context
*,
257 unsigned min_samples
);
259 void (*set_clip_state
)( struct pipe_context
*,
260 const struct pipe_clip_state
* );
262 void (*set_constant_buffer
)( struct pipe_context
*,
263 uint shader
, uint index
,
264 struct pipe_constant_buffer
*buf
);
266 void (*set_framebuffer_state
)( struct pipe_context
*,
267 const struct pipe_framebuffer_state
* );
269 void (*set_polygon_stipple
)( struct pipe_context
*,
270 const struct pipe_poly_stipple
* );
272 void (*set_scissor_states
)( struct pipe_context
*,
274 unsigned num_scissors
,
275 const struct pipe_scissor_state
* );
277 void (*set_viewport_states
)( struct pipe_context
*,
279 unsigned num_viewports
,
280 const struct pipe_viewport_state
*);
282 void (*set_sampler_views
)(struct pipe_context
*, unsigned shader
,
283 unsigned start_slot
, unsigned num_views
,
284 struct pipe_sampler_view
**);
286 void (*set_tess_state
)(struct pipe_context
*,
287 const float default_outer_level
[4],
288 const float default_inner_level
[2]);
291 * Sets the debug callback. If the pointer is null, then no callback is
292 * set, otherwise a copy of the data should be made.
294 void (*set_debug_callback
)(struct pipe_context
*,
295 const struct pipe_debug_callback
*);
298 * Bind an array of shader buffers that will be used by a shader.
299 * Any buffers that were previously bound to the specified range
302 * \param shader selects shader stage
303 * \param start_slot first buffer slot to bind.
304 * \param count number of consecutive buffers to bind.
305 * \param buffers array of pointers to the buffers to bind, it
306 * should contain at least \a count elements
307 * unless it's NULL, in which case no buffers will
310 void (*set_shader_buffers
)(struct pipe_context
*, unsigned shader
,
311 unsigned start_slot
, unsigned count
,
312 struct pipe_shader_buffer
*buffers
);
315 * Bind an array of images that will be used by a shader.
316 * Any images that were previously bound to the specified range
319 * \param shader selects shader stage
320 * \param start_slot first image slot to bind.
321 * \param count number of consecutive images to bind.
322 * \param buffers array of the images to bind, it
323 * should contain at least \a count elements
324 * unless it's NULL, in which case no images will
327 void (*set_shader_images
)(struct pipe_context
*, unsigned shader
,
328 unsigned start_slot
, unsigned count
,
329 struct pipe_image_view
*images
);
331 void (*set_vertex_buffers
)( struct pipe_context
*,
333 unsigned num_buffers
,
334 const struct pipe_vertex_buffer
* );
336 void (*set_index_buffer
)( struct pipe_context
*pipe
,
337 const struct pipe_index_buffer
* );
342 * Stream output functions.
346 struct pipe_stream_output_target
*(*create_stream_output_target
)(
347 struct pipe_context
*,
348 struct pipe_resource
*,
349 unsigned buffer_offset
,
350 unsigned buffer_size
);
352 void (*stream_output_target_destroy
)(struct pipe_context
*,
353 struct pipe_stream_output_target
*);
355 void (*set_stream_output_targets
)(struct pipe_context
*,
356 unsigned num_targets
,
357 struct pipe_stream_output_target
**targets
,
358 const unsigned *offsets
);
364 * Resource functions for blit-like functionality
366 * If a driver supports multisampling, blit must implement color resolve.
371 * Copy a block of pixels from one resource to another.
372 * The resource must be of the same format.
373 * Resources with nr_samples > 1 are not allowed.
375 void (*resource_copy_region
)(struct pipe_context
*pipe
,
376 struct pipe_resource
*dst
,
378 unsigned dstx
, unsigned dsty
, unsigned dstz
,
379 struct pipe_resource
*src
,
381 const struct pipe_box
*src_box
);
383 /* Optimal hardware path for blitting pixels.
384 * Scaling, format conversion, up- and downsampling (resolve) are allowed.
386 void (*blit
)(struct pipe_context
*pipe
,
387 const struct pipe_blit_info
*info
);
392 * Clear the specified set of currently bound buffers to specified values.
393 * The entire buffers are cleared (no scissor, no colormask, etc).
395 * \param buffers bitfield of PIPE_CLEAR_* values.
396 * \param color pointer to a union of fiu array for each of r, g, b, a.
397 * \param depth depth clear value in [0,1].
398 * \param stencil stencil clear value
400 void (*clear
)(struct pipe_context
*pipe
,
402 const union pipe_color_union
*color
,
407 * Clear a color rendertarget surface.
408 * \param color pointer to an union of fiu array for each of r, g, b, a.
410 void (*clear_render_target
)(struct pipe_context
*pipe
,
411 struct pipe_surface
*dst
,
412 const union pipe_color_union
*color
,
413 unsigned dstx
, unsigned dsty
,
414 unsigned width
, unsigned height
);
417 * Clear a depth-stencil surface.
418 * \param clear_flags bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
419 * \param depth depth clear value in [0,1].
420 * \param stencil stencil clear value
422 void (*clear_depth_stencil
)(struct pipe_context
*pipe
,
423 struct pipe_surface
*dst
,
424 unsigned clear_flags
,
427 unsigned dstx
, unsigned dsty
,
428 unsigned width
, unsigned height
);
431 * Clear the texture with the specified texel. Not guaranteed to be a
432 * renderable format. Data provided in the resource's format.
434 void (*clear_texture
)(struct pipe_context
*pipe
,
435 struct pipe_resource
*res
,
437 const struct pipe_box
*box
,
441 * Clear a buffer. Runs a memset over the specified region with the element
442 * value passed in through clear_value of size clear_value_size.
444 void (*clear_buffer
)(struct pipe_context
*pipe
,
445 struct pipe_resource
*res
,
448 const void *clear_value
,
449 int clear_value_size
);
452 * Flush draw commands
454 * NOTE: use screen->fence_reference() (or equivalent) to transfer
455 * new fence ref to **fence, to ensure that previous fence is unref'd
457 * \param fence if not NULL, an old fence to unref and transfer a
458 * new fence reference to
459 * \param flags bitfield of enum pipe_flush_flags values.
461 void (*flush
)(struct pipe_context
*pipe
,
462 struct pipe_fence_handle
**fence
,
466 * Create a view on a texture to be used by a shader stage.
468 struct pipe_sampler_view
* (*create_sampler_view
)(struct pipe_context
*ctx
,
469 struct pipe_resource
*texture
,
470 const struct pipe_sampler_view
*templat
);
472 void (*sampler_view_destroy
)(struct pipe_context
*ctx
,
473 struct pipe_sampler_view
*view
);
477 * Get a surface which is a "view" into a resource, used by
478 * render target / depth stencil stages.
480 struct pipe_surface
*(*create_surface
)(struct pipe_context
*ctx
,
481 struct pipe_resource
*resource
,
482 const struct pipe_surface
*templat
);
484 void (*surface_destroy
)(struct pipe_context
*ctx
,
485 struct pipe_surface
*);
491 * Transfers are (by default) context-private and allow uploads to be
492 * interleaved with rendering.
494 * out_transfer will contain the transfer object that must be passed
495 * to all the other transfer functions. It also contains useful
496 * information (like texture strides).
498 void *(*transfer_map
)(struct pipe_context
*,
499 struct pipe_resource
*resource
,
501 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
502 const struct pipe_box
*,
503 struct pipe_transfer
**out_transfer
);
505 /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the
506 * regions specified with this call are guaranteed to be written to
509 void (*transfer_flush_region
)( struct pipe_context
*,
510 struct pipe_transfer
*transfer
,
511 const struct pipe_box
*);
513 void (*transfer_unmap
)(struct pipe_context
*,
514 struct pipe_transfer
*transfer
);
516 /* One-shot transfer operation with data supplied in a user
517 * pointer. XXX: strides??
519 void (*transfer_inline_write
)( struct pipe_context
*,
520 struct pipe_resource
*,
522 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
523 const struct pipe_box
*,
526 unsigned layer_stride
);
529 * Flush any pending framebuffer writes and invalidate texture caches.
531 void (*texture_barrier
)(struct pipe_context
*);
534 * Flush caches according to flags.
536 void (*memory_barrier
)(struct pipe_context
*, unsigned flags
);
539 * Creates a video codec for a specific video format/profile
541 struct pipe_video_codec
*(*create_video_codec
)( struct pipe_context
*context
,
542 const struct pipe_video_codec
*templat
);
545 * Creates a video buffer as decoding target
547 struct pipe_video_buffer
*(*create_video_buffer
)( struct pipe_context
*context
,
548 const struct pipe_video_buffer
*templat
);
551 * Compute kernel execution
555 * Define the compute program and parameters to be used by
556 * pipe_context::launch_grid.
558 void *(*create_compute_state
)(struct pipe_context
*context
,
559 const struct pipe_compute_state
*);
560 void (*bind_compute_state
)(struct pipe_context
*, void *);
561 void (*delete_compute_state
)(struct pipe_context
*, void *);
564 * Bind an array of shader resources that will be used by the
565 * compute program. Any resources that were previously bound to
566 * the specified range will be unbound after this call.
568 * \param start first resource to bind.
569 * \param count number of consecutive resources to bind.
570 * \param resources array of pointers to the resources to bind, it
571 * should contain at least \a count elements
572 * unless it's NULL, in which case no new
573 * resources will be bound.
575 void (*set_compute_resources
)(struct pipe_context
*,
576 unsigned start
, unsigned count
,
577 struct pipe_surface
**resources
);
580 * Bind an array of buffers to be mapped into the address space of
581 * the GLOBAL resource. Any buffers that were previously bound
582 * between [first, first + count - 1] are unbound after this call.
584 * \param first first buffer to map.
585 * \param count number of consecutive buffers to map.
586 * \param resources array of pointers to the buffers to map, it
587 * should contain at least \a count elements
588 * unless it's NULL, in which case no new
589 * resources will be bound.
590 * \param handles array of pointers to the memory locations that
591 * will be updated with the address each buffer
592 * will be mapped to. The base memory address of
593 * each of the buffers will be added to the value
594 * pointed to by its corresponding handle to form
595 * the final address argument. It should contain
596 * at least \a count elements, unless \a
597 * resources is NULL in which case \a handles
598 * should be NULL as well.
600 * Note that the driver isn't required to make any guarantees about
601 * the contents of the \a handles array being valid anytime except
602 * during the subsequent calls to pipe_context::launch_grid. This
603 * means that the only sensible location handles[i] may point to is
604 * somewhere within the INPUT buffer itself. This is so to
605 * accommodate implementations that lack virtual memory but
606 * nevertheless migrate buffers on the fly, leading to resource
607 * base addresses that change on each kernel invocation or are
608 * unknown to the pipe driver.
610 void (*set_global_binding
)(struct pipe_context
*context
,
611 unsigned first
, unsigned count
,
612 struct pipe_resource
**resources
,
616 * Launch the compute kernel starting from instruction \a pc of the
617 * currently bound compute program.
619 void (*launch_grid
)(struct pipe_context
*context
,
620 const struct pipe_grid_info
*info
);
624 * Get sample position for an individual sample point.
626 * \param sample_count - total number of samples
627 * \param sample_index - sample to get the position values for
628 * \param out_value - return value of 2 floats for x and y position for
631 void (*get_sample_position
)(struct pipe_context
*context
,
632 unsigned sample_count
,
633 unsigned sample_index
,
637 * Query a timestamp in nanoseconds. This is completely equivalent to
638 * pipe_screen::get_timestamp() but takes a context handle for drivers
639 * that require a context.
641 uint64_t (*get_timestamp
)(struct pipe_context
*);
644 * Flush the resource cache, so that the resource can be used
645 * by an external client. Possible usage:
646 * - flushing a resource before presenting it on the screen
647 * - flushing a resource if some other process or device wants to use it
648 * This shouldn't be used to flush caches if the resource is only managed
649 * by a single pipe_screen and is not shared with another process.
650 * (i.e. you shouldn't use it to flush caches explicitly if you want to e.g.
651 * use the resource for texturing)
653 void (*flush_resource
)(struct pipe_context
*ctx
,
654 struct pipe_resource
*resource
);
657 * Invalidate the contents of the resource. This is used to
659 * (1) implement EGL's semantic of undefined depth/stencil
660 * contenst after a swapbuffers. This allows a tiled renderer (for
661 * example) to not store the depth buffer.
663 * (2) implement GL's InvalidateBufferData. For backwards compatibility,
664 * you must only rely on the usability for this purpose when
665 * PIPE_CAP_INVALIDATE_BUFFER is enabled.
667 void (*invalidate_resource
)(struct pipe_context
*ctx
,
668 struct pipe_resource
*resource
);
671 * Return information about unexpected device resets.
673 enum pipe_reset_status (*get_device_reset_status
)(struct pipe_context
*ctx
);
676 * Dump driver-specific debug information into a stream. This is
677 * used by debugging tools.
679 * \param ctx pipe context
680 * \param stream where the output should be written to
681 * \param flags a mask of PIPE_DEBUG_* flags
683 void (*dump_debug_state
)(struct pipe_context
*ctx
, FILE *stream
,
687 * Emit string marker in cmdstream
689 void (*emit_string_marker
)(struct pipe_context
*ctx
,
695 * \return TRUE if mipmap generation succeeds, FALSE otherwise
697 boolean (*generate_mipmap
)(struct pipe_context
*ctx
,
698 struct pipe_resource
*resource
,
699 enum pipe_format format
,
702 unsigned first_layer
,
703 unsigned last_layer
);
711 #endif /* PIPE_CONTEXT_H */