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
40 struct pipe_fence_handle;
41 struct pipe_state_cache;
46 * Gallium rendering context. Basically:
47 * - state setting functions
48 * - VBO drawing functions
52 struct pipe_winsys *winsys;
53 struct pipe_screen *screen;
55 void *priv; /**< context private data (for DRI for example) */
56 void *draw; /**< private, for draw module (temporary?) */
58 void (*destroy)( struct pipe_context * );
64 void (*draw_arrays)( struct pipe_context *pipe,
65 unsigned mode, unsigned start, unsigned count);
67 void (*draw_elements)( struct pipe_context *pipe,
68 struct pipe_resource *indexBuffer,
71 unsigned mode, unsigned start, unsigned count);
73 void (*draw_arrays_instanced)(struct pipe_context *pipe,
77 unsigned startInstance,
78 unsigned instanceCount);
80 void (*draw_elements_instanced)(struct pipe_context *pipe,
81 struct pipe_resource *indexBuffer,
87 unsigned startInstance,
88 unsigned instanceCount);
90 /* XXX: this is (probably) a temporary entrypoint, as the range
91 * information should be available from the vertex_buffer state.
92 * Using this to quickly evaluate a specialized path in the draw
95 void (*draw_range_elements)( struct pipe_context *pipe,
96 struct pipe_resource *indexBuffer,
107 * Predicate subsequent rendering on occlusion query result
108 * \param query the query predicate, or NULL if no predicate
109 * \param mode one of PIPE_RENDER_COND_x
111 void (*render_condition)( struct pipe_context *pipe,
112 struct pipe_query *query,
119 struct pipe_query *(*create_query)( struct pipe_context *pipe,
120 unsigned query_type );
122 void (*destroy_query)(struct pipe_context *pipe,
123 struct pipe_query *q);
125 void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
126 void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
129 * Get results of a query.
130 * \param wait if true, this query will block until the result is ready
131 * \return TRUE if results are ready, FALSE otherwise
133 boolean (*get_query_result)(struct pipe_context *pipe,
134 struct pipe_query *q,
140 * State functions (create/bind/destroy state objects)
143 void * (*create_blend_state)(struct pipe_context *,
144 const struct pipe_blend_state *);
145 void (*bind_blend_state)(struct pipe_context *, void *);
146 void (*delete_blend_state)(struct pipe_context *, void *);
148 void * (*create_sampler_state)(struct pipe_context *,
149 const struct pipe_sampler_state *);
150 void (*bind_fragment_sampler_states)(struct pipe_context *,
151 unsigned num_samplers,
153 void (*bind_vertex_sampler_states)(struct pipe_context *,
154 unsigned num_samplers,
156 void (*delete_sampler_state)(struct pipe_context *, void *);
158 void * (*create_rasterizer_state)(struct pipe_context *,
159 const struct pipe_rasterizer_state *);
160 void (*bind_rasterizer_state)(struct pipe_context *, void *);
161 void (*delete_rasterizer_state)(struct pipe_context *, void *);
163 void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
164 const struct pipe_depth_stencil_alpha_state *);
165 void (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
166 void (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
168 void * (*create_fs_state)(struct pipe_context *,
169 const struct pipe_shader_state *);
170 void (*bind_fs_state)(struct pipe_context *, void *);
171 void (*delete_fs_state)(struct pipe_context *, void *);
173 void * (*create_vs_state)(struct pipe_context *,
174 const struct pipe_shader_state *);
175 void (*bind_vs_state)(struct pipe_context *, void *);
176 void (*delete_vs_state)(struct pipe_context *, void *);
178 void * (*create_gs_state)(struct pipe_context *,
179 const struct pipe_shader_state *);
180 void (*bind_gs_state)(struct pipe_context *, void *);
181 void (*delete_gs_state)(struct pipe_context *, void *);
183 void * (*create_vertex_elements_state)(struct pipe_context *,
184 unsigned num_elements,
185 const struct pipe_vertex_element *);
186 void (*bind_vertex_elements_state)(struct pipe_context *, void *);
187 void (*delete_vertex_elements_state)(struct pipe_context *, void *);
192 * Parameter-like state (or properties)
195 void (*set_blend_color)( struct pipe_context *,
196 const struct pipe_blend_color * );
198 void (*set_stencil_ref)( struct pipe_context *,
199 const struct pipe_stencil_ref * );
201 void (*set_sample_mask)( struct pipe_context *,
202 unsigned sample_mask );
204 void (*set_clip_state)( struct pipe_context *,
205 const struct pipe_clip_state * );
207 void (*set_constant_buffer)( struct pipe_context *,
208 uint shader, uint index,
209 struct pipe_resource *buf );
211 void (*set_framebuffer_state)( struct pipe_context *,
212 const struct pipe_framebuffer_state * );
214 void (*set_polygon_stipple)( struct pipe_context *,
215 const struct pipe_poly_stipple * );
217 void (*set_scissor_state)( struct pipe_context *,
218 const struct pipe_scissor_state * );
220 void (*set_viewport_state)( struct pipe_context *,
221 const struct pipe_viewport_state * );
223 void (*set_fragment_sampler_views)(struct pipe_context *,
225 struct pipe_sampler_view **);
227 void (*set_vertex_sampler_views)(struct pipe_context *,
229 struct pipe_sampler_view **);
231 void (*set_vertex_buffers)( struct pipe_context *,
232 unsigned num_buffers,
233 const struct pipe_vertex_buffer * );
239 * Resource functions for blit-like functionality
241 * If a driver supports multisampling, resource_resolve must be available.
246 * Copy a block of pixels from one resource to another.
247 * The resource must be of the same format.
248 * Resources with nr_samples > 1 are not allowed.
250 void (*resource_copy_region)(struct pipe_context *pipe,
251 struct pipe_resource *dst,
252 struct pipe_subresource subdst,
253 unsigned dstx, unsigned dsty, unsigned dstz,
254 struct pipe_resource *src,
255 struct pipe_subresource subsrc,
256 unsigned srcx, unsigned srcy, unsigned srcz,
257 unsigned width, unsigned height);
260 * Resolve a multisampled resource into a non-multisampled one.
261 * Source and destination must have the same size and same format.
263 void (*resource_resolve)(struct pipe_context *pipe,
264 struct pipe_resource *dst,
265 struct pipe_subresource subdst,
266 struct pipe_resource *src,
267 struct pipe_subresource subsrc);
272 * Clear the specified set of currently bound buffers to specified values.
273 * The entire buffers are cleared (no scissor, no colormask, etc).
275 * \param buffers bitfield of PIPE_CLEAR_* values.
276 * \param rgba pointer to an array of one float for each of r, g, b, a.
277 * \param depth depth clear value in [0,1].
278 * \param stencil stencil clear value
280 void (*clear)(struct pipe_context *pipe,
287 * Clear a color rendertarget surface.
288 * \param rgba pointer to an array of one float for each of r, g, b, a.
290 void (*clear_render_target)(struct pipe_context *pipe,
291 struct pipe_surface *dst,
293 unsigned dstx, unsigned dsty,
294 unsigned width, unsigned height);
297 * Clear a depth-stencil surface.
298 * \param clear_flags bitfield of PIPE_CLEAR_DEPTH/STENCIL values.
299 * \param depth depth clear value in [0,1].
300 * \param stencil stencil clear value
302 void (*clear_depth_stencil)(struct pipe_context *pipe,
303 struct pipe_surface *dst,
304 unsigned clear_flags,
307 unsigned dstx, unsigned dsty,
308 unsigned width, unsigned height);
311 * \param flags bitmask of PIPE_FLUSH_x tokens)
313 void (*flush)( struct pipe_context *pipe,
315 struct pipe_fence_handle **fence );
318 * Check whether a texture is referenced by an unflushed hw command.
319 * The state-tracker uses this function to avoid unnecessary flushes.
320 * It is safe (but wasteful) to always return
321 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
322 * \param pipe context whose unflushed hw commands will be checked.
323 * \param texture texture to check.
324 * \param face cubemap face. Use 0 for non-cubemap texture.
325 * \param level mipmap level.
326 * \return mask of PIPE_REFERENCED_FOR_READ/WRITE or PIPE_UNREFERENCED
328 unsigned int (*is_resource_referenced)(struct pipe_context *pipe,
329 struct pipe_resource *texture,
330 unsigned face, unsigned level);
333 * Create a view on a texture to be used by a shader stage.
335 struct pipe_sampler_view * (*create_sampler_view)(struct pipe_context *ctx,
336 struct pipe_resource *texture,
337 const struct pipe_sampler_view *templat);
339 void (*sampler_view_destroy)(struct pipe_context *ctx,
340 struct pipe_sampler_view *view);
344 * Get a transfer object for transferring data to/from a texture.
346 * Transfers are (by default) context-private and allow uploads to be
349 struct pipe_transfer *(*get_transfer)(struct pipe_context *,
350 struct pipe_resource *resource,
351 struct pipe_subresource,
352 unsigned usage, /* a combination of PIPE_TRANSFER_x */
353 const struct pipe_box *);
355 void (*transfer_destroy)(struct pipe_context *,
356 struct pipe_transfer *);
358 void *(*transfer_map)( struct pipe_context *,
359 struct pipe_transfer *transfer );
361 /* If transfer was created with WRITE|FLUSH_EXPLICIT, only the
362 * regions specified with this call are guaranteed to be written to
365 void (*transfer_flush_region)( struct pipe_context *,
366 struct pipe_transfer *transfer,
367 const struct pipe_box *);
369 void (*transfer_unmap)( struct pipe_context *,
370 struct pipe_transfer *transfer );
373 /* One-shot transfer operation with data supplied in a user
374 * pointer. XXX: strides??
376 void (*transfer_inline_write)( struct pipe_context *,
377 struct pipe_resource *,
378 struct pipe_subresource,
379 unsigned usage, /* a combination of PIPE_TRANSFER_x */
380 const struct pipe_box *,
383 unsigned slice_stride);
392 #endif /* PIPE_CONTEXT_H */