1d2aa109495e7a7f3bb5bba85d7fefb89cd5411a
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_DEFINES_H
29 #define PIPE_DEFINES_H
37 #define PIPE_BLENDFACTOR_ONE 0x1
38 #define PIPE_BLENDFACTOR_SRC_COLOR 0x2
39 #define PIPE_BLENDFACTOR_SRC_ALPHA 0x3
40 #define PIPE_BLENDFACTOR_DST_ALPHA 0x4
41 #define PIPE_BLENDFACTOR_DST_COLOR 0x5
42 #define PIPE_BLENDFACTOR_SRC_ALPHA_SATURATE 0x6
43 #define PIPE_BLENDFACTOR_CONST_COLOR 0x7
44 #define PIPE_BLENDFACTOR_CONST_ALPHA 0x8
45 #define PIPE_BLENDFACTOR_SRC1_COLOR 0x9
46 #define PIPE_BLENDFACTOR_SRC1_ALPHA 0x0A
47 #define PIPE_BLENDFACTOR_ZERO 0x11
48 #define PIPE_BLENDFACTOR_INV_SRC_COLOR 0x12
49 #define PIPE_BLENDFACTOR_INV_SRC_ALPHA 0x13
50 #define PIPE_BLENDFACTOR_INV_DST_ALPHA 0x14
51 #define PIPE_BLENDFACTOR_INV_DST_COLOR 0x15
52 #define PIPE_BLENDFACTOR_INV_CONST_COLOR 0x17
53 #define PIPE_BLENDFACTOR_INV_CONST_ALPHA 0x18
54 #define PIPE_BLENDFACTOR_INV_SRC1_COLOR 0x19
55 #define PIPE_BLENDFACTOR_INV_SRC1_ALPHA 0x1A
57 #define PIPE_BLEND_ADD 0
58 #define PIPE_BLEND_SUBTRACT 1
59 #define PIPE_BLEND_REVERSE_SUBTRACT 2
60 #define PIPE_BLEND_MIN 3
61 #define PIPE_BLEND_MAX 4
63 #define PIPE_LOGICOP_CLEAR 0
64 #define PIPE_LOGICOP_NOR 1
65 #define PIPE_LOGICOP_AND_INVERTED 2
66 #define PIPE_LOGICOP_COPY_INVERTED 3
67 #define PIPE_LOGICOP_AND_REVERSE 4
68 #define PIPE_LOGICOP_INVERT 5
69 #define PIPE_LOGICOP_XOR 6
70 #define PIPE_LOGICOP_NAND 7
71 #define PIPE_LOGICOP_AND 8
72 #define PIPE_LOGICOP_EQUIV 9
73 #define PIPE_LOGICOP_NOOP 10
74 #define PIPE_LOGICOP_OR_INVERTED 11
75 #define PIPE_LOGICOP_COPY 12
76 #define PIPE_LOGICOP_OR_REVERSE 13
77 #define PIPE_LOGICOP_OR 14
78 #define PIPE_LOGICOP_SET 15
80 #define PIPE_MASK_R 0x1
81 #define PIPE_MASK_G 0x2
82 #define PIPE_MASK_B 0x4
83 #define PIPE_MASK_A 0x8
84 #define PIPE_MASK_RGBA 0xf
88 * Inequality functions. Used for depth test, stencil compare, alpha
89 * test, shadow compare, etc.
91 #define PIPE_FUNC_NEVER 0
92 #define PIPE_FUNC_LESS 1
93 #define PIPE_FUNC_EQUAL 2
94 #define PIPE_FUNC_LEQUAL 3
95 #define PIPE_FUNC_GREATER 4
96 #define PIPE_FUNC_NOTEQUAL 5
97 #define PIPE_FUNC_GEQUAL 6
98 #define PIPE_FUNC_ALWAYS 7
100 /** Polygon fill mode */
101 #define PIPE_POLYGON_MODE_FILL 0
102 #define PIPE_POLYGON_MODE_LINE 1
103 #define PIPE_POLYGON_MODE_POINT 2
105 /** Polygon front/back window, also for culling */
106 #define PIPE_WINDING_NONE 0
107 #define PIPE_WINDING_CW 1
108 #define PIPE_WINDING_CCW 2
109 #define PIPE_WINDING_BOTH (PIPE_WINDING_CW | PIPE_WINDING_CCW)
112 #define PIPE_STENCIL_OP_KEEP 0
113 #define PIPE_STENCIL_OP_ZERO 1
114 #define PIPE_STENCIL_OP_REPLACE 2
115 #define PIPE_STENCIL_OP_INCR 3
116 #define PIPE_STENCIL_OP_DECR 4
117 #define PIPE_STENCIL_OP_INCR_WRAP 5
118 #define PIPE_STENCIL_OP_DECR_WRAP 6
119 #define PIPE_STENCIL_OP_INVERT 7
122 enum pipe_texture_target
{
126 PIPE_TEXTURE_CUBE
= 3
129 #define PIPE_TEX_FACE_POS_X 0
130 #define PIPE_TEX_FACE_NEG_X 1
131 #define PIPE_TEX_FACE_POS_Y 2
132 #define PIPE_TEX_FACE_NEG_Y 3
133 #define PIPE_TEX_FACE_POS_Z 4
134 #define PIPE_TEX_FACE_NEG_Z 5
136 #define PIPE_TEX_WRAP_REPEAT 0
137 #define PIPE_TEX_WRAP_CLAMP 1
138 #define PIPE_TEX_WRAP_CLAMP_TO_EDGE 2
139 #define PIPE_TEX_WRAP_CLAMP_TO_BORDER 3
140 #define PIPE_TEX_WRAP_MIRROR_REPEAT 4
141 #define PIPE_TEX_WRAP_MIRROR_CLAMP 5
142 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_EDGE 6
143 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_BORDER 7
145 /* Between mipmaps, ie mipfilter
147 #define PIPE_TEX_MIPFILTER_NEAREST 0
148 #define PIPE_TEX_MIPFILTER_LINEAR 1
149 #define PIPE_TEX_MIPFILTER_NONE 2
151 /* Within a mipmap, ie min/mag filter
153 #define PIPE_TEX_FILTER_NEAREST 0
154 #define PIPE_TEX_FILTER_LINEAR 1
155 #define PIPE_TEX_FILTER_ANISO 2
158 #define PIPE_TEX_COMPARE_NONE 0
159 #define PIPE_TEX_COMPARE_R_TO_TEXTURE 1
161 #define PIPE_TEX_FACE_POS_X 0
162 #define PIPE_TEX_FACE_NEG_X 1
163 #define PIPE_TEX_FACE_POS_Y 2
164 #define PIPE_TEX_FACE_NEG_Y 3
165 #define PIPE_TEX_FACE_POS_Z 4
166 #define PIPE_TEX_FACE_NEG_Z 5
167 #define PIPE_TEX_FACE_MAX 6
169 #define PIPE_TEXTURE_USAGE_RENDER_TARGET 0x1
170 #define PIPE_TEXTURE_USAGE_DISPLAY_TARGET 0x2 /* ie a backbuffer */
171 #define PIPE_TEXTURE_USAGE_PRIMARY 0x4 /* ie a frontbuffer */
172 #define PIPE_TEXTURE_USAGE_DEPTH_STENCIL 0x8
173 #define PIPE_TEXTURE_USAGE_SAMPLER 0x10
174 #define PIPE_TEXTURE_USAGE_DYNAMIC 0x20
175 /** Pipe driver custom usage flags should be greater or equal to this value */
176 #define PIPE_TEXTURE_USAGE_CUSTOM (1 << 16)
178 #define PIPE_TEXTURE_GEOM_NON_SQUARE 0x1
179 #define PIPE_TEXTURE_GEOM_NON_POWER_OF_TWO 0x2
185 #define PIPE_SURFACE_LAYOUT_LINEAR 0
191 /** All color buffers currently bound */
192 #define PIPE_CLEAR_COLOR (1 << 0)
193 /** Depth/stencil combined */
194 #define PIPE_CLEAR_DEPTHSTENCIL (1 << 1)
198 * Transfer object usage flags
200 enum pipe_transfer_usage
{
203 PIPE_TRANSFER_READ_WRITE
/**< Read/modify/write */
210 #define PIPE_BUFFER_USAGE_CPU_READ (1 << 0)
211 #define PIPE_BUFFER_USAGE_CPU_WRITE (1 << 1)
212 #define PIPE_BUFFER_USAGE_GPU_READ (1 << 2)
213 #define PIPE_BUFFER_USAGE_GPU_WRITE (1 << 3)
214 #define PIPE_BUFFER_USAGE_PIXEL (1 << 4)
215 #define PIPE_BUFFER_USAGE_VERTEX (1 << 5)
216 #define PIPE_BUFFER_USAGE_INDEX (1 << 6)
217 #define PIPE_BUFFER_USAGE_CONSTANT (1 << 7)
218 #define PIPE_BUFFER_USAGE_DISCARD (1 << 8)
219 #define PIPE_BUFFER_USAGE_DONTBLOCK (1 << 9)
220 /** Pipe driver custom usage flags should be greater or equal to this value */
221 #define PIPE_BUFFER_USAGE_CUSTOM (1 << 16)
223 /* Convenient shortcuts */
224 #define PIPE_BUFFER_USAGE_CPU_READ_WRITE \
225 ( PIPE_BUFFER_USAGE_CPU_READ | PIPE_BUFFER_USAGE_CPU_WRITE )
226 #define PIPE_BUFFER_USAGE_GPU_READ_WRITE \
227 ( PIPE_BUFFER_USAGE_GPU_READ | PIPE_BUFFER_USAGE_GPU_WRITE )
228 #define PIPE_BUFFER_USAGE_WRITE \
229 ( PIPE_BUFFER_USAGE_CPU_WRITE | PIPE_BUFFER_USAGE_GPU_WRITE )
235 #define PIPE_FLUSH_RENDER_CACHE 0x1
236 #define PIPE_FLUSH_TEXTURE_CACHE 0x2
237 #define PIPE_FLUSH_SWAPBUFFERS 0x4
238 #define PIPE_FLUSH_FRAME 0x8 /**< Mark the end of a frame */
244 #define PIPE_SHADER_VERTEX 0
245 #define PIPE_SHADER_FRAGMENT 1
246 #define PIPE_SHADER_TYPES 2
252 #define PIPE_PRIM_POINTS 0
253 #define PIPE_PRIM_LINES 1
254 #define PIPE_PRIM_LINE_LOOP 2
255 #define PIPE_PRIM_LINE_STRIP 3
256 #define PIPE_PRIM_TRIANGLES 4
257 #define PIPE_PRIM_TRIANGLE_STRIP 5
258 #define PIPE_PRIM_TRIANGLE_FAN 6
259 #define PIPE_PRIM_QUADS 7
260 #define PIPE_PRIM_QUAD_STRIP 8
261 #define PIPE_PRIM_POLYGON 9
262 #define PIPE_PRIM_MAX 10
268 #define PIPE_QUERY_OCCLUSION_COUNTER 0
269 #define PIPE_QUERY_PRIMITIVES_GENERATED 1
270 #define PIPE_QUERY_PRIMITIVES_EMITTED 2
271 #define PIPE_QUERY_TYPES 3
275 * Point sprite coord modes
277 #define PIPE_SPRITE_COORD_NONE 0
278 #define PIPE_SPRITE_COORD_UPPER_LEFT 1
279 #define PIPE_SPRITE_COORD_LOWER_LEFT 2
283 * Implementation capabilities/limits
284 * Passed to pipe->get_param()
285 * XXX this will need some fine tuning...
287 #define PIPE_CAP_MAX_TEXTURE_IMAGE_UNITS 1
288 #define PIPE_CAP_NPOT_TEXTURES 2
289 #define PIPE_CAP_TWO_SIDED_STENCIL 3
290 #define PIPE_CAP_GLSL 4 /* XXX need something better */
291 #define PIPE_CAP_S3TC 5
292 #define PIPE_CAP_ANISOTROPIC_FILTER 6
293 #define PIPE_CAP_POINT_SPRITE 7
294 #define PIPE_CAP_MAX_RENDER_TARGETS 8
295 #define PIPE_CAP_OCCLUSION_QUERY 9
296 #define PIPE_CAP_TEXTURE_SHADOW_MAP 10
297 #define PIPE_CAP_MAX_TEXTURE_2D_LEVELS 11
298 #define PIPE_CAP_MAX_TEXTURE_3D_LEVELS 12
299 #define PIPE_CAP_MAX_TEXTURE_CUBE_LEVELS 13
300 #define PIPE_CAP_MAX_LINE_WIDTH 14
301 #define PIPE_CAP_MAX_LINE_WIDTH_AA 15
302 #define PIPE_CAP_MAX_POINT_WIDTH 16
303 #define PIPE_CAP_MAX_POINT_WIDTH_AA 17
304 #define PIPE_CAP_MAX_TEXTURE_ANISOTROPY 18
305 #define PIPE_CAP_MAX_TEXTURE_LOD_BIAS 19
306 #define PIPE_CAP_GUARD_BAND_LEFT 20 /*< float */
307 #define PIPE_CAP_GUARD_BAND_TOP 21 /*< float */
308 #define PIPE_CAP_GUARD_BAND_RIGHT 22 /*< float */
309 #define PIPE_CAP_GUARD_BAND_BOTTOM 23 /*< float */
310 #define PIPE_CAP_TEXTURE_MIRROR_CLAMP 24
311 #define PIPE_CAP_TEXTURE_MIRROR_REPEAT 25
312 #define PIPE_CAP_MAX_VERTEX_TEXTURE_UNITS 26