Merge branch 'mesa_7_7_branch'
[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 /* Possible interface for setting edgeflags. These aren't really
62 * vertex elements, so don't fit there.
63 */
64 void (*set_edgeflags)( struct pipe_context *,
65 const unsigned *bitfield );
66
67
68 /**
69 * VBO drawing (return false on fallbacks (temporary??))
70 */
71 /*@{*/
72 boolean (*draw_arrays)( struct pipe_context *pipe,
73 unsigned mode, unsigned start, unsigned count);
74
75 boolean (*draw_elements)( struct pipe_context *pipe,
76 struct pipe_buffer *indexBuffer,
77 unsigned indexSize,
78 unsigned mode, unsigned start, unsigned count);
79
80 /* XXX: this is (probably) a temporary entrypoint, as the range
81 * information should be available from the vertex_buffer state.
82 * Using this to quickly evaluate a specialized path in the draw
83 * module.
84 */
85 boolean (*draw_range_elements)( struct pipe_context *pipe,
86 struct pipe_buffer *indexBuffer,
87 unsigned indexSize,
88 unsigned minIndex,
89 unsigned maxIndex,
90 unsigned mode,
91 unsigned start,
92 unsigned count);
93 /*@}*/
94
95
96 /**
97 * Query objects
98 */
99 /*@{*/
100 struct pipe_query *(*create_query)( struct pipe_context *pipe,
101 unsigned query_type );
102
103 void (*destroy_query)(struct pipe_context *pipe,
104 struct pipe_query *q);
105
106 void (*begin_query)(struct pipe_context *pipe, struct pipe_query *q);
107 void (*end_query)(struct pipe_context *pipe, struct pipe_query *q);
108
109 boolean (*get_query_result)(struct pipe_context *pipe,
110 struct pipe_query *q,
111 boolean wait,
112 uint64_t *result);
113 /*@}*/
114
115 /**
116 * State functions (create/bind/destroy state objects)
117 */
118 /*@{*/
119 void * (*create_blend_state)(struct pipe_context *,
120 const struct pipe_blend_state *);
121 void (*bind_blend_state)(struct pipe_context *, void *);
122 void (*delete_blend_state)(struct pipe_context *, void *);
123
124 void * (*create_sampler_state)(struct pipe_context *,
125 const struct pipe_sampler_state *);
126 void (*bind_fragment_sampler_states)(struct pipe_context *,
127 unsigned num_samplers,
128 void **samplers);
129 void (*bind_vertex_sampler_states)(struct pipe_context *,
130 unsigned num_samplers,
131 void **samplers);
132 void (*delete_sampler_state)(struct pipe_context *, void *);
133
134 void * (*create_rasterizer_state)(struct pipe_context *,
135 const struct pipe_rasterizer_state *);
136 void (*bind_rasterizer_state)(struct pipe_context *, void *);
137 void (*delete_rasterizer_state)(struct pipe_context *, void *);
138
139 void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
140 const struct pipe_depth_stencil_alpha_state *);
141 void (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
142 void (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
143
144 void * (*create_fs_state)(struct pipe_context *,
145 const struct pipe_shader_state *);
146 void (*bind_fs_state)(struct pipe_context *, void *);
147 void (*delete_fs_state)(struct pipe_context *, void *);
148
149 void * (*create_vs_state)(struct pipe_context *,
150 const struct pipe_shader_state *);
151 void (*bind_vs_state)(struct pipe_context *, void *);
152 void (*delete_vs_state)(struct pipe_context *, void *);
153 /*@}*/
154
155 /**
156 * Parameter-like state (or properties)
157 */
158 /*@{*/
159 void (*set_blend_color)( struct pipe_context *,
160 const struct pipe_blend_color * );
161
162 void (*set_clip_state)( struct pipe_context *,
163 const struct pipe_clip_state * );
164
165 void (*set_constant_buffer)( struct pipe_context *,
166 uint shader, uint index,
167 const struct pipe_constant_buffer *buf );
168
169 void (*set_framebuffer_state)( struct pipe_context *,
170 const struct pipe_framebuffer_state * );
171
172 void (*set_polygon_stipple)( struct pipe_context *,
173 const struct pipe_poly_stipple * );
174
175 void (*set_scissor_state)( struct pipe_context *,
176 const struct pipe_scissor_state * );
177
178 void (*set_viewport_state)( struct pipe_context *,
179 const struct pipe_viewport_state * );
180
181 void (*set_fragment_sampler_textures)(struct pipe_context *,
182 unsigned num_textures,
183 struct pipe_texture **);
184
185 void (*set_vertex_sampler_textures)(struct pipe_context *,
186 unsigned num_textures,
187 struct pipe_texture **);
188
189 void (*set_vertex_buffers)( struct pipe_context *,
190 unsigned num_buffers,
191 const struct pipe_vertex_buffer * );
192
193 void (*set_vertex_elements)( struct pipe_context *,
194 unsigned num_elements,
195 const struct pipe_vertex_element * );
196 /*@}*/
197
198
199 /**
200 * Surface functions
201 *
202 * The pipe driver is allowed to set these functions to NULL, and in that
203 * case, they will not be available.
204 */
205 /*@{*/
206
207 /**
208 * Copy a block of pixels from one surface to another.
209 * The surfaces must be of the same format.
210 */
211 void (*surface_copy)(struct pipe_context *pipe,
212 struct pipe_surface *dest,
213 unsigned destx, unsigned desty,
214 struct pipe_surface *src,
215 unsigned srcx, unsigned srcy,
216 unsigned width, unsigned height);
217
218 /**
219 * Fill a region of a surface with a constant value.
220 */
221 void (*surface_fill)(struct pipe_context *pipe,
222 struct pipe_surface *dst,
223 unsigned dstx, unsigned dsty,
224 unsigned width, unsigned height,
225 unsigned value);
226 /*@}*/
227
228 /**
229 * Clear the specified set of currently bound buffers to specified values.
230 * The entire buffers are cleared (no scissor, no colormask, etc).
231 *
232 * \param buffers bitfield of PIPE_CLEAR_* values.
233 * \param rgba pointer to an array of one float for each of r, g, b, a.
234 * \param depth depth clear value in [0,1].
235 * \param stencil stencil clear value
236 */
237 void (*clear)(struct pipe_context *pipe,
238 unsigned buffers,
239 const float *rgba,
240 double depth,
241 unsigned stencil);
242
243 /** Flush rendering
244 * \param flags bitmask of PIPE_FLUSH_x tokens)
245 */
246 void (*flush)( struct pipe_context *pipe,
247 unsigned flags,
248 struct pipe_fence_handle **fence );
249
250 /**
251 * Check whether a texture is referenced by an unflushed hw command.
252 * The state-tracker uses this function to optimize away unnecessary
253 * flushes. It is safe (but wasteful) to always return.
254 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
255 * \param pipe The pipe context whose unflushed hw commands will be
256 * checked.
257 * \param level mipmap level.
258 * \param texture texture to check.
259 * \param face cubemap face. Use 0 for non-cubemap texture.
260 */
261 unsigned int (*is_texture_referenced) (struct pipe_context *pipe,
262 struct pipe_texture *texture,
263 unsigned face, unsigned level);
264
265 /**
266 * Check whether a buffer is referenced by an unflushed hw command.
267 * The state-tracker uses this function to optimize away unnecessary
268 * flushes. It is safe (but wasteful) to always return
269 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
270 * \param pipe The pipe context whose unflushed hw commands will be
271 * checked.
272 * \param buf Buffer to check.
273 */
274 unsigned int (*is_buffer_referenced) (struct pipe_context *pipe,
275 struct pipe_buffer *buf);
276 };
277
278
279 #ifdef __cplusplus
280 }
281 #endif
282
283 #endif /* PIPE_CONTEXT_H */