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 **************************************************************************/
30 * Abstract graphics pipe state objects.
33 * 1. Want compact representations, so we use bitfields.
34 * 2. Put bitfields before other (GLfloat) fields.
41 #include "p_compiler.h"
42 #include "p_defines.h"
52 * Implementation limits
54 #define PIPE_MAX_ATTRIBS 32
55 #define PIPE_MAX_CLIP_PLANES 6
56 #define PIPE_MAX_COLOR_BUFS 8
57 #define PIPE_MAX_CONSTANT 32
58 #define PIPE_MAX_SAMPLERS 16
59 #define PIPE_MAX_SHADER_INPUTS 16
60 #define PIPE_MAX_SHADER_OUTPUTS 16
61 #define PIPE_MAX_TEXTURE_LEVELS 16
72 * The driver will certainly subclass this to include actual memory
73 * management information.
81 /** Reference count */
87 * Primitive (point/line/tri) rasterization info
89 struct pipe_rasterizer_state
92 unsigned light_twoside
:1;
93 unsigned front_winding
:2; /**< PIPE_WINDING_x */
94 unsigned cull_mode
:2; /**< PIPE_WINDING_x */
95 unsigned fill_cw
:2; /**< PIPE_POLYGON_MODE_x */
96 unsigned fill_ccw
:2; /**< PIPE_POLYGON_MODE_x */
98 unsigned offset_ccw
:1;
100 unsigned poly_smooth
:1;
101 unsigned poly_stipple_enable
:1;
102 unsigned point_smooth
:1;
103 unsigned point_sprite
:1;
104 unsigned point_size_per_vertex
:1; /**< size computed in vertex shader */
105 unsigned multisample
:1; /* XXX maybe more ms state in future */
106 unsigned line_smooth
:1;
107 unsigned line_stipple_enable
:1;
108 unsigned line_stipple_factor
:8; /**< [1..256] actually */
109 unsigned line_stipple_pattern
:16;
110 unsigned line_last_pixel
:1;
111 unsigned bypass_clipping
:1;
112 unsigned bypass_vs
:1; /**< Skip the vertex shader. Note that the shader is
113 still needed though, to indicate inputs/outputs */
114 unsigned origin_lower_left
:1; /**< Is (0,0) the lower-left corner? */
115 unsigned flatshade_first
:1; /**< take color attribute from the first vertex of a primitive */
116 unsigned gl_rasterization_rules
:1; /**< enable tweaks for GL rasterization? */
119 float point_size
; /**< used when no per-vertex size */
120 float point_size_min
; /* XXX - temporary, will go away */
121 float point_size_max
; /* XXX - temporary, will go away */
124 ubyte sprite_coord_mode
[PIPE_MAX_SHADER_OUTPUTS
]; /**< PIPE_SPRITE_COORD_ */
128 struct pipe_poly_stipple
130 unsigned stipple
[32];
134 struct pipe_viewport_state
141 struct pipe_scissor_state
150 struct pipe_clip_state
152 float ucp
[PIPE_MAX_CLIP_PLANES
][4];
158 * Constants for vertex/fragment shaders
160 struct pipe_constant_buffer
162 struct pipe_buffer
*buffer
;
163 unsigned size
; /** in bytes (XXX: redundant!) */
167 struct pipe_shader_state
169 const struct tgsi_token
*tokens
;
173 struct pipe_depth_state
{
174 unsigned enabled
:1; /**< depth test enabled? */
175 unsigned writemask
:1; /**< allow depth buffer writes? */
176 unsigned func
:3; /**< depth test func (PIPE_FUNC_x) */
177 unsigned occlusion_count
:1; /**< do occlusion counting? */
181 struct pipe_stencil_state
{
182 unsigned enabled
:1; /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */
183 unsigned func
:3; /**< PIPE_FUNC_x */
184 unsigned fail_op
:3; /**< PIPE_STENCIL_OP_x */
185 unsigned zpass_op
:3; /**< PIPE_STENCIL_OP_x */
186 unsigned zfail_op
:3; /**< PIPE_STENCIL_OP_x */
193 struct pipe_alpha_state
{
195 unsigned func
:3; /**< PIPE_FUNC_x */
196 float ref
; /**< reference value */
200 struct pipe_depth_stencil_alpha_state
202 struct pipe_depth_state depth
;
203 struct pipe_stencil_state stencil
[2]; /**< [0] = front, [1] = back */
204 struct pipe_alpha_state alpha
;
208 struct pipe_blend_state
210 unsigned blend_enable
:1;
212 unsigned rgb_func
:3; /**< PIPE_BLEND_x */
213 unsigned rgb_src_factor
:5; /**< PIPE_BLENDFACTOR_x */
214 unsigned rgb_dst_factor
:5; /**< PIPE_BLENDFACTOR_x */
216 unsigned alpha_func
:3; /**< PIPE_BLEND_x */
217 unsigned alpha_src_factor
:5; /**< PIPE_BLENDFACTOR_x */
218 unsigned alpha_dst_factor
:5; /**< PIPE_BLENDFACTOR_x */
220 unsigned logicop_enable
:1;
221 unsigned logicop_func
:4; /**< PIPE_LOGICOP_x */
223 unsigned colormask
:4; /**< bitmask of PIPE_MASK_R/G/B/A */
228 struct pipe_blend_color
234 struct pipe_framebuffer_state
236 unsigned width
, height
;
238 /** multiple colorbuffers for multiple render targets */
240 struct pipe_surface
*cbufs
[PIPE_MAX_COLOR_BUFS
];
242 struct pipe_surface
*zsbuf
; /**< Z/stencil buffer */
247 * Texture sampler state.
249 struct pipe_sampler_state
251 unsigned wrap_s
:3; /**< PIPE_TEX_WRAP_x */
252 unsigned wrap_t
:3; /**< PIPE_TEX_WRAP_x */
253 unsigned wrap_r
:3; /**< PIPE_TEX_WRAP_x */
254 unsigned min_img_filter
:2; /**< PIPE_TEX_FILTER_x */
255 unsigned min_mip_filter
:2; /**< PIPE_TEX_MIPFILTER_x */
256 unsigned mag_img_filter
:2; /**< PIPE_TEX_FILTER_x */
257 unsigned compare_mode
:1; /**< PIPE_TEX_COMPARE_x */
258 unsigned compare_func
:3; /**< PIPE_FUNC_x */
259 unsigned normalized_coords
:1; /**< Are coords normalized to [0,1]? */
260 unsigned prefilter
:4; /**< Wierd sampling state exposed by some api's */
261 float shadow_ambient
; /**< shadow test fail color/intensity */
262 float lod_bias
; /**< LOD/lambda bias */
263 float min_lod
, max_lod
; /**< LOD clamp range, after bias */
264 float border_color
[4];
265 float max_anisotropy
;
270 * 2D surface. This is basically a view into a memory buffer.
271 * May be a renderbuffer, texture mipmap level, etc.
275 struct pipe_buffer
*buffer
; /**< surface's buffer/memory */
276 enum pipe_format format
; /**< PIPE_FORMAT_x */
277 unsigned status
; /**< PIPE_SURFACE_STATUS_x */
278 unsigned clear_value
; /**< XXX may be temporary */
279 unsigned width
; /**< logical width in pixels */
280 unsigned height
; /**< logical height in pixels */
281 struct pipe_format_block block
;
282 unsigned nblocksx
; /**< allocated width in blocks */
283 unsigned nblocksy
; /**< allocated height in blocks */
284 unsigned stride
; /**< stride in bytes between rows of blocks */
285 unsigned layout
; /**< PIPE_SURFACE_LAYOUT_x */
286 unsigned offset
; /**< offset from start of buffer, in bytes */
288 unsigned usage
; /**< PIPE_BUFFER_USAGE_* */
290 struct pipe_winsys
*winsys
; /**< winsys which owns/created the surface */
292 struct pipe_texture
*texture
; /**< optional texture into which this is a view */
304 enum pipe_texture_target target
; /**< PIPE_TEXTURE_x */
305 enum pipe_format format
; /**< PIPE_FORMAT_x */
307 unsigned width
[PIPE_MAX_TEXTURE_LEVELS
];
308 unsigned height
[PIPE_MAX_TEXTURE_LEVELS
];
309 unsigned depth
[PIPE_MAX_TEXTURE_LEVELS
];
311 struct pipe_format_block block
;
312 unsigned nblocksx
[PIPE_MAX_TEXTURE_LEVELS
]; /**< allocated width in blocks */
313 unsigned nblocksy
[PIPE_MAX_TEXTURE_LEVELS
]; /**< allocated height in blocks */
315 unsigned last_level
:8; /**< Index of last mipmap level present/defined */
316 unsigned compressed
:1;
318 unsigned nr_samples
:8; /**< for multisampled surfaces, nr of samples */
320 unsigned tex_usage
; /* PIPE_TEXTURE_USAGE_* */
322 /* These are also refcounted:
326 struct pipe_screen
*screen
; /**< screen that this texture belongs to */
331 * A vertex buffer. Typically, all the vertex data/attributes for
332 * drawing something will be in one buffer. But it's also possible, for
333 * example, to put colors in one buffer and texcoords in another.
335 struct pipe_vertex_buffer
337 unsigned pitch
; /**< stride to same attrib in next vertex, in bytes */
338 unsigned max_index
; /**< number of vertices in this buffer */
339 unsigned buffer_offset
; /**< offset to start of data in buffer, in bytes */
340 struct pipe_buffer
*buffer
; /**< the actual buffer */
345 * Information to describe a vertex attribute (position, color, etc)
347 struct pipe_vertex_element
349 /** Offset of this attribute, in bytes, from the start of the vertex */
352 /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
353 * this attribute live in?
355 unsigned vertex_buffer_index
:8;
356 unsigned nr_components
:8;
358 enum pipe_format src_format
; /**< PIPE_FORMAT_* */