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
;
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
,
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 boolean (*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 boolean (*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
, boolean 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 uint shader
, uint index
,
277 const struct pipe_constant_buffer
*buf
);
279 void (*set_framebuffer_state
)( struct pipe_context
*,
280 const struct pipe_framebuffer_state
* );
282 void (*set_polygon_stipple
)( struct pipe_context
*,
283 const struct pipe_poly_stipple
* );
285 void (*set_scissor_states
)( struct pipe_context
*,
287 unsigned num_scissors
,
288 const struct pipe_scissor_state
* );
290 void (*set_window_rectangles
)( struct pipe_context
*,
292 unsigned num_rectangles
,
293 const struct pipe_scissor_state
* );
295 void (*set_viewport_states
)( struct pipe_context
*,
297 unsigned num_viewports
,
298 const struct pipe_viewport_state
*);
300 void (*set_sampler_views
)(struct pipe_context
*,
301 enum pipe_shader_type shader
,
302 unsigned start_slot
, unsigned num_views
,
303 struct pipe_sampler_view
**);
305 void (*set_tess_state
)(struct pipe_context
*,
306 const float default_outer_level
[4],
307 const float default_inner_level
[2]);
310 * Sets the debug callback. If the pointer is null, then no callback is
311 * set, otherwise a copy of the data should be made.
313 void (*set_debug_callback
)(struct pipe_context
*,
314 const struct pipe_debug_callback
*);
317 * Bind an array of shader buffers that will be used by a shader.
318 * Any buffers that were previously bound to the specified range
321 * \param shader selects shader stage
322 * \param start_slot first buffer slot to bind.
323 * \param count number of consecutive buffers to bind.
324 * \param buffers array of pointers to the buffers to bind, it
325 * should contain at least \a count elements
326 * unless it's NULL, in which case no buffers will
329 void (*set_shader_buffers
)(struct pipe_context
*,
330 enum pipe_shader_type shader
,
331 unsigned start_slot
, unsigned count
,
332 const struct pipe_shader_buffer
*buffers
);
335 * Bind an array of images that will be used by a shader.
336 * Any images that were previously bound to the specified range
339 * \param shader selects shader stage
340 * \param start_slot first image slot to bind.
341 * \param count number of consecutive images to bind.
342 * \param buffers array of the images to bind, it
343 * should contain at least \a count elements
344 * unless it's NULL, in which case no images will
347 void (*set_shader_images
)(struct pipe_context
*,
348 enum pipe_shader_type shader
,
349 unsigned start_slot
, unsigned count
,
350 const struct pipe_image_view
*images
);
352 void (*set_vertex_buffers
)( struct pipe_context
*,
354 unsigned num_buffers
,
355 const struct pipe_vertex_buffer
* );
357 void (*set_index_buffer
)( struct pipe_context
*pipe
,
358 const struct pipe_index_buffer
* );
363 * Stream output functions.
367 struct pipe_stream_output_target
*(*create_stream_output_target
)(
368 struct pipe_context
*,
369 struct pipe_resource
*,
370 unsigned buffer_offset
,
371 unsigned buffer_size
);
373 void (*stream_output_target_destroy
)(struct pipe_context
*,
374 struct pipe_stream_output_target
*);
376 void (*set_stream_output_targets
)(struct pipe_context
*,
377 unsigned num_targets
,
378 struct pipe_stream_output_target
**targets
,
379 const unsigned *offsets
);
385 * Resource functions for blit-like functionality
387 * If a driver supports multisampling, blit must implement color resolve.
392 * Copy a block of pixels from one resource to another.
393 * The resource must be of the same format.
394 * Resources with nr_samples > 1 are not allowed.
396 void (*resource_copy_region
)(struct pipe_context
*pipe
,
397 struct pipe_resource
*dst
,
399 unsigned dstx
, unsigned dsty
, unsigned dstz
,
400 struct pipe_resource
*src
,
402 const struct pipe_box
*src_box
);
404 /* Optimal hardware path for blitting pixels.
405 * Scaling, format conversion, up- and downsampling (resolve) are allowed.
407 void (*blit
)(struct pipe_context
*pipe
,
408 const struct pipe_blit_info
*info
);
413 * Clear the specified set of currently bound buffers to specified values.
414 * The entire buffers are cleared (no scissor, no colormask, etc).
416 * \param buffers bitfield of PIPE_CLEAR_* values.
417 * \param color pointer to a union of fiu array for each of r, g, b, a.
418 * \param depth depth clear value in [0,1].
419 * \param stencil stencil clear value
421 void (*clear
)(struct pipe_context
*pipe
,
423 const union pipe_color_union
*color
,
428 * Clear a color rendertarget surface.
429 * \param color pointer to an union of fiu array for each of r, g, b, a.
431 void (*clear_render_target
)(struct pipe_context
*pipe
,
432 struct pipe_surface
*dst
,
433 const union pipe_color_union
*color
,
434 unsigned dstx
, unsigned dsty
,
435 unsigned width
, unsigned height
,
436 bool render_condition_enabled
);
439 * Clear a depth-stencil surface.
440 * \param clear_flags bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
441 * \param depth depth clear value in [0,1].
442 * \param stencil stencil clear value
444 void (*clear_depth_stencil
)(struct pipe_context
*pipe
,
445 struct pipe_surface
*dst
,
446 unsigned clear_flags
,
449 unsigned dstx
, unsigned dsty
,
450 unsigned width
, unsigned height
,
451 bool render_condition_enabled
);
454 * Clear the texture with the specified texel. Not guaranteed to be a
455 * renderable format. Data provided in the resource's format.
457 void (*clear_texture
)(struct pipe_context
*pipe
,
458 struct pipe_resource
*res
,
460 const struct pipe_box
*box
,
464 * Clear a buffer. Runs a memset over the specified region with the element
465 * value passed in through clear_value of size clear_value_size.
467 void (*clear_buffer
)(struct pipe_context
*pipe
,
468 struct pipe_resource
*res
,
471 const void *clear_value
,
472 int clear_value_size
);
475 * Flush draw commands
477 * NOTE: use screen->fence_reference() (or equivalent) to transfer
478 * new fence ref to **fence, to ensure that previous fence is unref'd
480 * \param fence if not NULL, an old fence to unref and transfer a
481 * new fence reference to
482 * \param flags bitfield of enum pipe_flush_flags values.
484 void (*flush
)(struct pipe_context
*pipe
,
485 struct pipe_fence_handle
**fence
,
489 * Create a fence from a native sync fd.
491 * This is used for importing a foreign/external fence fd.
493 * \param fence if not NULL, an old fence to unref and transfer a
494 * new fence reference to
495 * \param fd native fence fd
497 void (*create_fence_fd
)(struct pipe_context
*pipe
,
498 struct pipe_fence_handle
**fence
,
502 * Insert commands to have GPU wait for fence to be signaled.
504 void (*fence_server_sync
)(struct pipe_context
*pipe
,
505 struct pipe_fence_handle
*fence
);
508 * Create a view on a texture to be used by a shader stage.
510 struct pipe_sampler_view
* (*create_sampler_view
)(struct pipe_context
*ctx
,
511 struct pipe_resource
*texture
,
512 const struct pipe_sampler_view
*templat
);
514 void (*sampler_view_destroy
)(struct pipe_context
*ctx
,
515 struct pipe_sampler_view
*view
);
519 * Get a surface which is a "view" into a resource, used by
520 * render target / depth stencil stages.
522 struct pipe_surface
*(*create_surface
)(struct pipe_context
*ctx
,
523 struct pipe_resource
*resource
,
524 const struct pipe_surface
*templat
);
526 void (*surface_destroy
)(struct pipe_context
*ctx
,
527 struct pipe_surface
*);
533 * Transfers are (by default) context-private and allow uploads to be
534 * interleaved with rendering.
536 * out_transfer will contain the transfer object that must be passed
537 * to all the other transfer functions. It also contains useful
538 * information (like texture strides).
540 void *(*transfer_map
)(struct pipe_context
*,
541 struct pipe_resource
*resource
,
543 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
544 const struct pipe_box
*,
545 struct pipe_transfer
**out_transfer
);
547 /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the
548 * regions specified with this call are guaranteed to be written to
551 void (*transfer_flush_region
)( struct pipe_context
*,
552 struct pipe_transfer
*transfer
,
553 const struct pipe_box
*);
555 void (*transfer_unmap
)(struct pipe_context
*,
556 struct pipe_transfer
*transfer
);
558 /* One-shot transfer operation with data supplied in a user
561 void (*buffer_subdata
)(struct pipe_context
*,
562 struct pipe_resource
*,
563 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
568 void (*texture_subdata
)(struct pipe_context
*,
569 struct pipe_resource
*,
571 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
572 const struct pipe_box
*,
575 unsigned layer_stride
);
578 * Flush any pending framebuffer writes and invalidate texture caches.
580 void (*texture_barrier
)(struct pipe_context
*, unsigned flags
);
583 * Flush caches according to flags.
585 void (*memory_barrier
)(struct pipe_context
*, unsigned flags
);
588 * Creates a video codec for a specific video format/profile
590 struct pipe_video_codec
*(*create_video_codec
)( struct pipe_context
*context
,
591 const struct pipe_video_codec
*templat
);
594 * Creates a video buffer as decoding target
596 struct pipe_video_buffer
*(*create_video_buffer
)( struct pipe_context
*context
,
597 const struct pipe_video_buffer
*templat
);
600 * Compute kernel execution
604 * Define the compute program and parameters to be used by
605 * pipe_context::launch_grid.
607 void *(*create_compute_state
)(struct pipe_context
*context
,
608 const struct pipe_compute_state
*);
609 void (*bind_compute_state
)(struct pipe_context
*, void *);
610 void (*delete_compute_state
)(struct pipe_context
*, void *);
613 * Bind an array of shader resources that will be used by the
614 * compute program. Any resources that were previously bound to
615 * the specified range will be unbound after this call.
617 * \param start first resource to bind.
618 * \param count number of consecutive resources to bind.
619 * \param resources array of pointers to the resources to bind, it
620 * should contain at least \a count elements
621 * unless it's NULL, in which case no new
622 * resources will be bound.
624 void (*set_compute_resources
)(struct pipe_context
*,
625 unsigned start
, unsigned count
,
626 struct pipe_surface
**resources
);
629 * Bind an array of buffers to be mapped into the address space of
630 * the GLOBAL resource. Any buffers that were previously bound
631 * between [first, first + count - 1] are unbound after this call.
633 * \param first first buffer to map.
634 * \param count number of consecutive buffers to map.
635 * \param resources array of pointers to the buffers to map, it
636 * should contain at least \a count elements
637 * unless it's NULL, in which case no new
638 * resources will be bound.
639 * \param handles array of pointers to the memory locations that
640 * will be updated with the address each buffer
641 * will be mapped to. The base memory address of
642 * each of the buffers will be added to the value
643 * pointed to by its corresponding handle to form
644 * the final address argument. It should contain
645 * at least \a count elements, unless \a
646 * resources is NULL in which case \a handles
647 * should be NULL as well.
649 * Note that the driver isn't required to make any guarantees about
650 * the contents of the \a handles array being valid anytime except
651 * during the subsequent calls to pipe_context::launch_grid. This
652 * means that the only sensible location handles[i] may point to is
653 * somewhere within the INPUT buffer itself. This is so to
654 * accommodate implementations that lack virtual memory but
655 * nevertheless migrate buffers on the fly, leading to resource
656 * base addresses that change on each kernel invocation or are
657 * unknown to the pipe driver.
659 void (*set_global_binding
)(struct pipe_context
*context
,
660 unsigned first
, unsigned count
,
661 struct pipe_resource
**resources
,
665 * Launch the compute kernel starting from instruction \a pc of the
666 * currently bound compute program.
668 void (*launch_grid
)(struct pipe_context
*context
,
669 const struct pipe_grid_info
*info
);
673 * Get sample position for an individual sample point.
675 * \param sample_count - total number of samples
676 * \param sample_index - sample to get the position values for
677 * \param out_value - return value of 2 floats for x and y position for
680 void (*get_sample_position
)(struct pipe_context
*context
,
681 unsigned sample_count
,
682 unsigned sample_index
,
686 * Query a timestamp in nanoseconds. This is completely equivalent to
687 * pipe_screen::get_timestamp() but takes a context handle for drivers
688 * that require a context.
690 uint64_t (*get_timestamp
)(struct pipe_context
*);
693 * Flush the resource cache, so that the resource can be used
694 * by an external client. Possible usage:
695 * - flushing a resource before presenting it on the screen
696 * - flushing a resource if some other process or device wants to use it
697 * This shouldn't be used to flush caches if the resource is only managed
698 * by a single pipe_screen and is not shared with another process.
699 * (i.e. you shouldn't use it to flush caches explicitly if you want to e.g.
700 * use the resource for texturing)
702 void (*flush_resource
)(struct pipe_context
*ctx
,
703 struct pipe_resource
*resource
);
706 * Invalidate the contents of the resource. This is used to
708 * (1) implement EGL's semantic of undefined depth/stencil
709 * contenst after a swapbuffers. This allows a tiled renderer (for
710 * example) to not store the depth buffer.
712 * (2) implement GL's InvalidateBufferData. For backwards compatibility,
713 * you must only rely on the usability for this purpose when
714 * PIPE_CAP_INVALIDATE_BUFFER is enabled.
716 void (*invalidate_resource
)(struct pipe_context
*ctx
,
717 struct pipe_resource
*resource
);
720 * Return information about unexpected device resets.
722 enum pipe_reset_status (*get_device_reset_status
)(struct pipe_context
*ctx
);
725 * Sets the reset status callback. If the pointer is null, then no callback
726 * is set, otherwise a copy of the data should be made.
728 void (*set_device_reset_callback
)(struct pipe_context
*ctx
,
729 const struct pipe_device_reset_callback
*cb
);
732 * Dump driver-specific debug information into a stream. This is
733 * used by debugging tools.
735 * \param ctx pipe context
736 * \param stream where the output should be written to
737 * \param flags a mask of PIPE_DUMP_* flags
739 void (*dump_debug_state
)(struct pipe_context
*ctx
, FILE *stream
,
743 * Emit string marker in cmdstream
745 void (*emit_string_marker
)(struct pipe_context
*ctx
,
751 * \return TRUE if mipmap generation succeeds, FALSE otherwise
753 boolean (*generate_mipmap
)(struct pipe_context
*ctx
,
754 struct pipe_resource
*resource
,
755 enum pipe_format format
,
758 unsigned first_layer
,
759 unsigned last_layer
);
767 #endif /* PIPE_CONTEXT_H */