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_codec
;
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 condition whether to skip on FALSE or TRUE query results
100 * \param mode one of PIPE_RENDER_COND_x
102 void (*render_condition
)( struct pipe_context
*pipe
,
103 struct pipe_query
*query
,
111 struct pipe_query
*(*create_query
)( struct pipe_context
*pipe
,
112 unsigned query_type
);
114 void (*destroy_query
)(struct pipe_context
*pipe
,
115 struct pipe_query
*q
);
117 void (*begin_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
118 void (*end_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
121 * Get results of a query.
122 * \param wait if true, this query will block until the result is ready
123 * \return TRUE if results are ready, FALSE otherwise
125 boolean (*get_query_result
)(struct pipe_context
*pipe
,
126 struct pipe_query
*q
,
128 union pipe_query_result
*result
);
132 * State functions (create/bind/destroy state objects)
135 void * (*create_blend_state
)(struct pipe_context
*,
136 const struct pipe_blend_state
*);
137 void (*bind_blend_state
)(struct pipe_context
*, void *);
138 void (*delete_blend_state
)(struct pipe_context
*, void *);
140 void * (*create_sampler_state
)(struct pipe_context
*,
141 const struct pipe_sampler_state
*);
143 void (*bind_sampler_states
)(struct pipe_context
*,
144 unsigned shader
, unsigned start_slot
,
145 unsigned num_samplers
, void **samplers
);
147 void (*bind_fragment_sampler_states
)(struct pipe_context
*,
148 unsigned num_samplers
,
150 void (*bind_vertex_sampler_states
)(struct pipe_context
*,
151 unsigned num_samplers
,
153 void (*bind_geometry_sampler_states
)(struct pipe_context
*,
154 unsigned num_samplers
,
156 void (*bind_compute_sampler_states
)(struct pipe_context
*,
158 unsigned num_samplers
,
160 void (*delete_sampler_state
)(struct pipe_context
*, void *);
162 void * (*create_rasterizer_state
)(struct pipe_context
*,
163 const struct pipe_rasterizer_state
*);
164 void (*bind_rasterizer_state
)(struct pipe_context
*, void *);
165 void (*delete_rasterizer_state
)(struct pipe_context
*, void *);
167 void * (*create_depth_stencil_alpha_state
)(struct pipe_context
*,
168 const struct pipe_depth_stencil_alpha_state
*);
169 void (*bind_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
170 void (*delete_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
172 void * (*create_fs_state
)(struct pipe_context
*,
173 const struct pipe_shader_state
*);
174 void (*bind_fs_state
)(struct pipe_context
*, void *);
175 void (*delete_fs_state
)(struct pipe_context
*, void *);
177 void * (*create_vs_state
)(struct pipe_context
*,
178 const struct pipe_shader_state
*);
179 void (*bind_vs_state
)(struct pipe_context
*, void *);
180 void (*delete_vs_state
)(struct pipe_context
*, void *);
182 void * (*create_gs_state
)(struct pipe_context
*,
183 const struct pipe_shader_state
*);
184 void (*bind_gs_state
)(struct pipe_context
*, void *);
185 void (*delete_gs_state
)(struct pipe_context
*, void *);
187 void * (*create_vertex_elements_state
)(struct pipe_context
*,
188 unsigned num_elements
,
189 const struct pipe_vertex_element
*);
190 void (*bind_vertex_elements_state
)(struct pipe_context
*, void *);
191 void (*delete_vertex_elements_state
)(struct pipe_context
*, void *);
196 * Parameter-like state (or properties)
199 void (*set_blend_color
)( struct pipe_context
*,
200 const struct pipe_blend_color
* );
202 void (*set_stencil_ref
)( struct pipe_context
*,
203 const struct pipe_stencil_ref
* );
205 void (*set_sample_mask
)( struct pipe_context
*,
206 unsigned sample_mask
);
208 void (*set_clip_state
)( struct pipe_context
*,
209 const struct pipe_clip_state
* );
211 void (*set_constant_buffer
)( struct pipe_context
*,
212 uint shader
, uint index
,
213 struct pipe_constant_buffer
*buf
);
215 void (*set_framebuffer_state
)( struct pipe_context
*,
216 const struct pipe_framebuffer_state
* );
218 void (*set_polygon_stipple
)( struct pipe_context
*,
219 const struct pipe_poly_stipple
* );
221 void (*set_scissor_states
)( struct pipe_context
*,
223 unsigned num_scissors
,
224 const struct pipe_scissor_state
* );
226 void (*set_viewport_states
)( struct pipe_context
*,
228 unsigned num_viewports
,
229 const struct pipe_viewport_state
*);
231 void (*set_fragment_sampler_views
)(struct pipe_context
*,
233 struct pipe_sampler_view
**);
235 void (*set_vertex_sampler_views
)(struct pipe_context
*,
237 struct pipe_sampler_view
**);
239 void (*set_geometry_sampler_views
)(struct pipe_context
*,
241 struct pipe_sampler_view
**);
243 void (*set_compute_sampler_views
)(struct pipe_context
*,
244 unsigned start_slot
, unsigned num_views
,
245 struct pipe_sampler_view
**);
248 * Bind an array of shader resources that will be used by the
249 * graphics pipeline. Any resources that were previously bound to
250 * the specified range will be unbound after this call.
252 * \param start first resource to bind.
253 * \param count number of consecutive resources to bind.
254 * \param resources array of pointers to the resources to bind, it
255 * should contain at least \a count elements
256 * unless it's NULL, in which case no new
257 * resources will be bound.
259 void (*set_shader_resources
)(struct pipe_context
*,
260 unsigned start
, unsigned count
,
261 struct pipe_surface
**resources
);
263 void (*set_vertex_buffers
)( struct pipe_context
*,
265 unsigned num_buffers
,
266 const struct pipe_vertex_buffer
* );
268 void (*set_index_buffer
)( struct pipe_context
*pipe
,
269 const struct pipe_index_buffer
* );
274 * Stream output functions.
278 struct pipe_stream_output_target
*(*create_stream_output_target
)(
279 struct pipe_context
*,
280 struct pipe_resource
*,
281 unsigned buffer_offset
,
282 unsigned buffer_size
);
284 void (*stream_output_target_destroy
)(struct pipe_context
*,
285 struct pipe_stream_output_target
*);
287 void (*set_stream_output_targets
)(struct pipe_context
*,
288 unsigned num_targets
,
289 struct pipe_stream_output_target
**targets
,
290 unsigned append_bitmask
);
296 * Resource functions for blit-like functionality
298 * If a driver supports multisampling, blit must implement color resolve.
303 * Copy a block of pixels from one resource to another.
304 * The resource must be of the same format.
305 * Resources with nr_samples > 1 are not allowed.
307 void (*resource_copy_region
)(struct pipe_context
*pipe
,
308 struct pipe_resource
*dst
,
310 unsigned dstx
, unsigned dsty
, unsigned dstz
,
311 struct pipe_resource
*src
,
313 const struct pipe_box
*src_box
);
315 /* Optimal hardware path for blitting pixels.
316 * Scaling, format conversion, up- and downsampling (resolve) are allowed.
318 void (*blit
)(struct pipe_context
*pipe
,
319 const struct pipe_blit_info
*info
);
324 * Clear the specified set of currently bound buffers to specified values.
325 * The entire buffers are cleared (no scissor, no colormask, etc).
327 * \param buffers bitfield of PIPE_CLEAR_* values.
328 * \param color pointer to a union of fiu array for each of r, g, b, a.
329 * \param depth depth clear value in [0,1].
330 * \param stencil stencil clear value
332 void (*clear
)(struct pipe_context
*pipe
,
334 const union pipe_color_union
*color
,
339 * Clear a color rendertarget surface.
340 * \param color pointer to an union of fiu array for each of r, g, b, a.
342 void (*clear_render_target
)(struct pipe_context
*pipe
,
343 struct pipe_surface
*dst
,
344 const union pipe_color_union
*color
,
345 unsigned dstx
, unsigned dsty
,
346 unsigned width
, unsigned height
);
349 * Clear a depth-stencil surface.
350 * \param clear_flags bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
351 * \param depth depth clear value in [0,1].
352 * \param stencil stencil clear value
354 void (*clear_depth_stencil
)(struct pipe_context
*pipe
,
355 struct pipe_surface
*dst
,
356 unsigned clear_flags
,
359 unsigned dstx
, unsigned dsty
,
360 unsigned width
, unsigned height
);
362 /** Flush draw commands
364 * \param flags bitfield of enum pipe_flush_flags values.
366 void (*flush
)(struct pipe_context
*pipe
,
367 struct pipe_fence_handle
**fence
,
371 * Create a view on a texture to be used by a shader stage.
373 struct pipe_sampler_view
* (*create_sampler_view
)(struct pipe_context
*ctx
,
374 struct pipe_resource
*texture
,
375 const struct pipe_sampler_view
*templat
);
377 void (*sampler_view_destroy
)(struct pipe_context
*ctx
,
378 struct pipe_sampler_view
*view
);
382 * Get a surface which is a "view" into a resource, used by
383 * render target / depth stencil stages.
385 struct pipe_surface
*(*create_surface
)(struct pipe_context
*ctx
,
386 struct pipe_resource
*resource
,
387 const struct pipe_surface
*templat
);
389 void (*surface_destroy
)(struct pipe_context
*ctx
,
390 struct pipe_surface
*);
395 * Transfers are (by default) context-private and allow uploads to be
396 * interleaved with rendering.
398 * out_transfer will contain the transfer object that must be passed
399 * to all the other transfer functions. It also contains useful
400 * information (like texture strides).
402 void *(*transfer_map
)(struct pipe_context
*,
403 struct pipe_resource
*resource
,
405 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
406 const struct pipe_box
*,
407 struct pipe_transfer
**out_transfer
);
409 /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the
410 * regions specified with this call are guaranteed to be written to
413 void (*transfer_flush_region
)( struct pipe_context
*,
414 struct pipe_transfer
*transfer
,
415 const struct pipe_box
*);
417 void (*transfer_unmap
)(struct pipe_context
*,
418 struct pipe_transfer
*transfer
);
420 /* One-shot transfer operation with data supplied in a user
421 * pointer. XXX: strides??
423 void (*transfer_inline_write
)( struct pipe_context
*,
424 struct pipe_resource
*,
426 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
427 const struct pipe_box
*,
430 unsigned layer_stride
);
433 * Flush any pending framebuffer writes and invalidate texture caches.
435 void (*texture_barrier
)(struct pipe_context
*);
438 * Creates a video codec for a specific video format/profile
440 struct pipe_video_codec
*(*create_video_codec
)( struct pipe_context
*context
,
441 const struct pipe_video_codec
*templat
);
444 * Creates a video buffer as decoding target
446 struct pipe_video_buffer
*(*create_video_buffer
)( struct pipe_context
*context
,
447 const struct pipe_video_buffer
*templat
);
450 * Compute kernel execution
454 * Define the compute program and parameters to be used by
455 * pipe_context::launch_grid.
457 void *(*create_compute_state
)(struct pipe_context
*context
,
458 const struct pipe_compute_state
*);
459 void (*bind_compute_state
)(struct pipe_context
*, void *);
460 void (*delete_compute_state
)(struct pipe_context
*, void *);
463 * Bind an array of shader resources that will be used by the
464 * compute program. Any resources that were previously bound to
465 * the specified range will be unbound after this call.
467 * \param start first resource to bind.
468 * \param count number of consecutive resources to bind.
469 * \param resources array of pointers to the resources to bind, it
470 * should contain at least \a count elements
471 * unless it's NULL, in which case no new
472 * resources will be bound.
474 void (*set_compute_resources
)(struct pipe_context
*,
475 unsigned start
, unsigned count
,
476 struct pipe_surface
**resources
);
479 * Bind an array of buffers to be mapped into the address space of
480 * the GLOBAL resource. Any buffers that were previously bound
481 * between [first, first + count - 1] are unbound after this call.
483 * \param first first buffer to map.
484 * \param count number of consecutive buffers to map.
485 * \param resources array of pointers to the buffers to map, it
486 * should contain at least \a count elements
487 * unless it's NULL, in which case no new
488 * resources will be bound.
489 * \param handles array of pointers to the memory locations that
490 * will be filled with the respective base
491 * addresses each buffer will be mapped to. It
492 * should contain at least \a count elements,
493 * unless \a resources is NULL in which case \a
494 * handles should be NULL as well.
496 * Note that the driver isn't required to make any guarantees about
497 * the contents of the \a handles array being valid anytime except
498 * during the subsequent calls to pipe_context::launch_grid. This
499 * means that the only sensible location handles[i] may point to is
500 * somewhere within the INPUT buffer itself. This is so to
501 * accommodate implementations that lack virtual memory but
502 * nevertheless migrate buffers on the fly, leading to resource
503 * base addresses that change on each kernel invocation or are
504 * unknown to the pipe driver.
506 void (*set_global_binding
)(struct pipe_context
*context
,
507 unsigned first
, unsigned count
,
508 struct pipe_resource
**resources
,
512 * Launch the compute kernel starting from instruction \a pc of the
513 * currently bound compute program.
515 * \a grid_layout and \a block_layout are arrays of size \a
516 * PIPE_COMPUTE_CAP_GRID_DIMENSION that determine the layout of the
517 * grid (in block units) and working block (in thread units) to be
518 * used, respectively.
520 * \a pc For drivers that use PIPE_SHADER_IR_LLVM as their prefered IR,
521 * this value will be the index of the kernel in the opencl.kernels
524 * \a input will be used to initialize the INPUT resource, and it
525 * should point to a buffer of at least
526 * pipe_compute_state::req_input_mem bytes.
528 void (*launch_grid
)(struct pipe_context
*context
,
529 const uint
*block_layout
, const uint
*grid_layout
,
530 uint32_t pc
, const void *input
);
534 * Get sample position for an individual sample point.
536 * \param sample_count - total number of samples
537 * \param sample_index - sample to get the position values for
538 * \param out_value - return value of 2 floats for x and y position for
541 void (*get_sample_position
)(struct pipe_context
*context
,
542 unsigned sample_count
,
543 unsigned sample_index
,
547 * Flush the resource cache, so that the resource can be used
548 * by an external client. Possible usage:
549 * - flushing a resource before presenting it on the screen
550 * - flushing a resource if some other process or device wants to use it
551 * This shouldn't be used to flush caches if the resource is only managed
552 * by a single pipe_screen and is not shared with another process.
553 * (i.e. you shouldn't use it to flush caches explicitly if you want to e.g.
554 * use the resource for texturing)
556 void (*flush_resource
)(struct pipe_context
*ctx
,
557 struct pipe_resource
*resource
);
565 #endif /* PIPE_CONTEXT_H */