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"
38 struct pipe_blend_color
;
39 struct pipe_blend_state
;
41 struct pipe_clip_state
;
42 struct pipe_depth_stencil_alpha_state
;
43 struct pipe_draw_info
;
44 struct pipe_fence_handle
;
45 struct pipe_framebuffer_state
;
46 struct pipe_index_buffer
;
48 struct pipe_poly_stipple
;
49 struct pipe_rasterizer_state
;
51 struct pipe_sampler_state
;
52 struct pipe_sampler_view
;
53 struct pipe_scissor_state
;
54 struct pipe_shader_state
;
55 struct pipe_stencil_ref
;
56 struct pipe_stream_output_state
;
57 struct pipe_subresource
;
59 struct pipe_vertex_buffer
;
60 struct pipe_vertex_element
;
61 struct pipe_viewport_state
;
64 * Gallium rendering context. Basically:
65 * - state setting functions
66 * - VBO drawing functions
70 struct pipe_winsys
*winsys
;
71 struct pipe_screen
*screen
;
73 void *priv
; /**< context private data (for DRI for example) */
74 void *draw
; /**< private, for draw module (temporary?) */
76 void (*destroy
)( struct pipe_context
* );
82 void (*draw_vbo
)( struct pipe_context
*pipe
,
83 const struct pipe_draw_info
*info
);
86 * Draw the stream output buffer at index 0
88 void (*draw_stream_output
)( struct pipe_context
*pipe
, unsigned mode
);
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 *);
177 void * (*create_stream_output_state
)(struct pipe_context
*,
178 const struct pipe_stream_output_state
*);
179 void (*bind_stream_output_state
)(struct pipe_context
*, void *);
180 void (*delete_stream_output_state
)(struct pipe_context
*, void*);
185 * Parameter-like state (or properties)
188 void (*set_blend_color
)( struct pipe_context
*,
189 const struct pipe_blend_color
* );
191 void (*set_stencil_ref
)( struct pipe_context
*,
192 const struct pipe_stencil_ref
* );
194 void (*set_sample_mask
)( struct pipe_context
*,
195 unsigned sample_mask
);
197 void (*set_clip_state
)( struct pipe_context
*,
198 const struct pipe_clip_state
* );
200 void (*set_constant_buffer
)( struct pipe_context
*,
201 uint shader
, uint index
,
202 struct pipe_resource
*buf
);
204 void (*set_framebuffer_state
)( struct pipe_context
*,
205 const struct pipe_framebuffer_state
* );
207 void (*set_polygon_stipple
)( struct pipe_context
*,
208 const struct pipe_poly_stipple
* );
210 void (*set_scissor_state
)( struct pipe_context
*,
211 const struct pipe_scissor_state
* );
213 void (*set_viewport_state
)( struct pipe_context
*,
214 const struct pipe_viewport_state
* );
216 void (*set_fragment_sampler_views
)(struct pipe_context
*,
218 struct pipe_sampler_view
**);
220 void (*set_vertex_sampler_views
)(struct pipe_context
*,
222 struct pipe_sampler_view
**);
224 void (*set_geometry_sampler_views
)(struct pipe_context
*,
226 struct pipe_sampler_view
**);
228 void (*set_vertex_buffers
)( struct pipe_context
*,
229 unsigned num_buffers
,
230 const struct pipe_vertex_buffer
* );
232 void (*set_index_buffer
)( struct pipe_context
*pipe
,
233 const struct pipe_index_buffer
* );
235 void (*set_stream_output_buffers
)(struct pipe_context
*,
236 struct pipe_resource
**buffers
,
237 int *offsets
, /*array of offsets
238 from the start of each
246 * Resource functions for blit-like functionality
248 * If a driver supports multisampling, resource_resolve must be available.
253 * Copy a block of pixels from one resource to another.
254 * The resource must be of the same format.
255 * Resources with nr_samples > 1 are not allowed.
257 void (*resource_copy_region
)(struct pipe_context
*pipe
,
258 struct pipe_resource
*dst
,
259 struct pipe_subresource subdst
,
260 unsigned dstx
, unsigned dsty
, unsigned dstz
,
261 struct pipe_resource
*src
,
262 struct pipe_subresource subsrc
,
263 unsigned srcx
, unsigned srcy
, unsigned srcz
,
264 unsigned width
, unsigned height
);
267 * Resolve a multisampled resource into a non-multisampled one.
268 * Source and destination must have the same size and same format.
270 void (*resource_resolve
)(struct pipe_context
*pipe
,
271 struct pipe_resource
*dst
,
272 struct pipe_subresource subdst
,
273 struct pipe_resource
*src
,
274 struct pipe_subresource subsrc
);
279 * Clear the specified set of currently bound buffers to specified values.
280 * The entire buffers are cleared (no scissor, no colormask, etc).
282 * \param buffers bitfield of PIPE_CLEAR_* values.
283 * \param rgba pointer to an array of one float for each of r, g, b, a.
284 * \param depth depth clear value in [0,1].
285 * \param stencil stencil clear value
287 void (*clear
)(struct pipe_context
*pipe
,
294 * Clear a color rendertarget surface.
295 * \param rgba pointer to an array of one float for each of r, g, b, a.
297 void (*clear_render_target
)(struct pipe_context
*pipe
,
298 struct pipe_surface
*dst
,
300 unsigned dstx
, unsigned dsty
,
301 unsigned width
, unsigned height
);
304 * Clear a depth-stencil surface.
305 * \param clear_flags bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
306 * \param depth depth clear value in [0,1].
307 * \param stencil stencil clear value
309 void (*clear_depth_stencil
)(struct pipe_context
*pipe
,
310 struct pipe_surface
*dst
,
311 unsigned clear_flags
,
314 unsigned dstx
, unsigned dsty
,
315 unsigned width
, unsigned height
);
318 * \param flags bitmask of PIPE_FLUSH_x tokens)
320 void (*flush
)( struct pipe_context
*pipe
,
322 struct pipe_fence_handle
**fence
);
325 * Check whether a texture is referenced by an unflushed hw command.
326 * The state-tracker uses this function to avoid unnecessary flushes.
327 * It is safe (but wasteful) to always return
328 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
329 * \param pipe context whose unflushed hw commands will be checked.
330 * \param texture texture to check.
331 * \param face cubemap face. Use 0 for non-cubemap texture.
332 * \param level mipmap level.
333 * \return mask of PIPE_REFERENCED_FOR_READ/WRITE or PIPE_UNREFERENCED
335 unsigned int (*is_resource_referenced
)(struct pipe_context
*pipe
,
336 struct pipe_resource
*texture
,
337 unsigned face
, unsigned level
);
340 * Create a view on a texture to be used by a shader stage.
342 struct pipe_sampler_view
* (*create_sampler_view
)(struct pipe_context
*ctx
,
343 struct pipe_resource
*texture
,
344 const struct pipe_sampler_view
*templat
);
346 void (*sampler_view_destroy
)(struct pipe_context
*ctx
,
347 struct pipe_sampler_view
*view
);
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
,
358 struct pipe_subresource
,
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
*,
385 struct pipe_subresource
,
386 unsigned usage
, /* a combination of PIPE_TRANSFER_x */
387 const struct pipe_box
*,
390 unsigned slice_stride
);
399 #endif /* PIPE_CONTEXT_H */