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 **************************************************************************/
32 * Abstract graphics pipe state objects.
35 * 1. Want compact representations, so we use bitfields.
36 * 2. Put bitfields before other (GLfloat) fields.
43 #include "p_compiler.h"
44 #include "p_defines.h"
56 * Implementation limits
58 #define PIPE_MAX_ATTRIBS 32
59 #define PIPE_MAX_CLIP_PLANES 6
60 #define PIPE_MAX_COLOR_BUFS 8
61 #define PIPE_MAX_CONSTANT 32
62 #define PIPE_MAX_SAMPLERS 16
63 #define PIPE_MAX_VERTEX_SAMPLERS 16
64 #define PIPE_MAX_SHADER_INPUTS 16
65 #define PIPE_MAX_SHADER_OUTPUTS 16
66 #define PIPE_MAX_TEXTURE_LEVELS 16
74 * The driver will certainly subclass this to include actual memory
75 * management information.
79 struct pipe_reference reference
;
81 struct pipe_screen
*screen
;
88 * Primitive (point/line/tri) rasterization info
90 struct pipe_rasterizer_state
93 unsigned light_twoside
:1;
94 unsigned front_winding
:2; /**< PIPE_WINDING_x */
95 unsigned cull_mode
:2; /**< PIPE_WINDING_x */
96 unsigned fill_cw
:2; /**< PIPE_POLYGON_MODE_x */
97 unsigned fill_ccw
:2; /**< PIPE_POLYGON_MODE_x */
99 unsigned offset_ccw
:1;
101 unsigned poly_smooth
:1;
102 unsigned poly_stipple_enable
:1;
103 unsigned point_smooth
:1;
104 unsigned point_sprite
:1;
105 unsigned point_size_per_vertex
:1; /**< size computed in vertex shader */
106 unsigned multisample
:1; /* XXX maybe more ms state in future */
107 unsigned line_smooth
:1;
108 unsigned line_stipple_enable
:1;
109 unsigned line_stipple_factor
:8; /**< [1..256] actually */
110 unsigned line_stipple_pattern
:16;
111 unsigned line_last_pixel
:1;
114 * Vertex coordinates are pre-transformed to screen space. Skip
115 * the vertex shader, clipping and viewport processing. Note that
116 * a vertex shader is still needed though, to indicate the mapping
117 * from vertex elements to fragment shader input semantics.
119 * XXX: considered for removal.
121 unsigned bypass_vs_clip_and_viewport
:1;
124 * Use the first vertex of a primitive as the provoking vertex for
127 unsigned flatshade_first
:1;
130 * When true, triangle rasterization uses (0.5, 0.5) pixel centers
131 * for determining pixel ownership.
133 * When false, triangle rasterization uses (0,0) pixel centers for
134 * determining pixel ownership.
136 * Triangle rasterization always uses a 'top,left' rule for pixel
137 * ownership, this just alters which point we consider the pixel
138 * center for that test.
140 unsigned gl_rasterization_rules
:1;
143 float point_size
; /**< used when no per-vertex size */
144 float point_size_min
; /* XXX - temporary, will go away */
145 float point_size_max
; /* XXX - temporary, will go away */
148 ubyte sprite_coord_mode
[PIPE_MAX_SHADER_OUTPUTS
]; /**< PIPE_SPRITE_COORD_ */
152 struct pipe_poly_stipple
154 unsigned stipple
[32];
158 struct pipe_viewport_state
165 struct pipe_scissor_state
174 struct pipe_clip_state
176 float ucp
[PIPE_MAX_CLIP_PLANES
][4];
182 * Constants for vertex/fragment shaders
184 struct pipe_constant_buffer
186 struct pipe_buffer
*buffer
;
190 struct pipe_shader_state
192 const struct tgsi_token
*tokens
;
196 struct pipe_depth_state
198 unsigned enabled
:1; /**< depth test enabled? */
199 unsigned writemask
:1; /**< allow depth buffer writes? */
200 unsigned func
:3; /**< depth test func (PIPE_FUNC_x) */
204 struct pipe_stencil_state
206 unsigned enabled
:1; /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */
207 unsigned func
:3; /**< PIPE_FUNC_x */
208 unsigned fail_op
:3; /**< PIPE_STENCIL_OP_x */
209 unsigned zpass_op
:3; /**< PIPE_STENCIL_OP_x */
210 unsigned zfail_op
:3; /**< PIPE_STENCIL_OP_x */
217 struct pipe_alpha_state
220 unsigned func
:3; /**< PIPE_FUNC_x */
221 float ref_value
; /**< reference value */
225 struct pipe_depth_stencil_alpha_state
227 struct pipe_depth_state depth
;
228 struct pipe_stencil_state stencil
[2]; /**< [0] = front, [1] = back */
229 struct pipe_alpha_state alpha
;
233 struct pipe_blend_state
235 unsigned blend_enable
:1;
237 unsigned rgb_func
:3; /**< PIPE_BLEND_x */
238 unsigned rgb_src_factor
:5; /**< PIPE_BLENDFACTOR_x */
239 unsigned rgb_dst_factor
:5; /**< PIPE_BLENDFACTOR_x */
241 unsigned alpha_func
:3; /**< PIPE_BLEND_x */
242 unsigned alpha_src_factor
:5; /**< PIPE_BLENDFACTOR_x */
243 unsigned alpha_dst_factor
:5; /**< PIPE_BLENDFACTOR_x */
245 unsigned logicop_enable
:1;
246 unsigned logicop_func
:4; /**< PIPE_LOGICOP_x */
248 unsigned colormask
:4; /**< bitmask of PIPE_MASK_R/G/B/A */
253 struct pipe_blend_color
259 struct pipe_framebuffer_state
261 unsigned width
, height
;
263 /** multiple colorbuffers for multiple render targets */
265 struct pipe_surface
*cbufs
[PIPE_MAX_COLOR_BUFS
];
267 struct pipe_surface
*zsbuf
; /**< Z/stencil buffer */
272 * Texture sampler state.
274 struct pipe_sampler_state
276 unsigned wrap_s
:3; /**< PIPE_TEX_WRAP_x */
277 unsigned wrap_t
:3; /**< PIPE_TEX_WRAP_x */
278 unsigned wrap_r
:3; /**< PIPE_TEX_WRAP_x */
279 unsigned min_img_filter
:2; /**< PIPE_TEX_FILTER_x */
280 unsigned min_mip_filter
:2; /**< PIPE_TEX_MIPFILTER_x */
281 unsigned mag_img_filter
:2; /**< PIPE_TEX_FILTER_x */
282 unsigned compare_mode
:1; /**< PIPE_TEX_COMPARE_x */
283 unsigned compare_func
:3; /**< PIPE_FUNC_x */
284 unsigned normalized_coords
:1; /**< Are coords normalized to [0,1]? */
285 unsigned prefilter
:4; /**< Wierd sampling state exposed by some api's */
286 float lod_bias
; /**< LOD/lambda bias */
287 float min_lod
, max_lod
; /**< LOD clamp range, after bias */
288 float border_color
[4];
289 float max_anisotropy
;
294 * 2D surface. This is basically a view into a memory buffer.
295 * May be a renderbuffer, texture mipmap level, etc.
299 struct pipe_reference reference
;
300 enum pipe_format format
; /**< PIPE_FORMAT_x */
301 unsigned width
; /**< logical width in pixels */
302 unsigned height
; /**< logical height in pixels */
303 unsigned layout
; /**< PIPE_SURFACE_LAYOUT_x */
304 unsigned offset
; /**< offset from start of buffer, in bytes */
305 unsigned usage
; /**< PIPE_BUFFER_USAGE_* */
308 struct pipe_texture
*texture
; /**< texture into which this is a view */
315 * Transfer object. For data transfer to/from a texture.
319 unsigned x
; /**< x offset from start of texture image */
320 unsigned y
; /**< y offset from start of texture image */
321 unsigned width
; /**< logical width in pixels */
322 unsigned height
; /**< logical height in pixels */
323 unsigned stride
; /**< stride in bytes between rows of blocks */
324 enum pipe_transfer_usage usage
; /**< PIPE_TRANSFER_* */
326 struct pipe_texture
*texture
; /**< texture to transfer to/from */
338 struct pipe_reference reference
;
340 enum pipe_texture_target target
; /**< PIPE_TEXTURE_x */
341 enum pipe_format format
; /**< PIPE_FORMAT_x */
347 unsigned last_level
:8; /**< Index of last mipmap level present/defined */
349 unsigned nr_samples
:8; /**< for multisampled surfaces, nr of samples */
351 unsigned tex_usage
; /* PIPE_TEXTURE_USAGE_* */
353 struct pipe_screen
*screen
; /**< screen that this texture belongs to */
358 * A vertex buffer. Typically, all the vertex data/attributes for
359 * drawing something will be in one buffer. But it's also possible, for
360 * example, to put colors in one buffer and texcoords in another.
362 struct pipe_vertex_buffer
364 unsigned stride
; /**< stride to same attrib in next vertex, in bytes */
365 unsigned max_index
; /**< number of vertices in this buffer */
366 unsigned buffer_offset
; /**< offset to start of data in buffer, in bytes */
367 struct pipe_buffer
*buffer
; /**< the actual buffer */
372 * Information to describe a vertex attribute (position, color, etc)
374 struct pipe_vertex_element
376 /** Offset of this attribute, in bytes, from the start of the vertex */
379 /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
380 * this attribute live in?
382 unsigned vertex_buffer_index
:8;
383 unsigned nr_components
:8;
385 enum pipe_format src_format
; /**< PIPE_FORMAT_* */
389 /* Reference counting helper functions */
391 pipe_buffer_reference(struct pipe_buffer
**ptr
, struct pipe_buffer
*buf
)
393 struct pipe_buffer
*old_buf
= *ptr
;
395 if (pipe_reference(&(*ptr
)->reference
, &buf
->reference
))
396 old_buf
->screen
->buffer_destroy(old_buf
);
401 pipe_surface_reference(struct pipe_surface
**ptr
, struct pipe_surface
*surf
)
403 struct pipe_surface
*old_surf
= *ptr
;
405 if (pipe_reference(&(*ptr
)->reference
, &surf
->reference
))
406 old_surf
->texture
->screen
->tex_surface_destroy(old_surf
);
411 pipe_texture_reference(struct pipe_texture
**ptr
, struct pipe_texture
*tex
)
413 struct pipe_texture
*old_tex
= *ptr
;
415 if (pipe_reference(&(*ptr
)->reference
, &tex
->reference
))
416 old_tex
->screen
->texture_destroy(old_tex
);