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"
54 * Implementation limits
56 #define PIPE_MAX_ATTRIBS 32
57 #define PIPE_MAX_CLIP_PLANES 6
58 #define PIPE_MAX_COLOR_BUFS 8
59 #define PIPE_MAX_CONSTANT_BUFFERS 32
60 #define PIPE_MAX_SAMPLERS 16
61 #define PIPE_MAX_VERTEX_SAMPLERS 16
62 #define PIPE_MAX_GEOMETRY_SAMPLERS 16
63 #define PIPE_MAX_SHADER_INPUTS 32
64 #define PIPE_MAX_SHADER_OUTPUTS 32
65 #define PIPE_MAX_TEXTURE_LEVELS 16
66 #define PIPE_MAX_SO_BUFFERS 4
71 int32_t count
; /* atomic */
77 * Primitive (point/line/tri) rasterization info
79 struct pipe_rasterizer_state
82 unsigned light_twoside
:1;
84 unsigned cull_face
:2; /**< PIPE_FACE_x */
85 unsigned fill_front
:2; /**< PIPE_POLYGON_MODE_x */
86 unsigned fill_back
:2; /**< PIPE_POLYGON_MODE_x */
87 unsigned offset_point
:1;
88 unsigned offset_line
:1;
89 unsigned offset_tri
:1;
91 unsigned poly_smooth
:1;
92 unsigned poly_stipple_enable
:1;
93 unsigned point_smooth
:1;
94 unsigned sprite_coord_enable
:PIPE_MAX_SHADER_OUTPUTS
;
95 unsigned sprite_coord_mode
:1; /**< PIPE_SPRITE_COORD_ */
96 unsigned point_quad_rasterization
:1; /** points rasterized as quads or points */
97 unsigned point_size_per_vertex
:1; /**< size computed in vertex shader */
98 unsigned multisample
:1; /* XXX maybe more ms state in future */
99 unsigned line_smooth
:1;
100 unsigned line_stipple_enable
:1;
101 unsigned line_stipple_factor
:8; /**< [1..256] actually */
102 unsigned line_stipple_pattern
:16;
103 unsigned line_last_pixel
:1;
106 * Use the first vertex of a primitive as the provoking vertex for
109 unsigned flatshade_first
:1;
112 * When true, triangle rasterization uses (0.5, 0.5) pixel centers
113 * for determining pixel ownership.
115 * When false, triangle rasterization uses (0,0) pixel centers for
116 * determining pixel ownership.
118 * Triangle rasterization always uses a 'top,left' rule for pixel
119 * ownership, this just alters which point we consider the pixel
120 * center for that test.
122 unsigned gl_rasterization_rules
:1;
125 float point_size
; /**< used when no per-vertex size */
131 struct pipe_poly_stipple
133 unsigned stipple
[32];
137 struct pipe_viewport_state
144 struct pipe_scissor_state
153 struct pipe_clip_state
155 float ucp
[PIPE_MAX_CLIP_PLANES
][4];
157 unsigned depth_clamp
:1;
161 struct pipe_shader_state
163 const struct tgsi_token
*tokens
;
167 struct pipe_depth_state
169 unsigned enabled
:1; /**< depth test enabled? */
170 unsigned writemask
:1; /**< allow depth buffer writes? */
171 unsigned func
:3; /**< depth test func (PIPE_FUNC_x) */
175 struct pipe_stencil_state
177 unsigned enabled
:1; /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */
178 unsigned func
:3; /**< PIPE_FUNC_x */
179 unsigned fail_op
:3; /**< PIPE_STENCIL_OP_x */
180 unsigned zpass_op
:3; /**< PIPE_STENCIL_OP_x */
181 unsigned zfail_op
:3; /**< PIPE_STENCIL_OP_x */
182 unsigned valuemask
:8;
183 unsigned writemask
:8;
187 struct pipe_alpha_state
190 unsigned func
:3; /**< PIPE_FUNC_x */
191 float ref_value
; /**< reference value */
195 struct pipe_depth_stencil_alpha_state
197 struct pipe_depth_state depth
;
198 struct pipe_stencil_state stencil
[2]; /**< [0] = front, [1] = back */
199 struct pipe_alpha_state alpha
;
203 struct pipe_rt_blend_state
205 unsigned blend_enable
:1;
207 unsigned rgb_func
:3; /**< PIPE_BLEND_x */
208 unsigned rgb_src_factor
:5; /**< PIPE_BLENDFACTOR_x */
209 unsigned rgb_dst_factor
:5; /**< PIPE_BLENDFACTOR_x */
211 unsigned alpha_func
:3; /**< PIPE_BLEND_x */
212 unsigned alpha_src_factor
:5; /**< PIPE_BLENDFACTOR_x */
213 unsigned alpha_dst_factor
:5; /**< PIPE_BLENDFACTOR_x */
215 unsigned colormask
:4; /**< bitmask of PIPE_MASK_R/G/B/A */
218 struct pipe_blend_state
220 unsigned independent_blend_enable
:1;
221 unsigned logicop_enable
:1;
222 unsigned logicop_func
:4; /**< PIPE_LOGICOP_x */
224 unsigned alpha_to_coverage
:1;
225 unsigned alpha_to_one
:1;
226 struct pipe_rt_blend_state rt
[PIPE_MAX_COLOR_BUFS
];
230 struct pipe_blend_color
235 struct pipe_stencil_ref
240 struct pipe_framebuffer_state
242 unsigned width
, height
;
244 /** multiple color buffers for multiple render targets */
246 struct pipe_surface
*cbufs
[PIPE_MAX_COLOR_BUFS
];
248 struct pipe_surface
*zsbuf
; /**< Z/stencil buffer */
253 * Texture sampler state.
255 struct pipe_sampler_state
257 unsigned wrap_s
:3; /**< PIPE_TEX_WRAP_x */
258 unsigned wrap_t
:3; /**< PIPE_TEX_WRAP_x */
259 unsigned wrap_r
:3; /**< PIPE_TEX_WRAP_x */
260 unsigned min_img_filter
:2; /**< PIPE_TEX_FILTER_x */
261 unsigned min_mip_filter
:2; /**< PIPE_TEX_MIPFILTER_x */
262 unsigned mag_img_filter
:2; /**< PIPE_TEX_FILTER_x */
263 unsigned compare_mode
:1; /**< PIPE_TEX_COMPARE_x */
264 unsigned compare_func
:3; /**< PIPE_FUNC_x */
265 unsigned normalized_coords
:1; /**< Are coords normalized to [0,1]? */
266 unsigned max_anisotropy
:6;
267 float lod_bias
; /**< LOD/lambda bias */
268 float min_lod
, max_lod
; /**< LOD clamp range, after bias */
269 float border_color
[4];
274 * 2D surface. This is basically a view into a memory buffer.
275 * May be a renderbuffer, texture mipmap level, etc.
279 struct pipe_reference reference
;
280 struct pipe_resource
*texture
; /**< resource into which this is a view */
281 enum pipe_format format
;
283 unsigned width
; /**< logical width in pixels */
284 unsigned height
; /**< logical height in pixels */
286 unsigned layout
; /**< PIPE_SURFACE_LAYOUT_x */
287 unsigned offset
; /**< offset from start of buffer, in bytes */
288 unsigned usage
; /**< bitmask of PIPE_BIND_x */
297 * A view into a texture that can be bound to a shader stage.
299 struct pipe_sampler_view
301 struct pipe_reference reference
;
302 enum pipe_format format
; /**< typed PIPE_FORMAT_x */
303 struct pipe_resource
*texture
; /**< texture into which this is a view */
304 struct pipe_context
*context
; /**< context this view belongs to */
305 unsigned first_level
:8; /**< first mipmap level */
306 unsigned last_level
:8; /**< last mipmap level */
307 unsigned swizzle_r
:3; /**< PIPE_SWIZZLE_x for red component */
308 unsigned swizzle_g
:3; /**< PIPE_SWIZZLE_x for green component */
309 unsigned swizzle_b
:3; /**< PIPE_SWIZZLE_x for blue component */
310 unsigned swizzle_a
:3; /**< PIPE_SWIZZLE_x for alpha component */
315 * Subregion of 1D/2D/3D image resource.
329 * A memory object/resource such as a vertex buffer or texture.
333 struct pipe_reference reference
;
334 struct pipe_screen
*screen
; /**< screen that this texture belongs to */
335 enum pipe_texture_target target
; /**< PIPE_TEXTURE_x */
336 enum pipe_format format
; /**< PIPE_FORMAT_x */
342 unsigned last_level
:8; /**< Index of last mipmap level present/defined */
343 unsigned nr_samples
:8; /**< for multisampled surfaces, nr of samples */
344 unsigned usage
:8; /**< PIPE_USAGE_x (not a bitmask) */
346 unsigned bind
; /**< bitmask of PIPE_BIND_x */
347 unsigned flags
; /**< bitmask of PIPE_RESOURCE_FLAG_x */
350 struct pipe_stream_output_state
352 /**< number of the output buffer to insert each element into */
353 int output_buffer
[PIPE_MAX_SHADER_OUTPUTS
];
354 /**< which register to grab each output from */
355 int register_index
[PIPE_MAX_SHADER_OUTPUTS
];
356 /**< TGSI_WRITEMASK signifying which components to output */
357 ubyte register_mask
[PIPE_MAX_SHADER_OUTPUTS
];
358 /**< number of outputs */
361 /**< stride for an entire vertex, only used if all output_buffers
367 * Extra indexing info for (cube) texture resources.
369 struct pipe_subresource
377 * Transfer object. For data transfer to/from a resource.
381 struct pipe_resource
*resource
; /**< resource to transfer to/from */
382 struct pipe_subresource sr
;
383 enum pipe_transfer_usage usage
;
386 unsigned slice_stride
;
393 * A vertex buffer. Typically, all the vertex data/attributes for
394 * drawing something will be in one buffer. But it's also possible, for
395 * example, to put colors in one buffer and texcoords in another.
397 struct pipe_vertex_buffer
399 unsigned stride
; /**< stride to same attrib in next vertex, in bytes */
400 unsigned max_index
; /**< number of vertices in this buffer */
401 unsigned buffer_offset
; /**< offset to start of data in buffer, in bytes */
402 struct pipe_resource
*buffer
; /**< the actual buffer */
407 * Information to describe a vertex attribute (position, color, etc)
409 struct pipe_vertex_element
411 /** Offset of this attribute, in bytes, from the start of the vertex */
414 /** Instance data rate divisor. 0 means this is per-vertex data,
415 * n means per-instance data used for n consecutive instances (n > 0).
417 unsigned instance_divisor
;
419 /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
420 * this attribute live in?
422 unsigned vertex_buffer_index
;
424 enum pipe_format src_format
;
429 * An index buffer. When an index buffer is bound, all indices to vertices
430 * will be looked up in the buffer.
432 struct pipe_index_buffer
434 unsigned index_size
; /**< size of an index, in bytes */
435 unsigned offset
; /**< offset to start of data in buffer, in bytes */
436 struct pipe_resource
*buffer
; /**< the actual buffer */
441 * Information to describe a draw_vbo call.
443 struct pipe_draw_info
445 boolean indexed
; /**< use index buffer */
447 unsigned mode
; /**< the mode of the primitive */
448 unsigned start
; /**< the index of the first vertex */
449 unsigned count
; /**< number of vertices */
451 unsigned start_instance
; /**< first instance id */
452 unsigned instance_count
; /**< number of instances */
455 * For indexed drawing, these fields apply after index lookup.
457 int index_bias
; /**< a bias to be added to each index */
458 unsigned min_index
; /**< the min index */
459 unsigned max_index
; /**< the max index */
462 * Primitive restart enable/index (only applies to indexed drawing)
464 boolean primitive_restart
;
465 unsigned restart_index
;