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
* );
61 * VBO drawing (return false on fallbacks (temporary??))
64 boolean (*draw_arrays
)( struct pipe_context
*pipe
,
65 unsigned mode
, unsigned start
, unsigned count
);
67 boolean (*draw_elements
)( struct pipe_context
*pipe
,
68 struct pipe_buffer
*indexBuffer
,
70 unsigned mode
, unsigned start
, unsigned count
);
72 /* XXX: this is (probably) a temporary entrypoint, as the range
73 * information should be available from the vertex_buffer state.
74 * Using this to quickly evaluate a specialized path in the draw
77 boolean (*draw_range_elements
)( struct pipe_context
*pipe
,
78 struct pipe_buffer
*indexBuffer
,
92 struct pipe_query
*(*create_query
)( struct pipe_context
*pipe
,
93 unsigned query_type
);
95 void (*destroy_query
)(struct pipe_context
*pipe
,
96 struct pipe_query
*q
);
98 void (*begin_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
99 void (*end_query
)(struct pipe_context
*pipe
, struct pipe_query
*q
);
101 boolean (*get_query_result
)(struct pipe_context
*pipe
,
102 struct pipe_query
*q
,
108 * State functions (create/bind/destroy state objects)
111 void * (*create_blend_state
)(struct pipe_context
*,
112 const struct pipe_blend_state
*);
113 void (*bind_blend_state
)(struct pipe_context
*, void *);
114 void (*delete_blend_state
)(struct pipe_context
*, void *);
116 void * (*create_sampler_state
)(struct pipe_context
*,
117 const struct pipe_sampler_state
*);
118 void (*bind_fragment_sampler_states
)(struct pipe_context
*,
119 unsigned num_samplers
,
121 void (*bind_vertex_sampler_states
)(struct pipe_context
*,
122 unsigned num_samplers
,
124 void (*delete_sampler_state
)(struct pipe_context
*, void *);
126 void * (*create_rasterizer_state
)(struct pipe_context
*,
127 const struct pipe_rasterizer_state
*);
128 void (*bind_rasterizer_state
)(struct pipe_context
*, void *);
129 void (*delete_rasterizer_state
)(struct pipe_context
*, void *);
131 void * (*create_depth_stencil_alpha_state
)(struct pipe_context
*,
132 const struct pipe_depth_stencil_alpha_state
*);
133 void (*bind_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
134 void (*delete_depth_stencil_alpha_state
)(struct pipe_context
*, void *);
136 void * (*create_fs_state
)(struct pipe_context
*,
137 const struct pipe_shader_state
*);
138 void (*bind_fs_state
)(struct pipe_context
*, void *);
139 void (*delete_fs_state
)(struct pipe_context
*, void *);
141 void * (*create_vs_state
)(struct pipe_context
*,
142 const struct pipe_shader_state
*);
143 void (*bind_vs_state
)(struct pipe_context
*, void *);
144 void (*delete_vs_state
)(struct pipe_context
*, void *);
146 void * (*create_gs_state
)(struct pipe_context
*,
147 const struct pipe_shader_state
*);
148 void (*bind_gs_state
)(struct pipe_context
*, void *);
149 void (*delete_gs_state
)(struct pipe_context
*, void *);
154 * Parameter-like state (or properties)
157 void (*set_blend_color
)( struct pipe_context
*,
158 const struct pipe_blend_color
* );
160 void (*set_clip_state
)( struct pipe_context
*,
161 const struct pipe_clip_state
* );
163 void (*set_constant_buffer
)( struct pipe_context
*,
164 uint shader
, uint index
,
165 const struct pipe_constant_buffer
*buf
);
167 void (*set_framebuffer_state
)( struct pipe_context
*,
168 const struct pipe_framebuffer_state
* );
170 void (*set_polygon_stipple
)( struct pipe_context
*,
171 const struct pipe_poly_stipple
* );
173 void (*set_scissor_state
)( struct pipe_context
*,
174 const struct pipe_scissor_state
* );
176 void (*set_viewport_state
)( struct pipe_context
*,
177 const struct pipe_viewport_state
* );
179 void (*set_fragment_sampler_textures
)(struct pipe_context
*,
180 unsigned num_textures
,
181 struct pipe_texture
**);
183 void (*set_vertex_sampler_textures
)(struct pipe_context
*,
184 unsigned num_textures
,
185 struct pipe_texture
**);
187 void (*set_vertex_buffers
)( struct pipe_context
*,
188 unsigned num_buffers
,
189 const struct pipe_vertex_buffer
* );
191 void (*set_vertex_elements
)( struct pipe_context
*,
192 unsigned num_elements
,
193 const struct pipe_vertex_element
* );
200 * The pipe driver is allowed to set these functions to NULL, and in that
201 * case, they will not be available.
206 * Copy a block of pixels from one surface to another.
207 * The surfaces must be of the same format.
209 void (*surface_copy
)(struct pipe_context
*pipe
,
210 struct pipe_surface
*dest
,
211 unsigned destx
, unsigned desty
,
212 struct pipe_surface
*src
,
213 unsigned srcx
, unsigned srcy
,
214 unsigned width
, unsigned height
);
217 * Fill a region of a surface with a constant value.
219 void (*surface_fill
)(struct pipe_context
*pipe
,
220 struct pipe_surface
*dst
,
221 unsigned dstx
, unsigned dsty
,
222 unsigned width
, unsigned height
,
227 * Clear the specified set of currently bound buffers to specified values.
228 * The entire buffers are cleared (no scissor, no colormask, etc).
230 * \param buffers bitfield of PIPE_CLEAR_* values.
231 * \param rgba pointer to an array of one float for each of r, g, b, a.
232 * \param depth depth clear value in [0,1].
233 * \param stencil stencil clear value
235 void (*clear
)(struct pipe_context
*pipe
,
242 * \param flags bitmask of PIPE_FLUSH_x tokens)
244 void (*flush
)( struct pipe_context
*pipe
,
246 struct pipe_fence_handle
**fence
);
249 * Check whether a texture is referenced by an unflushed hw command.
250 * The state-tracker uses this function to optimize away unnecessary
251 * flushes. It is safe (but wasteful) to always return.
252 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
253 * \param pipe The pipe context whose unflushed hw commands will be
255 * \param level mipmap level.
256 * \param texture texture to check.
257 * \param face cubemap face. Use 0 for non-cubemap texture.
259 unsigned int (*is_texture_referenced
) (struct pipe_context
*pipe
,
260 struct pipe_texture
*texture
,
261 unsigned face
, unsigned level
);
264 * Check whether a buffer is referenced by an unflushed hw command.
265 * The state-tracker uses this function to optimize away unnecessary
266 * flushes. It is safe (but wasteful) to always return
267 * PIPE_REFERENCED_FOR_READ | PIPE_REFERENCED_FOR_WRITE.
268 * \param pipe The pipe context whose unflushed hw commands will be
270 * \param buf Buffer to check.
272 unsigned int (*is_buffer_referenced
) (struct pipe_context
*pipe
,
273 struct pipe_buffer
*buf
);
281 #endif /* PIPE_CONTEXT_H */