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"
40 struct pipe_blend_color
;
41 struct pipe_blend_state
;
43 struct pipe_clip_state
;
44 struct pipe_depth_stencil_alpha_state
;
45 struct pipe_draw_info
;
46 struct pipe_fence_handle
;
47 struct pipe_framebuffer_state
;
48 struct pipe_index_buffer
;
50 struct pipe_poly_stipple
;
51 struct pipe_rasterizer_state
;
52 struct pipe_resolve_info
;
54 struct pipe_sampler_state
;
55 struct pipe_sampler_view
;
56 struct pipe_scissor_state
;
57 struct pipe_shader_state
;
58 struct pipe_stencil_ref
;
59 struct pipe_stream_output_target
;
61 struct pipe_vertex_buffer
;
62 struct pipe_vertex_element
;
63 struct pipe_video_buffer
;
64 struct pipe_video_decoder
;
65 struct pipe_viewport_state
;
66 union pipe_color_union
;
69 * Gallium rendering context. Basically:
70 * - state setting functions
71 * - VBO drawing functions
75 struct pipe_winsys
*winsys
;
76 struct pipe_screen
*screen
;
78 void *priv
; /**< context private data (for DRI for example) */
79 void *draw
; /**< private, for draw module (temporary?) */
81 void (*destroy
)( struct pipe_context
* );
87 void (*draw_vbo
)( struct pipe_context
*pipe
,
88 const struct pipe_draw_info
*info
);
92 * Predicate subsequent rendering on occlusion query result
93 * \param query the query predicate, or NULL if no predicate
94 * \param mode one of PIPE_RENDER_COND_x
96 void (*render_condition
)( struct pipe_context
*pipe
,
97 struct pipe_query
*query
,
104 struct pipe_query
*(*create_query
)( struct pipe_context
*pipe
,
105 unsigned query_type
);
107 void (*destroy_query
)(struct pipe_context
*pipe
,
108 struct pipe_query
*q
);
110 void (*begin_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
111 void (*end_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
114 * Get results of a query.
115 * \param wait if true, this query will block until the result is ready
116 * \return TRUE if results are ready, FALSE otherwise
118 boolean (*get_query_result
)(struct pipe_context
*pipe
,
119 struct pipe_query
*q
,
125 * State functions (create/bind/destroy state objects)
128 void * (*create_blend_state
)(struct pipe_context
*,
129 const struct pipe_blend_state
*);
130 void (*bind_blend_state
)(struct pipe_context
*, void *);
131 void (*delete_blend_state
)(struct pipe_context
*, void *);
133 void * (*create_sampler_state
)(struct pipe_context
*,
134 const struct pipe_sampler_state
*);
135 void (*bind_fragment_sampler_states
)(struct pipe_context
*,
136 unsigned num_samplers
,
138 void (*bind_vertex_sampler_states
)(struct pipe_context
*,
139 unsigned num_samplers
,
141 void (*bind_geometry_sampler_states
)(struct pipe_context
*,
142 unsigned num_samplers
,
144 void (*delete_sampler_state
)(struct pipe_context
*, void *);
146 void * (*create_rasterizer_state
)(struct pipe_context
*,
147 const struct pipe_rasterizer_state
*);
148 void (*bind_rasterizer_state
)(struct pipe_context
*, void *);
149 void (*delete_rasterizer_state
)(struct pipe_context
*, void *);
151 void * (*create_depth_stencil_alpha_state
)(struct pipe_context
*,
152 const struct pipe_depth_stencil_alpha_state
*);
153 void (*bind_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
154 void (*delete_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
156 void * (*create_fs_state
)(struct pipe_context
*,
157 const struct pipe_shader_state
*);
158 void (*bind_fs_state
)(struct pipe_context
*, void *);
159 void (*delete_fs_state
)(struct pipe_context
*, void *);
161 void * (*create_vs_state
)(struct pipe_context
*,
162 const struct pipe_shader_state
*);
163 void (*bind_vs_state
)(struct pipe_context
*, void *);
164 void (*delete_vs_state
)(struct pipe_context
*, void *);
166 void * (*create_gs_state
)(struct pipe_context
*,
167 const struct pipe_shader_state
*);
168 void (*bind_gs_state
)(struct pipe_context
*, void *);
169 void (*delete_gs_state
)(struct pipe_context
*, void *);
171 void * (*create_vertex_elements_state
)(struct pipe_context
*,
172 unsigned num_elements
,
173 const struct pipe_vertex_element
*);
174 void (*bind_vertex_elements_state
)(struct pipe_context
*, void *);
175 void (*delete_vertex_elements_state
)(struct pipe_context
*, void *);
180 * Parameter-like state (or properties)
183 void (*set_blend_color
)( struct pipe_context
*,
184 const struct pipe_blend_color
* );
186 void (*set_stencil_ref
)( struct pipe_context
*,
187 const struct pipe_stencil_ref
* );
189 void (*set_sample_mask
)( struct pipe_context
*,
190 unsigned sample_mask
);
192 void (*set_clip_state
)( struct pipe_context
*,
193 const struct pipe_clip_state
* );
195 void (*set_constant_buffer
)( struct pipe_context
*,
196 uint shader
, uint index
,
197 struct pipe_resource
*buf
);
199 void (*set_framebuffer_state
)( struct pipe_context
*,
200 const struct pipe_framebuffer_state
* );
202 void (*set_polygon_stipple
)( struct pipe_context
*,
203 const struct pipe_poly_stipple
* );
205 void (*set_scissor_state
)( struct pipe_context
*,
206 const struct pipe_scissor_state
* );
208 void (*set_viewport_state
)( struct pipe_context
*,
209 const struct pipe_viewport_state
* );
211 void (*set_fragment_sampler_views
)(struct pipe_context
*,
213 struct pipe_sampler_view
**);
215 void (*set_vertex_sampler_views
)(struct pipe_context
*,
217 struct pipe_sampler_view
**);
219 void (*set_geometry_sampler_views
)(struct pipe_context
*,
221 struct pipe_sampler_view
**);
223 void (*set_vertex_buffers
)( struct pipe_context
*,
224 unsigned num_buffers
,
225 const struct pipe_vertex_buffer
* );
227 void (*set_index_buffer
)( struct pipe_context
*pipe
,
228 const struct pipe_index_buffer
* );
233 * Stream output functions.
237 struct pipe_stream_output_target
*(*create_stream_output_target
)(
238 struct pipe_context
*,
239 struct pipe_resource
*,
240 unsigned buffer_offset
,
241 unsigned buffer_size
);
243 void (*stream_output_target_destroy
)(struct pipe_context
*,
244 struct pipe_stream_output_target
*);
246 void (*set_stream_output_targets
)(struct pipe_context
*,
247 unsigned num_targets
,
248 struct pipe_stream_output_target
**targets
,
249 unsigned append_bitmask
);
255 * Resource functions for blit-like functionality
257 * If a driver supports multisampling, resource_resolve must be available.
262 * Copy a block of pixels from one resource to another.
263 * The resource must be of the same format.
264 * Resources with nr_samples > 1 are not allowed.
266 void (*resource_copy_region
)(struct pipe_context
*pipe
,
267 struct pipe_resource
*dst
,
269 unsigned dstx
, unsigned dsty
, unsigned dstz
,
270 struct pipe_resource
*src
,
272 const struct pipe_box
*src_box
);
275 * Resolve a multisampled resource into a non-multisampled one.
276 * Source and destination must be of the same format.
278 void (*resource_resolve
)(struct pipe_context
*pipe
,
279 const struct pipe_resolve_info
*info
);
284 * Clear the specified set of currently bound buffers to specified values.
285 * The entire buffers are cleared (no scissor, no colormask, etc).
287 * \param buffers bitfield of PIPE_CLEAR_* values.
288 * \param color pointer to a union of fiu array for each of r, g, b, a.
289 * \param depth depth clear value in [0,1].
290 * \param stencil stencil clear value
292 void (*clear
)(struct pipe_context
*pipe
,
294 const union pipe_color_union
*color
,
299 * Clear a color rendertarget surface.
300 * \param color pointer to an union of fiu array for each of r, g, b, a.
302 void (*clear_render_target
)(struct pipe_context
*pipe
,
303 struct pipe_surface
*dst
,
304 const union pipe_color_union
*color
,
305 unsigned dstx
, unsigned dsty
,
306 unsigned width
, unsigned height
);
309 * Clear a depth-stencil surface.
310 * \param clear_flags bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
311 * \param depth depth clear value in [0,1].
312 * \param stencil stencil clear value
314 void (*clear_depth_stencil
)(struct pipe_context
*pipe
,
315 struct pipe_surface
*dst
,
316 unsigned clear_flags
,
319 unsigned dstx
, unsigned dsty
,
320 unsigned width
, unsigned height
);
322 /** Flush draw commands
324 void (*flush
)( struct pipe_context
*pipe
,
325 struct pipe_fence_handle
**fence
);
328 * Create a view on a texture to be used by a shader stage.
330 struct pipe_sampler_view
* (*create_sampler_view
)(struct pipe_context
*ctx
,
331 struct pipe_resource
*texture
,
332 const struct pipe_sampler_view
*templat
);
334 void (*sampler_view_destroy
)(struct pipe_context
*ctx
,
335 struct pipe_sampler_view
*view
);
339 * Get a surface which is a "view" into a resource, used by
340 * render target / depth stencil stages.
341 * \param usage bitmaks of PIPE_BIND_* flags
343 struct pipe_surface
*(*create_surface
)(struct pipe_context
*ctx
,
344 struct pipe_resource
*resource
,
345 const struct pipe_surface
*templat
);
347 void (*surface_destroy
)(struct pipe_context
*ctx
,
348 struct pipe_surface
*);
351 * Get a transfer object for transferring data to/from a texture.
353 * Transfers are (by default) context-private and allow uploads to be
356 struct pipe_transfer
*(*get_transfer
)(struct pipe_context
*,
357 struct pipe_resource
*resource
,
359 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
360 const struct pipe_box
*);
362 void (*transfer_destroy
)(struct pipe_context
*,
363 struct pipe_transfer
*);
365 void *(*transfer_map
)( struct pipe_context
*,
366 struct pipe_transfer
*transfer
);
368 /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the
369 * regions specified with this call are guaranteed to be written to
372 void (*transfer_flush_region
)( struct pipe_context
*,
373 struct pipe_transfer
*transfer
,
374 const struct pipe_box
*);
376 void (*transfer_unmap
)( struct pipe_context
*,
377 struct pipe_transfer
*transfer
);
380 /* One-shot transfer operation with data supplied in a user
381 * pointer. XXX: strides??
383 void (*transfer_inline_write
)( struct pipe_context
*,
384 struct pipe_resource
*,
386 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
387 const struct pipe_box
*,
390 unsigned layer_stride
);
393 /* Notify a driver that a content of a user buffer has been changed.
394 * The changed range is [offset, offset+size-1].
395 * The new width0 of the buffer is offset+size. */
396 void (*redefine_user_buffer
)(struct pipe_context
*,
397 struct pipe_resource
*,
402 * Flush any pending framebuffer writes and invalidate texture caches.
404 void (*texture_barrier
)(struct pipe_context
*);
407 * Creates a video decoder for a specific video codec/profile
409 struct pipe_video_decoder
*(*create_video_decoder
)( struct pipe_context
*context
,
410 enum pipe_video_profile profile
,
411 enum pipe_video_entrypoint entrypoint
,
412 enum pipe_video_chroma_format chroma_format
,
413 unsigned width
, unsigned height
, unsigned max_references
,
414 bool expect_chunked_decode
);
417 * Creates a video buffer as decoding target
419 struct pipe_video_buffer
*(*create_video_buffer
)( struct pipe_context
*context
,
420 const struct pipe_video_buffer
*templat
);
428 #endif /* PIPE_CONTEXT_H */