1 /**************************************************************************
3 * Copyright 2007 VMware, Inc.
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 VMWARE 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 8
58 #define PIPE_MAX_COLOR_BUFS 8
59 #define PIPE_MAX_CONSTANT_BUFFERS 32
60 #define PIPE_MAX_SAMPLERS 16
61 #define PIPE_MAX_SHADER_INPUTS 32
62 #define PIPE_MAX_SHADER_OUTPUTS 48 /* 32 GENERICs + POS, PSIZE, FOG, etc. */
63 #define PIPE_MAX_SHADER_SAMPLER_VIEWS 32
64 #define PIPE_MAX_SHADER_RESOURCES 32
65 #define PIPE_MAX_TEXTURE_LEVELS 16
66 #define PIPE_MAX_SO_BUFFERS 4
67 #define PIPE_MAX_SO_OUTPUTS 64
68 #define PIPE_MAX_VIEWPORTS 16
69 #define PIPE_MAX_CLIP_OR_CULL_DISTANCE_COUNT 8
70 #define PIPE_MAX_CLIP_OR_CULL_DISTANCE_ELEMENT_COUNT 2
75 int32_t count
; /* atomic */
81 * Primitive (point/line/tri) rasterization info
83 struct pipe_rasterizer_state
86 unsigned light_twoside
:1;
87 unsigned clamp_vertex_color
:1;
88 unsigned clamp_fragment_color
:1;
90 unsigned cull_face
:2; /**< PIPE_FACE_x */
91 unsigned fill_front
:2; /**< PIPE_POLYGON_MODE_x */
92 unsigned fill_back
:2; /**< PIPE_POLYGON_MODE_x */
93 unsigned offset_point
:1;
94 unsigned offset_line
:1;
95 unsigned offset_tri
:1;
97 unsigned poly_smooth
:1;
98 unsigned poly_stipple_enable
:1;
99 unsigned point_smooth
:1;
100 unsigned sprite_coord_mode
:1; /**< PIPE_SPRITE_COORD_ */
101 unsigned point_quad_rasterization
:1; /** points rasterized as quads or points */
102 unsigned point_tri_clip
:1; /** large points clipped as tris or points */
103 unsigned point_size_per_vertex
:1; /**< size computed in vertex shader */
104 unsigned multisample
:1; /* XXX maybe more ms state in future */
105 unsigned line_smooth
:1;
106 unsigned line_stipple_enable
:1;
107 unsigned line_last_pixel
:1;
110 * Use the first vertex of a primitive as the provoking vertex for
113 unsigned flatshade_first
:1;
115 unsigned half_pixel_center
:1;
116 unsigned bottom_edge_rule
:1;
119 * When true, rasterization is disabled and no pixels are written.
120 * This only makes sense with the Stream Out functionality.
122 unsigned rasterizer_discard
:1;
125 * When false, depth clipping is disabled and the depth value will be
126 * clamped later at the per-pixel level before depth testing.
127 * This depends on PIPE_CAP_DEPTH_CLIP_DISABLE.
129 unsigned depth_clip
:1;
132 * When true clip space in the z axis goes from [0..1] (D3D). When false
135 * NOTE: D3D will always use depth clamping.
137 unsigned clip_halfz
:1;
140 * Enable bits for clipping half-spaces.
141 * This applies to both user clip planes and shader clip distances.
142 * Note that if the bound shader exports any clip distances, these
143 * replace all user clip planes, and clip half-spaces enabled here
144 * but not written by the shader count as disabled.
146 unsigned clip_plane_enable
:PIPE_MAX_CLIP_PLANES
;
148 unsigned line_stipple_factor
:8; /**< [1..256] actually */
149 unsigned line_stipple_pattern
:16;
151 uint32_t sprite_coord_enable
; /* referring to 32 TEXCOORD/GENERIC inputs */
154 float point_size
; /**< used when no per-vertex size */
161 struct pipe_poly_stipple
163 unsigned stipple
[32];
167 struct pipe_viewport_state
174 struct pipe_scissor_state
183 struct pipe_clip_state
185 float ucp
[PIPE_MAX_CLIP_PLANES
][4];
190 * Stream output for vertex transform feedback.
192 struct pipe_stream_output_info
194 unsigned num_outputs
;
195 /** stride for an entire vertex for each buffer in dwords */
196 unsigned stride
[PIPE_MAX_SO_BUFFERS
];
199 * Array of stream outputs, in the order they are to be written in.
200 * Selected components are tightly packed into the output buffer.
203 unsigned register_index
:8; /**< 0 to PIPE_MAX_SHADER_OUTPUTS */
204 unsigned start_component
:2; /** 0 to 3 */
205 unsigned num_components
:3; /** 1 to 4 */
206 unsigned output_buffer
:3; /**< 0 to PIPE_MAX_SO_BUFFERS */
207 unsigned dst_offset
:16; /**< offset into the buffer in dwords */
208 } output
[PIPE_MAX_SO_OUTPUTS
];
212 struct pipe_shader_state
214 const struct tgsi_token
*tokens
;
215 struct pipe_stream_output_info stream_output
;
219 struct pipe_depth_state
221 unsigned enabled
:1; /**< depth test enabled? */
222 unsigned writemask
:1; /**< allow depth buffer writes? */
223 unsigned func
:3; /**< depth test func (PIPE_FUNC_x) */
227 struct pipe_stencil_state
229 unsigned enabled
:1; /**< stencil[0]: stencil enabled, stencil[1]: two-side enabled */
230 unsigned func
:3; /**< PIPE_FUNC_x */
231 unsigned fail_op
:3; /**< PIPE_STENCIL_OP_x */
232 unsigned zpass_op
:3; /**< PIPE_STENCIL_OP_x */
233 unsigned zfail_op
:3; /**< PIPE_STENCIL_OP_x */
234 unsigned valuemask
:8;
235 unsigned writemask
:8;
239 struct pipe_alpha_state
242 unsigned func
:3; /**< PIPE_FUNC_x */
243 float ref_value
; /**< reference value */
247 struct pipe_depth_stencil_alpha_state
249 struct pipe_depth_state depth
;
250 struct pipe_stencil_state stencil
[2]; /**< [0] = front, [1] = back */
251 struct pipe_alpha_state alpha
;
255 struct pipe_rt_blend_state
257 unsigned blend_enable
:1;
259 unsigned rgb_func
:3; /**< PIPE_BLEND_x */
260 unsigned rgb_src_factor
:5; /**< PIPE_BLENDFACTOR_x */
261 unsigned rgb_dst_factor
:5; /**< PIPE_BLENDFACTOR_x */
263 unsigned alpha_func
:3; /**< PIPE_BLEND_x */
264 unsigned alpha_src_factor
:5; /**< PIPE_BLENDFACTOR_x */
265 unsigned alpha_dst_factor
:5; /**< PIPE_BLENDFACTOR_x */
267 unsigned colormask
:4; /**< bitmask of PIPE_MASK_R/G/B/A */
270 struct pipe_blend_state
272 unsigned independent_blend_enable
:1;
273 unsigned logicop_enable
:1;
274 unsigned logicop_func
:4; /**< PIPE_LOGICOP_x */
276 unsigned alpha_to_coverage
:1;
277 unsigned alpha_to_one
:1;
278 struct pipe_rt_blend_state rt
[PIPE_MAX_COLOR_BUFS
];
282 struct pipe_blend_color
287 struct pipe_stencil_ref
292 struct pipe_framebuffer_state
294 unsigned width
, height
;
296 /** multiple color buffers for multiple render targets */
298 struct pipe_surface
*cbufs
[PIPE_MAX_COLOR_BUFS
];
300 struct pipe_surface
*zsbuf
; /**< Z/stencil buffer */
305 * Texture sampler state.
307 struct pipe_sampler_state
309 unsigned wrap_s
:3; /**< PIPE_TEX_WRAP_x */
310 unsigned wrap_t
:3; /**< PIPE_TEX_WRAP_x */
311 unsigned wrap_r
:3; /**< PIPE_TEX_WRAP_x */
312 unsigned min_img_filter
:2; /**< PIPE_TEX_FILTER_x */
313 unsigned min_mip_filter
:2; /**< PIPE_TEX_MIPFILTER_x */
314 unsigned mag_img_filter
:2; /**< PIPE_TEX_FILTER_x */
315 unsigned compare_mode
:1; /**< PIPE_TEX_COMPARE_x */
316 unsigned compare_func
:3; /**< PIPE_FUNC_x */
317 unsigned normalized_coords
:1; /**< Are coords normalized to [0,1]? */
318 unsigned max_anisotropy
:6;
319 unsigned seamless_cube_map
:1;
320 float lod_bias
; /**< LOD/lambda bias */
321 float min_lod
, max_lod
; /**< LOD clamp range, after bias */
322 union pipe_color_union border_color
;
327 * A view into a texture that can be bound to a color render target /
328 * depth stencil attachment point.
332 struct pipe_reference reference
;
333 struct pipe_resource
*texture
; /**< resource into which this is a view */
334 struct pipe_context
*context
; /**< context this surface belongs to */
335 enum pipe_format format
;
337 /* XXX width/height should be removed */
338 unsigned width
; /**< logical width in pixels */
339 unsigned height
; /**< logical height in pixels */
341 unsigned writable
:1; /**< writable shader resource */
346 unsigned first_layer
:16;
347 unsigned last_layer
:16;
350 unsigned first_element
;
351 unsigned last_element
;
358 * A view into a texture that can be bound to a shader stage.
360 struct pipe_sampler_view
362 struct pipe_reference reference
;
363 enum pipe_format format
; /**< typed PIPE_FORMAT_x */
364 struct pipe_resource
*texture
; /**< texture into which this is a view */
365 struct pipe_context
*context
; /**< context this view belongs to */
368 unsigned first_layer
:16; /**< first layer to use for array textures */
369 unsigned last_layer
:16; /**< last layer to use for array textures */
370 unsigned first_level
:8; /**< first mipmap level to use */
371 unsigned last_level
:8; /**< last mipmap level to use */
374 unsigned first_element
;
375 unsigned last_element
;
378 unsigned swizzle_r
:3; /**< PIPE_SWIZZLE_x for red component */
379 unsigned swizzle_g
:3; /**< PIPE_SWIZZLE_x for green component */
380 unsigned swizzle_b
:3; /**< PIPE_SWIZZLE_x for blue component */
381 unsigned swizzle_a
:3; /**< PIPE_SWIZZLE_x for alpha component */
386 * Subregion of 1D/2D/3D image resource.
400 * A memory object/resource such as a vertex buffer or texture.
404 struct pipe_reference reference
;
405 struct pipe_screen
*screen
; /**< screen that this texture belongs to */
406 enum pipe_texture_target target
; /**< PIPE_TEXTURE_x */
407 enum pipe_format format
; /**< PIPE_FORMAT_x */
414 unsigned last_level
:8; /**< Index of last mipmap level present/defined */
415 unsigned nr_samples
:8; /**< for multisampled surfaces, nr of samples */
416 unsigned usage
:8; /**< PIPE_USAGE_x (not a bitmask) */
418 unsigned bind
; /**< bitmask of PIPE_BIND_x */
419 unsigned flags
; /**< bitmask of PIPE_RESOURCE_FLAG_x */
424 * Transfer object. For data transfer to/from a resource.
428 struct pipe_resource
*resource
; /**< resource to transfer to/from */
429 unsigned level
; /**< texture mipmap level */
430 enum pipe_transfer_usage usage
;
431 struct pipe_box box
; /**< region of the resource to access */
432 unsigned stride
; /**< row stride in bytes */
433 unsigned layer_stride
; /**< image/layer stride in bytes */
439 * A vertex buffer. Typically, all the vertex data/attributes for
440 * drawing something will be in one buffer. But it's also possible, for
441 * example, to put colors in one buffer and texcoords in another.
443 struct pipe_vertex_buffer
445 unsigned stride
; /**< stride to same attrib in next vertex, in bytes */
446 unsigned buffer_offset
; /**< offset to start of data in buffer, in bytes */
447 struct pipe_resource
*buffer
; /**< the actual buffer */
448 const void *user_buffer
; /**< pointer to a user buffer if buffer == NULL */
453 * A constant buffer. A subrange of an existing buffer can be set
454 * as a constant buffer.
456 struct pipe_constant_buffer
{
457 struct pipe_resource
*buffer
; /**< the actual buffer */
458 unsigned buffer_offset
; /**< offset to start of data in buffer, in bytes */
459 unsigned buffer_size
; /**< how much data can be read in shader */
460 const void *user_buffer
; /**< pointer to a user buffer if buffer == NULL */
465 * A stream output target. The structure specifies the range vertices can
468 * In addition to that, the structure should internally maintain the offset
469 * into the buffer, which should be incremented everytime something is written
470 * (appended) to it. The internal offset is buffer_offset + how many bytes
471 * have been written. The internal offset can be stored on the device
472 * and the CPU actually doesn't have to query it.
474 * Note that the buffer_size variable is actually specifying the available
475 * space in the buffer, not the size of the attached buffer.
476 * In other words in majority of cases buffer_size would simply be
477 * 'buffer->width0 - buffer_offset', so buffer_size refers to the size
478 * of the buffer left, after accounting for buffer offset, for stream output
481 * Use PIPE_QUERY_SO_STATISTICS to know how many primitives have
482 * actually been written.
484 struct pipe_stream_output_target
486 struct pipe_reference reference
;
487 struct pipe_resource
*buffer
; /**< the output buffer */
488 struct pipe_context
*context
; /**< context this SO target belongs to */
490 unsigned buffer_offset
; /**< offset where data should be written, in bytes */
491 unsigned buffer_size
; /**< how much data is allowed to be written */
496 * Information to describe a vertex attribute (position, color, etc)
498 struct pipe_vertex_element
500 /** Offset of this attribute, in bytes, from the start of the vertex */
503 /** Instance data rate divisor. 0 means this is per-vertex data,
504 * n means per-instance data used for n consecutive instances (n > 0).
506 unsigned instance_divisor
;
508 /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
509 * this attribute live in?
511 unsigned vertex_buffer_index
;
513 enum pipe_format src_format
;
518 * An index buffer. When an index buffer is bound, all indices to vertices
519 * will be looked up in the buffer.
521 struct pipe_index_buffer
523 unsigned index_size
; /**< size of an index, in bytes */
524 unsigned offset
; /**< offset to start of data in buffer, in bytes */
525 struct pipe_resource
*buffer
; /**< the actual buffer */
526 const void *user_buffer
; /**< pointer to a user buffer if buffer == NULL */
531 * Information to describe a draw_vbo call.
533 struct pipe_draw_info
535 boolean indexed
; /**< use index buffer */
537 unsigned mode
; /**< the mode of the primitive */
538 unsigned start
; /**< the index of the first vertex */
539 unsigned count
; /**< number of vertices */
541 unsigned start_instance
; /**< first instance id */
542 unsigned instance_count
; /**< number of instances */
545 * For indexed drawing, these fields apply after index lookup.
547 int index_bias
; /**< a bias to be added to each index */
548 unsigned min_index
; /**< the min index */
549 unsigned max_index
; /**< the max index */
552 * Primitive restart enable/index (only applies to indexed drawing)
554 boolean primitive_restart
;
555 unsigned restart_index
;
558 * Stream output target. If not NULL, it's used to provide the 'count'
559 * parameter based on the number vertices captured by the stream output
560 * stage. (or generally, based on the number of bytes captured)
562 * Only 'mode', 'start_instance', and 'instance_count' are taken into
563 * account, all the other variables from pipe_draw_info are ignored.
565 * 'start' is implicitly 0 and 'count' is set as discussed above.
566 * The draw command is non-indexed.
568 * Note that this only provides the count. The vertex buffers must
569 * be set via set_vertex_buffers manually.
571 struct pipe_stream_output_target
*count_from_stream_output
;
576 * Information to describe a blit call.
578 struct pipe_blit_info
581 struct pipe_resource
*resource
;
583 struct pipe_box box
; /**< negative width, height only legal for src */
584 /* For pipe_surface-like format casting: */
585 enum pipe_format format
; /**< must be supported for sampling (src)
586 or rendering (dst), ZS is always supported */
589 unsigned mask
; /**< bitmask of PIPE_MASK_R/G/B/A/Z/S */
590 unsigned filter
; /**< PIPE_TEX_FILTER_* */
592 boolean scissor_enable
;
593 struct pipe_scissor_state scissor
;
595 boolean render_condition_enable
; /**< whether to leave current render
601 * Structure used as a header for serialized LLVM programs.
603 struct pipe_llvm_program_header
605 uint32_t num_bytes
; /**< Number of bytes in the LLVM bytecode program. */
608 struct pipe_compute_state
610 const void *prog
; /**< Compute program to be executed. */
611 unsigned req_local_mem
; /**< Required size of the LOCAL resource. */
612 unsigned req_private_mem
; /**< Required size of the PRIVATE resource. */
613 unsigned req_input_mem
; /**< Required size of the INPUT resource. */