gallium: WIP: Introduce sampler views.
[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_RENDER_COND_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 /**
126 * Get results of a query.
127 * \param wait if true, this query will block until the result is ready
128 * \return TRUE if results are ready, FALSE otherwise
129 */
130 boolean (*get_query_result)(struct pipe_context *pipe,
131 struct pipe_query *q,
132 boolean wait,
133 uint64_t *result);
134 /*@}*/
135
136 /**
137 * State functions (create/bind/destroy state objects)
138 */
139 /*@{*/
140 void * (*create_blend_state)(struct pipe_context *,
141 const struct pipe_blend_state *);
142 void (*bind_blend_state)(struct pipe_context *, void *);
143 void (*delete_blend_state)(struct pipe_context *, void *);
144
145 void * (*create_sampler_state)(struct pipe_context *,
146 const struct pipe_sampler_state *);
147 void (*bind_fragment_sampler_states)(struct pipe_context *,
148 unsigned num_samplers,
149 void **samplers);
150 void (*bind_vertex_sampler_states)(struct pipe_context *,
151 unsigned num_samplers,
152 void **samplers);
153 void (*delete_sampler_state)(struct pipe_context *, void *);
154
155 void * (*create_rasterizer_state)(struct pipe_context *,
156 const struct pipe_rasterizer_state *);
157 void (*bind_rasterizer_state)(struct pipe_context *, void *);
158 void (*delete_rasterizer_state)(struct pipe_context *, void *);
159
160 void * (*create_depth_stencil_alpha_state)(struct pipe_context *,
161 const struct pipe_depth_stencil_alpha_state *);
162 void (*bind_depth_stencil_alpha_state)(struct pipe_context *, void *);
163 void (*delete_depth_stencil_alpha_state)(struct pipe_context *, void *);
164
165 void * (*create_fs_state)(struct pipe_context *,
166 const struct pipe_shader_state *);
167 void (*bind_fs_state)(struct pipe_context *, void *);
168 void (*delete_fs_state)(struct pipe_context *, void *);
169
170 void * (*create_vs_state)(struct pipe_context *,
171 const struct pipe_shader_state *);
172 void (*bind_vs_state)(struct pipe_context *, void *);
173 void (*delete_vs_state)(struct pipe_context *, void *);
174
175 void * (*create_gs_state)(struct pipe_context *,
176 const struct pipe_shader_state *);
177 void (*bind_gs_state)(struct pipe_context *, void *);
178 void (*delete_gs_state)(struct pipe_context *, void *);
179
180 /*@}*/
181
182 /**
183 * Parameter-like state (or properties)
184 */
185 /*@{*/
186 void (*set_blend_color)( struct pipe_context *,
187 const struct pipe_blend_color * );
188
189 void (*set_stencil_ref)( struct pipe_context *,
190 const struct pipe_stencil_ref * );
191
192 void (*set_clip_state)( struct pipe_context *,
193 const struct pipe_clip_state * );
194
195 void (*set_constant_buffer)( struct pipe_context *,
196 uint shader, uint index,
197 struct pipe_buffer *buf );
198
199 void (*set_framebuffer_state)( struct pipe_context *,
200 const struct pipe_framebuffer_state * );
201
202 void (*set_polygon_stipple)( struct pipe_context *,
203 const struct pipe_poly_stipple * );
204
205 void (*set_scissor_state)( struct pipe_context *,
206 const struct pipe_scissor_state * );
207
208 void (*set_viewport_state)( struct pipe_context *,
209 const struct pipe_viewport_state * );
210
211 void (*set_fragment_sampler_views)(struct pipe_context *,
212 unsigned num_views,
213 struct pipe_sampler_view **);
214
215 void (*set_vertex_sampler_views)(struct pipe_context *,
216 unsigned num_views,
217 struct pipe_sampler_view **);
218
219 void (*set_vertex_buffers)( struct pipe_context *,
220 unsigned num_buffers,
221 const struct pipe_vertex_buffer * );
222
223 void (*set_vertex_elements)( struct pipe_context *,
224 unsigned num_elements,
225 const struct pipe_vertex_element * );
226 /*@}*/
227
228
229 /**
230 * Surface functions
231 *
232 * The pipe driver is allowed to set these functions to NULL, and in that
233 * case, they will not be available.
234 */
235 /*@{*/
236
237 /**
238 * Copy a block of pixels from one surface to another.
239 * The surfaces must be of the same format.
240 */
241 void (*surface_copy)(struct pipe_context *pipe,
242 struct pipe_surface *dest,
243 unsigned destx, unsigned desty,
244 struct pipe_surface *src,
245 unsigned srcx, unsigned srcy,
246 unsigned width, unsigned height);
247
248 /**
249 * Fill a region of a surface with a constant value.
250 */
251 void (*surface_fill)(struct pipe_context *pipe,
252 struct pipe_surface *dst,
253 unsigned dstx, unsigned dsty,
254 unsigned width, unsigned height,
255 unsigned value);
256 /*@}*/
257
258 /**
259 * Clear the specified set of currently bound buffers to specified values.
260 * The entire buffers are cleared (no scissor, no colormask, etc).
261 *
262 * \param buffers bitfield of PIPE_CLEAR_* values.
263 * \param rgba pointer to an array of one float for each of r, g, b, a.
264 * \param depth depth clear value in [0,1].
265 * \param stencil stencil clear value
266 */
267 void (*clear)(struct pipe_context *pipe,
268 unsigned buffers,
269 const float *rgba,
270 double depth,
271 unsigned stencil);
272
273 /** Flush rendering
274 * \param flags bitmask of PIPE_FLUSH_x tokens)
275 */
276 void (*flush)( struct pipe_context *pipe,
277 unsigned flags,
278 struct pipe_fence_handle **fence );
279
280 /**
281 * Check whether a texture is referenced by an unflushed hw command.
282 * The state-tracker uses this function to avoid unnecessary flushes.
283 * It is safe (but wasteful) to always return
284 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
285 * \param pipe context whose unflushed hw commands will be checked.
286 * \param texture texture to check.
287 * \param face cubemap face. Use 0 for non-cubemap texture.
288 * \param level mipmap level.
289 * \return mask of PIPE_REFERENCED_FOR_READ/WRITE or PIPE_UNREFERENCED
290 */
291 unsigned int (*is_texture_referenced)(struct pipe_context *pipe,
292 struct pipe_texture *texture,
293 unsigned face, unsigned level);
294
295 /**
296 * Check whether a buffer is referenced by an unflushed hw command.
297 * The state-tracker uses this function to avoid unnecessary flushes.
298 * It is safe (but wasteful) to always return
299 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
300 * \param pipe context whose unflushed hw commands will be checked.
301 * \param buf buffer to check.
302 * \return mask of PIPE_REFERENCED_FOR_READ/WRITE or PIPE_UNREFERENCED
303 */
304 unsigned int (*is_buffer_referenced)(struct pipe_context *pipe,
305 struct pipe_buffer *buf);
306
307 /**
308 * Create a view on a texture to be used by a shader stage.
309 */
310 struct pipe_sampler_view * (*create_sampler_view)(struct pipe_context *ctx,
311 struct pipe_texture *texture,
312 const struct pipe_sampler_view *templat);
313
314 void (*sampler_view_destroy)(struct pipe_context *ctx,
315 struct pipe_sampler_view *view);
316 };
317
318
319 #ifdef __cplusplus
320 }
321 #endif
322
323 #endif /* PIPE_CONTEXT_H */