Merge remote branch 'origin/opengl-es-v2'
[mesa.git] / src / gallium / include / pipe / p_context.h
1 /**************************************************************************
2 *
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
4 * All Rights Reserved.
5 *
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:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
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.
25 *
26 **************************************************************************/
27
28 #ifndef PIPE_CONTEXT_H
29 #define PIPE_CONTEXT_H
30
31 #include "p_state.h"
32
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38
39 struct pipe_screen;
40 struct pipe_fence_handle;
41 struct pipe_state_cache;
42 struct pipe_query;
43 struct pipe_winsys;
44
45 /**
46 * Gallium rendering context. Basically:
47 * - state setting functions
48 * - VBO drawing functions
49 * - surface functions
50 */
51 struct pipe_context {
52 struct pipe_winsys *winsys;
53 struct pipe_screen *screen;
54
55 void *priv; /**< context private data (for DRI for example) */
56 void *draw; /**< private, for draw module (temporary?) */
57
58 void (*destroy)( struct pipe_context * );
59
60 /**
61 * VBO drawing (return false on fallbacks (temporary??))
62 */
63 /*@{*/
64 void (*draw_arrays)( struct pipe_context *pipe,
65 unsigned mode, unsigned start, unsigned count);
66
67 void (*draw_elements)( struct pipe_context *pipe,
68 struct pipe_buffer *indexBuffer,
69 unsigned indexSize,
70 unsigned mode, unsigned start, unsigned count);
71
72 void (*draw_arrays_instanced)(struct pipe_context *pipe,
73 unsigned mode,
74 unsigned start,
75 unsigned count,
76 unsigned startInstance,
77 unsigned instanceCount);
78
79 void (*draw_elements_instanced)(struct pipe_context *pipe,
80 struct pipe_buffer *indexBuffer,
81 unsigned indexSize,
82 unsigned mode,
83 unsigned start,
84 unsigned count,
85 unsigned startInstance,
86 unsigned instanceCount);
87
88 /* XXX: this is (probably) a temporary entrypoint, as the range
89 * information should be available from the vertex_buffer state.
90 * Using this to quickly evaluate a specialized path in the draw
91 * module.
92 */
93 void (*draw_range_elements)( struct pipe_context *pipe,
94 struct pipe_buffer *indexBuffer,
95 unsigned indexSize,
96 unsigned minIndex,
97 unsigned maxIndex,
98 unsigned mode,
99 unsigned start,
100 unsigned count);
101 /*@}*/
102
103 /**
104 * Predicate subsequent rendering on occlusion query result
105 * \param query the query predicate, or NULL if no predicate
106 * \param mode one of PIPE_COND_RENDER_x
107 */
108 void (*render_condition)( struct pipe_context *pipe,
109 struct pipe_query *query,
110 uint mode );
111
112 /**
113 * Query objects
114 */
115 /*@{*/
116 struct pipe_query *(*create_query)( struct pipe_context *pipe,
117 unsigned query_type );
118
119 void (*destroy_query)(struct pipe_context *pipe,
120 struct pipe_query *q);
121
122 void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
123 void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
124
125 boolean (*get_query_result)(struct pipe_context *pipe,
126 struct pipe_query *q,
127 boolean wait,
128 uint64_t *result);
129 /*@}*/
130
131 /**
132 * State functions (create/bind/destroy state objects)
133 */
134 /*@{*/
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 *);
139
140 void * (*create_sampler_state)(struct pipe_context *,
141 const struct pipe_sampler_state *);
142 void (*bind_fragment_sampler_states)(struct pipe_context *,
143 unsigned num_samplers,
144 void **samplers);
145 void (*bind_vertex_sampler_states)(struct pipe_context *,
146 unsigned num_samplers,
147 void **samplers);
148 void (*delete_sampler_state)(struct pipe_context *, void *);
149
150 void * (*create_rasterizer_state)(struct pipe_context *,
151 const struct pipe_rasterizer_state *);
152 void (*bind_rasterizer_state)(struct pipe_context *, void *);
153 void (*delete_rasterizer_state)(struct pipe_context *, void *);
154
155 void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
156 const struct pipe_depth_stencil_alpha_state *);
157 void (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
158 void (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
159
160 void * (*create_fs_state)(struct pipe_context *,
161 const struct pipe_shader_state *);
162 void (*bind_fs_state)(struct pipe_context *, void *);
163 void (*delete_fs_state)(struct pipe_context *, void *);
164
165 void * (*create_vs_state)(struct pipe_context *,
166 const struct pipe_shader_state *);
167 void (*bind_vs_state)(struct pipe_context *, void *);
168 void (*delete_vs_state)(struct pipe_context *, void *);
169
170 void * (*create_gs_state)(struct pipe_context *,
171 const struct pipe_shader_state *);
172 void (*bind_gs_state)(struct pipe_context *, void *);
173 void (*delete_gs_state)(struct pipe_context *, void *);
174
175 /*@}*/
176
177 /**
178 * Parameter-like state (or properties)
179 */
180 /*@{*/
181 void (*set_blend_color)( struct pipe_context *,
182 const struct pipe_blend_color * );
183
184 void (*set_clip_state)( struct pipe_context *,
185 const struct pipe_clip_state * );
186
187 void (*set_constant_buffer)( struct pipe_context *,
188 uint shader, uint index,
189 struct pipe_buffer *buf );
190
191 void (*set_framebuffer_state)( struct pipe_context *,
192 const struct pipe_framebuffer_state * );
193
194 void (*set_polygon_stipple)( struct pipe_context *,
195 const struct pipe_poly_stipple * );
196
197 void (*set_scissor_state)( struct pipe_context *,
198 const struct pipe_scissor_state * );
199
200 void (*set_viewport_state)( struct pipe_context *,
201 const struct pipe_viewport_state * );
202
203 void (*set_fragment_sampler_textures)(struct pipe_context *,
204 unsigned num_textures,
205 struct pipe_texture **);
206
207 void (*set_vertex_sampler_textures)(struct pipe_context *,
208 unsigned num_textures,
209 struct pipe_texture **);
210
211 void (*set_vertex_buffers)( struct pipe_context *,
212 unsigned num_buffers,
213 const struct pipe_vertex_buffer * );
214
215 void (*set_vertex_elements)( struct pipe_context *,
216 unsigned num_elements,
217 const struct pipe_vertex_element * );
218 /*@}*/
219
220
221 /**
222 * Surface functions
223 *
224 * The pipe driver is allowed to set these functions to NULL, and in that
225 * case, they will not be available.
226 */
227 /*@{*/
228
229 /**
230 * Copy a block of pixels from one surface to another.
231 * The surfaces must be of the same format.
232 */
233 void (*surface_copy)(struct pipe_context *pipe,
234 struct pipe_surface *dest,
235 unsigned destx, unsigned desty,
236 struct pipe_surface *src,
237 unsigned srcx, unsigned srcy,
238 unsigned width, unsigned height);
239
240 /**
241 * Fill a region of a surface with a constant value.
242 */
243 void (*surface_fill)(struct pipe_context *pipe,
244 struct pipe_surface *dst,
245 unsigned dstx, unsigned dsty,
246 unsigned width, unsigned height,
247 unsigned value);
248 /*@}*/
249
250 /**
251 * Clear the specified set of currently bound buffers to specified values.
252 * The entire buffers are cleared (no scissor, no colormask, etc).
253 *
254 * \param buffers bitfield of PIPE_CLEAR_* values.
255 * \param rgba pointer to an array of one float for each of r, g, b, a.
256 * \param depth depth clear value in [0,1].
257 * \param stencil stencil clear value
258 */
259 void (*clear)(struct pipe_context *pipe,
260 unsigned buffers,
261 const float *rgba,
262 double depth,
263 unsigned stencil);
264
265 /** Flush rendering
266 * \param flags bitmask of PIPE_FLUSH_x tokens)
267 */
268 void (*flush)( struct pipe_context *pipe,
269 unsigned flags,
270 struct pipe_fence_handle **fence );
271
272 /**
273 * Check whether a texture is referenced by an unflushed hw command.
274 * The state-tracker uses this function to optimize away unnecessary
275 * flushes. It is safe (but wasteful) to always return.
276 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
277 * \param pipe The pipe context whose unflushed hw commands will be
278 * checked.
279 * \param level mipmap level.
280 * \param texture texture to check.
281 * \param face cubemap face. Use 0 for non-cubemap texture.
282 */
283 unsigned int (*is_texture_referenced) (struct pipe_context *pipe,
284 struct pipe_texture *texture,
285 unsigned face, unsigned level);
286
287 /**
288 * Check whether a buffer is referenced by an unflushed hw command.
289 * The state-tracker uses this function to optimize away unnecessary
290 * flushes. It is safe (but wasteful) to always return
291 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
292 * \param pipe The pipe context whose unflushed hw commands will be
293 * checked.
294 * \param buf Buffer to check.
295 */
296 unsigned int (*is_buffer_referenced) (struct pipe_context *pipe,
297 struct pipe_buffer *buf);
298 };
299
300
301 #ifdef __cplusplus
302 }
303 #endif
304
305 #endif /* PIPE_CONTEXT_H */