1 /**************************************************************************
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
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 TUNGSTEN GRAPHICS 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"
41 struct pipe_blend_color
;
42 struct pipe_blend_state
;
43 struct pipe_blit_info
;
45 struct pipe_clip_state
;
46 struct pipe_constant_buffer
;
47 struct pipe_depth_stencil_alpha_state
;
48 struct pipe_draw_info
;
49 struct pipe_fence_handle
;
50 struct pipe_framebuffer_state
;
51 struct pipe_index_buffer
;
53 struct pipe_poly_stipple
;
54 struct pipe_rasterizer_state
;
55 struct pipe_resolve_info
;
57 struct pipe_sampler_state
;
58 struct pipe_sampler_view
;
59 struct pipe_scissor_state
;
60 struct pipe_shader_state
;
61 struct pipe_stencil_ref
;
62 struct pipe_stream_output_target
;
65 struct pipe_vertex_buffer
;
66 struct pipe_vertex_element
;
67 struct pipe_video_buffer
;
68 struct pipe_video_decoder
;
69 struct pipe_viewport_state
;
70 struct pipe_compute_state
;
71 union pipe_color_union
;
72 union pipe_query_result
;
75 * Gallium rendering context. Basically:
76 * - state setting functions
77 * - VBO drawing functions
81 struct pipe_screen
*screen
;
83 void *priv
; /**< context private data (for DRI for example) */
84 void *draw
; /**< private, for draw module (temporary?) */
86 void (*destroy
)( struct pipe_context
* );
92 void (*draw_vbo
)( struct pipe_context
*pipe
,
93 const struct pipe_draw_info
*info
);
97 * Predicate subsequent rendering on occlusion query result
98 * \param query the query predicate, or NULL if no predicate
99 * \param mode one of PIPE_RENDER_COND_x
101 void (*render_condition
)( struct pipe_context
*pipe
,
102 struct pipe_query
*query
,
109 struct pipe_query
*(*create_query
)( struct pipe_context
*pipe
,
110 unsigned query_type
);
112 void (*destroy_query
)(struct pipe_context
*pipe
,
113 struct pipe_query
*q
);
115 void (*begin_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
116 void (*end_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
119 * Get results of a query.
120 * \param wait if true, this query will block until the result is ready
121 * \return TRUE if results are ready, FALSE otherwise
123 boolean (*get_query_result
)(struct pipe_context
*pipe
,
124 struct pipe_query
*q
,
126 union pipe_query_result
*result
);
130 * State functions (create/bind/destroy state objects)
133 void * (*create_blend_state
)(struct pipe_context
*,
134 const struct pipe_blend_state
*);
135 void (*bind_blend_state
)(struct pipe_context
*, void *);
136 void (*delete_blend_state
)(struct pipe_context
*, void *);
138 void * (*create_sampler_state
)(struct pipe_context
*,
139 const struct pipe_sampler_state
*);
140 void (*bind_fragment_sampler_states
)(struct pipe_context
*,
141 unsigned num_samplers
,
143 void (*bind_vertex_sampler_states
)(struct pipe_context
*,
144 unsigned num_samplers
,
146 void (*bind_geometry_sampler_states
)(struct pipe_context
*,
147 unsigned num_samplers
,
149 void (*bind_compute_sampler_states
)(struct pipe_context
*,
151 unsigned num_samplers
,
153 void (*delete_sampler_state
)(struct pipe_context
*, void *);
155 void * (*create_rasterizer_state
)(struct pipe_context
*,
156 const struct pipe_rasterizer_state
*);
157 void (*bind_rasterizer_state
)(struct pipe_context
*, void *);
158 void (*delete_rasterizer_state
)(struct pipe_context
*, void *);
160 void * (*create_depth_stencil_alpha_state
)(struct pipe_context
*,
161 const struct pipe_depth_stencil_alpha_state
*);
162 void (*bind_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
163 void (*delete_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
165 void * (*create_fs_state
)(struct pipe_context
*,
166 const struct pipe_shader_state
*);
167 void (*bind_fs_state
)(struct pipe_context
*, void *);
168 void (*delete_fs_state
)(struct pipe_context
*, void *);
170 void * (*create_vs_state
)(struct pipe_context
*,
171 const struct pipe_shader_state
*);
172 void (*bind_vs_state
)(struct pipe_context
*, void *);
173 void (*delete_vs_state
)(struct pipe_context
*, void *);
175 void * (*create_gs_state
)(struct pipe_context
*,
176 const struct pipe_shader_state
*);
177 void (*bind_gs_state
)(struct pipe_context
*, void *);
178 void (*delete_gs_state
)(struct pipe_context
*, void *);
180 void * (*create_vertex_elements_state
)(struct pipe_context
*,
181 unsigned num_elements
,
182 const struct pipe_vertex_element
*);
183 void (*bind_vertex_elements_state
)(struct pipe_context
*, void *);
184 void (*delete_vertex_elements_state
)(struct pipe_context
*, void *);
189 * Parameter-like state (or properties)
192 void (*set_blend_color
)( struct pipe_context
*,
193 const struct pipe_blend_color
* );
195 void (*set_stencil_ref
)( struct pipe_context
*,
196 const struct pipe_stencil_ref
* );
198 void (*set_sample_mask
)( struct pipe_context
*,
199 unsigned sample_mask
);
201 void (*set_clip_state
)( struct pipe_context
*,
202 const struct pipe_clip_state
* );
204 void (*set_constant_buffer
)( struct pipe_context
*,
205 uint shader
, uint index
,
206 struct pipe_constant_buffer
*buf
);
208 void (*set_framebuffer_state
)( struct pipe_context
*,
209 const struct pipe_framebuffer_state
* );
211 void (*set_polygon_stipple
)( struct pipe_context
*,
212 const struct pipe_poly_stipple
* );
214 void (*set_scissor_states
)( struct pipe_context
*,
216 unsigned num_scissors
,
217 const struct pipe_scissor_state
* );
219 void (*set_viewport_states
)( struct pipe_context
*,
221 unsigned num_viewports
,
222 const struct pipe_viewport_state
*);
224 void (*set_fragment_sampler_views
)(struct pipe_context
*,
226 struct pipe_sampler_view
**);
228 void (*set_vertex_sampler_views
)(struct pipe_context
*,
230 struct pipe_sampler_view
**);
232 void (*set_geometry_sampler_views
)(struct pipe_context
*,
234 struct pipe_sampler_view
**);
236 void (*set_compute_sampler_views
)(struct pipe_context
*,
237 unsigned start_slot
, unsigned num_views
,
238 struct pipe_sampler_view
**);
241 * Bind an array of shader resources that will be used by the
242 * graphics pipeline. Any resources that were previously bound to
243 * the specified range will be unbound after this call.
245 * \param start first resource to bind.
246 * \param count number of consecutive resources to bind.
247 * \param resources array of pointers to the resources to bind, it
248 * should contain at least \a count elements
249 * unless it's NULL, in which case no new
250 * resources will be bound.
252 void (*set_shader_resources
)(struct pipe_context
*,
253 unsigned start
, unsigned count
,
254 struct pipe_surface
**resources
);
256 void (*set_vertex_buffers
)( struct pipe_context
*,
258 unsigned num_buffers
,
259 const struct pipe_vertex_buffer
* );
261 void (*set_index_buffer
)( struct pipe_context
*pipe
,
262 const struct pipe_index_buffer
* );
267 * Stream output functions.
271 struct pipe_stream_output_target
*(*create_stream_output_target
)(
272 struct pipe_context
*,
273 struct pipe_resource
*,
274 unsigned buffer_offset
,
275 unsigned buffer_size
);
277 void (*stream_output_target_destroy
)(struct pipe_context
*,
278 struct pipe_stream_output_target
*);
280 void (*set_stream_output_targets
)(struct pipe_context
*,
281 unsigned num_targets
,
282 struct pipe_stream_output_target
**targets
,
283 unsigned append_bitmask
);
289 * Resource functions for blit-like functionality
291 * If a driver supports multisampling, blit must implement color resolve.
296 * Copy a block of pixels from one resource to another.
297 * The resource must be of the same format.
298 * Resources with nr_samples > 1 are not allowed.
300 void (*resource_copy_region
)(struct pipe_context
*pipe
,
301 struct pipe_resource
*dst
,
303 unsigned dstx
, unsigned dsty
, unsigned dstz
,
304 struct pipe_resource
*src
,
306 const struct pipe_box
*src_box
);
308 /* Optimal hardware path for blitting pixels.
309 * Scaling, format conversion, up- and downsampling (resolve) are allowed.
311 void (*blit
)(struct pipe_context
*pipe
,
312 const struct pipe_blit_info
*info
);
317 * Clear the specified set of currently bound buffers to specified values.
318 * The entire buffers are cleared (no scissor, no colormask, etc).
320 * \param buffers bitfield of PIPE_CLEAR_* values.
321 * \param color pointer to a union of fiu array for each of r, g, b, a.
322 * \param depth depth clear value in [0,1].
323 * \param stencil stencil clear value
325 void (*clear
)(struct pipe_context
*pipe
,
327 const union pipe_color_union
*color
,
332 * Clear a color rendertarget surface.
333 * \param color pointer to an union of fiu array for each of r, g, b, a.
335 void (*clear_render_target
)(struct pipe_context
*pipe
,
336 struct pipe_surface
*dst
,
337 const union pipe_color_union
*color
,
338 unsigned dstx
, unsigned dsty
,
339 unsigned width
, unsigned height
);
342 * Clear a depth-stencil surface.
343 * \param clear_flags bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
344 * \param depth depth clear value in [0,1].
345 * \param stencil stencil clear value
347 void (*clear_depth_stencil
)(struct pipe_context
*pipe
,
348 struct pipe_surface
*dst
,
349 unsigned clear_flags
,
352 unsigned dstx
, unsigned dsty
,
353 unsigned width
, unsigned height
);
355 /** Flush draw commands
357 * \param flags bitfield of enum pipe_flush_flags values.
359 void (*flush
)(struct pipe_context
*pipe
,
360 struct pipe_fence_handle
**fence
,
364 * Create a view on a texture to be used by a shader stage.
366 struct pipe_sampler_view
* (*create_sampler_view
)(struct pipe_context
*ctx
,
367 struct pipe_resource
*texture
,
368 const struct pipe_sampler_view
*templat
);
370 void (*sampler_view_destroy
)(struct pipe_context
*ctx
,
371 struct pipe_sampler_view
*view
);
375 * Get a surface which is a "view" into a resource, used by
376 * render target / depth stencil stages.
378 struct pipe_surface
*(*create_surface
)(struct pipe_context
*ctx
,
379 struct pipe_resource
*resource
,
380 const struct pipe_surface
*templat
);
382 void (*surface_destroy
)(struct pipe_context
*ctx
,
383 struct pipe_surface
*);
388 * Transfers are (by default) context-private and allow uploads to be
389 * interleaved with rendering.
391 * out_transfer will contain the transfer object that must be passed
392 * to all the other transfer functions. It also contains useful
393 * information (like texture strides).
395 void *(*transfer_map
)(struct pipe_context
*,
396 struct pipe_resource
*resource
,
398 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
399 const struct pipe_box
*,
400 struct pipe_transfer
**out_transfer
);
402 /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the
403 * regions specified with this call are guaranteed to be written to
406 void (*transfer_flush_region
)( struct pipe_context
*,
407 struct pipe_transfer
*transfer
,
408 const struct pipe_box
*);
410 void (*transfer_unmap
)(struct pipe_context
*,
411 struct pipe_transfer
*transfer
);
413 /* One-shot transfer operation with data supplied in a user
414 * pointer. XXX: strides??
416 void (*transfer_inline_write
)( struct pipe_context
*,
417 struct pipe_resource
*,
419 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
420 const struct pipe_box
*,
423 unsigned layer_stride
);
426 * Flush any pending framebuffer writes and invalidate texture caches.
428 void (*texture_barrier
)(struct pipe_context
*);
431 * Creates a video decoder for a specific video codec/profile
433 struct pipe_video_decoder
*(*create_video_decoder
)( struct pipe_context
*context
,
434 enum pipe_video_profile profile
,
435 enum pipe_video_entrypoint entrypoint
,
436 enum pipe_video_chroma_format chroma_format
,
437 unsigned width
, unsigned height
, unsigned max_references
,
438 bool expect_chunked_decode
);
441 * Creates a video buffer as decoding target
443 struct pipe_video_buffer
*(*create_video_buffer
)( struct pipe_context
*context
,
444 const struct pipe_video_buffer
*templat
);
447 * Compute kernel execution
451 * Define the compute program and parameters to be used by
452 * pipe_context::launch_grid.
454 void *(*create_compute_state
)(struct pipe_context
*context
,
455 const struct pipe_compute_state
*);
456 void (*bind_compute_state
)(struct pipe_context
*, void *);
457 void (*delete_compute_state
)(struct pipe_context
*, void *);
460 * Bind an array of shader resources that will be used by the
461 * compute program. Any resources that were previously bound to
462 * the specified range will be unbound after this call.
464 * \param start first resource to bind.
465 * \param count number of consecutive resources to bind.
466 * \param resources array of pointers to the resources to bind, it
467 * should contain at least \a count elements
468 * unless it's NULL, in which case no new
469 * resources will be bound.
471 void (*set_compute_resources
)(struct pipe_context
*,
472 unsigned start
, unsigned count
,
473 struct pipe_surface
**resources
);
476 * Bind an array of buffers to be mapped into the address space of
477 * the GLOBAL resource. Any buffers that were previously bound
478 * between [first, first + count - 1] are unbound after this call.
480 * \param first first buffer to map.
481 * \param count number of consecutive buffers to map.
482 * \param resources array of pointers to the buffers to map, it
483 * should contain at least \a count elements
484 * unless it's NULL, in which case no new
485 * resources will be bound.
486 * \param handles array of pointers to the memory locations that
487 * will be filled with the respective base
488 * addresses each buffer will be mapped to. It
489 * should contain at least \a count elements,
490 * unless \a resources is NULL in which case \a
491 * handles should be NULL as well.
493 * Note that the driver isn't required to make any guarantees about
494 * the contents of the \a handles array being valid anytime except
495 * during the subsequent calls to pipe_context::launch_grid. This
496 * means that the only sensible location handles[i] may point to is
497 * somewhere within the INPUT buffer itself. This is so to
498 * accommodate implementations that lack virtual memory but
499 * nevertheless migrate buffers on the fly, leading to resource
500 * base addresses that change on each kernel invocation or are
501 * unknown to the pipe driver.
503 void (*set_global_binding
)(struct pipe_context
*context
,
504 unsigned first
, unsigned count
,
505 struct pipe_resource
**resources
,
509 * Launch the compute kernel starting from instruction \a pc of the
510 * currently bound compute program.
512 * \a grid_layout and \a block_layout are arrays of size \a
513 * PIPE_COMPUTE_CAP_GRID_DIMENSION that determine the layout of the
514 * grid (in block units) and working block (in thread units) to be
515 * used, respectively.
517 * \a pc For drivers that use PIPE_SHADER_IR_LLVM as their prefered IR,
518 * this value will be the index of the kernel in the opencl.kernels
521 * \a input will be used to initialize the INPUT resource, and it
522 * should point to a buffer of at least
523 * pipe_compute_state::req_input_mem bytes.
525 void (*launch_grid
)(struct pipe_context
*context
,
526 const uint
*block_layout
, const uint
*grid_layout
,
527 uint32_t pc
, const void *input
);
531 * Get sample position for an individual sample point.
533 * \param sample_count - total number of samples
534 * \param sample_index - sample to get the position values for
535 * \param out_value - return value of 2 floats for x and y position for
538 void (*get_sample_position
)(struct pipe_context
*context
,
539 unsigned sample_count
,
540 unsigned sample_index
,
549 #endif /* PIPE_CONTEXT_H */