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
38 * Gallium error codes.
40 * - A zero value always means success.
41 * - A negative value always means failure.
42 * - The meaning of a positive value is function dependent.
46 PIPE_ERROR
= -1, /**< Generic error */
47 PIPE_ERROR_BAD_INPUT
= -2,
48 PIPE_ERROR_OUT_OF_MEMORY
= -3,
54 #define PIPE_BLENDFACTOR_ONE 0x1
55 #define PIPE_BLENDFACTOR_SRC_COLOR 0x2
56 #define PIPE_BLENDFACTOR_SRC_ALPHA 0x3
57 #define PIPE_BLENDFACTOR_DST_ALPHA 0x4
58 #define PIPE_BLENDFACTOR_DST_COLOR 0x5
59 #define PIPE_BLENDFACTOR_SRC_ALPHA_SATURATE 0x6
60 #define PIPE_BLENDFACTOR_CONST_COLOR 0x7
61 #define PIPE_BLENDFACTOR_CONST_ALPHA 0x8
62 #define PIPE_BLENDFACTOR_SRC1_COLOR 0x9
63 #define PIPE_BLENDFACTOR_SRC1_ALPHA 0x0A
64 #define PIPE_BLENDFACTOR_ZERO 0x11
65 #define PIPE_BLENDFACTOR_INV_SRC_COLOR 0x12
66 #define PIPE_BLENDFACTOR_INV_SRC_ALPHA 0x13
67 #define PIPE_BLENDFACTOR_INV_DST_ALPHA 0x14
68 #define PIPE_BLENDFACTOR_INV_DST_COLOR 0x15
69 #define PIPE_BLENDFACTOR_INV_CONST_COLOR 0x17
70 #define PIPE_BLENDFACTOR_INV_CONST_ALPHA 0x18
71 #define PIPE_BLENDFACTOR_INV_SRC1_COLOR 0x19
72 #define PIPE_BLENDFACTOR_INV_SRC1_ALPHA 0x1A
74 #define PIPE_BLEND_ADD 0
75 #define PIPE_BLEND_SUBTRACT 1
76 #define PIPE_BLEND_REVERSE_SUBTRACT 2
77 #define PIPE_BLEND_MIN 3
78 #define PIPE_BLEND_MAX 4
80 #define PIPE_LOGICOP_CLEAR 0
81 #define PIPE_LOGICOP_NOR 1
82 #define PIPE_LOGICOP_AND_INVERTED 2
83 #define PIPE_LOGICOP_COPY_INVERTED 3
84 #define PIPE_LOGICOP_AND_REVERSE 4
85 #define PIPE_LOGICOP_INVERT 5
86 #define PIPE_LOGICOP_XOR 6
87 #define PIPE_LOGICOP_NAND 7
88 #define PIPE_LOGICOP_AND 8
89 #define PIPE_LOGICOP_EQUIV 9
90 #define PIPE_LOGICOP_NOOP 10
91 #define PIPE_LOGICOP_OR_INVERTED 11
92 #define PIPE_LOGICOP_COPY 12
93 #define PIPE_LOGICOP_OR_REVERSE 13
94 #define PIPE_LOGICOP_OR 14
95 #define PIPE_LOGICOP_SET 15
97 #define PIPE_MASK_R 0x1
98 #define PIPE_MASK_G 0x2
99 #define PIPE_MASK_B 0x4
100 #define PIPE_MASK_A 0x8
101 #define PIPE_MASK_RGBA 0xf
105 * Inequality functions. Used for depth test, stencil compare, alpha
106 * test, shadow compare, etc.
108 #define PIPE_FUNC_NEVER 0
109 #define PIPE_FUNC_LESS 1
110 #define PIPE_FUNC_EQUAL 2
111 #define PIPE_FUNC_LEQUAL 3
112 #define PIPE_FUNC_GREATER 4
113 #define PIPE_FUNC_NOTEQUAL 5
114 #define PIPE_FUNC_GEQUAL 6
115 #define PIPE_FUNC_ALWAYS 7
117 /** Polygon fill mode */
118 #define PIPE_POLYGON_MODE_FILL 0
119 #define PIPE_POLYGON_MODE_LINE 1
120 #define PIPE_POLYGON_MODE_POINT 2
122 /** Polygon front/back window, also for culling */
123 #define PIPE_WINDING_NONE 0
124 #define PIPE_WINDING_CW 1
125 #define PIPE_WINDING_CCW 2
126 #define PIPE_WINDING_BOTH (PIPE_WINDING_CW | PIPE_WINDING_CCW)
129 #define PIPE_STENCIL_OP_KEEP 0
130 #define PIPE_STENCIL_OP_ZERO 1
131 #define PIPE_STENCIL_OP_REPLACE 2
132 #define PIPE_STENCIL_OP_INCR 3
133 #define PIPE_STENCIL_OP_DECR 4
134 #define PIPE_STENCIL_OP_INCR_WRAP 5
135 #define PIPE_STENCIL_OP_DECR_WRAP 6
136 #define PIPE_STENCIL_OP_INVERT 7
139 enum pipe_texture_target
{
143 PIPE_TEXTURE_CUBE
= 3,
144 PIPE_MAX_TEXTURE_TYPES
147 #define PIPE_TEX_FACE_POS_X 0
148 #define PIPE_TEX_FACE_NEG_X 1
149 #define PIPE_TEX_FACE_POS_Y 2
150 #define PIPE_TEX_FACE_NEG_Y 3
151 #define PIPE_TEX_FACE_POS_Z 4
152 #define PIPE_TEX_FACE_NEG_Z 5
153 #define PIPE_TEX_FACE_MAX 6
155 #define PIPE_TEX_WRAP_REPEAT 0
156 #define PIPE_TEX_WRAP_CLAMP 1
157 #define PIPE_TEX_WRAP_CLAMP_TO_EDGE 2
158 #define PIPE_TEX_WRAP_CLAMP_TO_BORDER 3
159 #define PIPE_TEX_WRAP_MIRROR_REPEAT 4
160 #define PIPE_TEX_WRAP_MIRROR_CLAMP 5
161 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_EDGE 6
162 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_BORDER 7
164 /* Between mipmaps, ie mipfilter
166 #define PIPE_TEX_MIPFILTER_NEAREST 0
167 #define PIPE_TEX_MIPFILTER_LINEAR 1
168 #define PIPE_TEX_MIPFILTER_NONE 2
170 /* Within a mipmap, ie min/mag filter
172 #define PIPE_TEX_FILTER_NEAREST 0
173 #define PIPE_TEX_FILTER_LINEAR 1
175 #define PIPE_TEX_COMPARE_NONE 0
176 #define PIPE_TEX_COMPARE_R_TO_TEXTURE 1
178 #define PIPE_TEXTURE_USAGE_RENDER_TARGET 0x1
179 #define PIPE_TEXTURE_USAGE_DISPLAY_TARGET 0x2 /* windows presentable buffer, ie a backbuffer */
180 #define PIPE_TEXTURE_USAGE_SCANOUT 0x4 /* ie a frontbuffer */
181 #define PIPE_TEXTURE_USAGE_DEPTH_STENCIL 0x8
182 #define PIPE_TEXTURE_USAGE_SAMPLER 0x10
183 #define PIPE_TEXTURE_USAGE_DYNAMIC 0x20
184 #define PIPE_TEXTURE_USAGE_SHARED 0x40
185 /** Pipe driver custom usage flags should be greater or equal to this value */
186 #define PIPE_TEXTURE_USAGE_CUSTOM (1 << 16)
188 #define PIPE_TEXTURE_GEOM_NON_SQUARE 0x1
189 #define PIPE_TEXTURE_GEOM_NON_POWER_OF_TWO 0x2
195 #define PIPE_SURFACE_LAYOUT_LINEAR 0
201 /** All color buffers currently bound */
202 #define PIPE_CLEAR_COLOR (1 << 0)
203 /** Depth/stencil combined */
204 #define PIPE_CLEAR_DEPTHSTENCIL (1 << 1)
208 * Transfer object usage flags
210 enum pipe_transfer_usage
{
211 PIPE_TRANSFER_READ
= (1 << 0),
212 PIPE_TRANSFER_WRITE
= (1 << 1),
213 /** Read/modify/write */
214 PIPE_TRANSFER_READ_WRITE
= PIPE_TRANSFER_READ
| PIPE_TRANSFER_WRITE
,
216 * The transfer should map the texture storage directly. The driver may
217 * return NULL if that isn't possible, and the state tracker needs to cope
218 * with that and use an alternative path without this flag.
220 * E.g. the state tracker could have a simpler path which maps textures and
221 * does read/modify/write cycles on them directly, and a more complicated
222 * path which uses minimal read and write transfers.
224 PIPE_TRANSFER_MAP_DIRECTLY
= (1 << 2)
232 #define PIPE_BUFFER_USAGE_CPU_READ (1 << 0)
233 #define PIPE_BUFFER_USAGE_CPU_WRITE (1 << 1)
234 #define PIPE_BUFFER_USAGE_GPU_READ (1 << 2)
235 #define PIPE_BUFFER_USAGE_GPU_WRITE (1 << 3)
236 #define PIPE_BUFFER_USAGE_PIXEL (1 << 4)
237 #define PIPE_BUFFER_USAGE_VERTEX (1 << 5)
238 #define PIPE_BUFFER_USAGE_INDEX (1 << 6)
239 #define PIPE_BUFFER_USAGE_CONSTANT (1 << 7)
244 * These flags should only be used for texture transfers or when mapping
247 * Note that the PIPE_BUFFER_USAGE_CPU_xxx flags above are also used for
248 * mapping. Either PIPE_BUFFER_USAGE_CPU_READ or PIPE_BUFFER_USAGE_CPU_WRITE
253 * Discards the memory within the mapped region.
255 * It should not be used with PIPE_BUFFER_USAGE_CPU_READ.
258 * - OpenGL's ARB_map_buffer_range extension, MAP_INVALIDATE_RANGE_BIT flag.
259 * - Direct3D's D3DLOCK_DISCARD flag.
261 #define PIPE_BUFFER_USAGE_DISCARD (1 << 8)
264 * Fail if the resource cannot be mapped immediately.
267 * - Direct3D's D3DLOCK_DONOTWAIT flag.
268 * - Mesa3D's MESA_MAP_NOWAIT_BIT flag.
269 * - WDDM's D3DDDICB_LOCKFLAGS.DonotWait flag.
271 #define PIPE_BUFFER_USAGE_DONTBLOCK (1 << 9)
274 * Do not attempt to synchronize pending operations on the resource when mapping.
276 * It should not be used with PIPE_BUFFER_USAGE_CPU_READ.
279 * - OpenGL's ARB_map_buffer_range extension, MAP_UNSYNCHRONIZED_BIT flag.
280 * - Direct3D's D3DLOCK_NOOVERWRITE flag.
281 * - WDDM's D3DDDICB_LOCKFLAGS.IgnoreSync flag.
283 #define PIPE_BUFFER_USAGE_UNSYNCHRONIZED (1 << 10)
286 * Written ranges will be notified later with
287 * pipe_screen::buffer_flush_mapped_range.
289 * It should not be used with PIPE_BUFFER_USAGE_CPU_READ.
292 * - pipe_screen::buffer_flush_mapped_range
293 * - OpenGL's ARB_map_buffer_range extension, MAP_FLUSH_EXPLICIT_BIT flag.
295 #define PIPE_BUFFER_USAGE_FLUSH_EXPLICIT (1 << 11)
297 /** Pipe driver custom usage flags should be greater or equal to this value */
298 #define PIPE_BUFFER_USAGE_CUSTOM (1 << 16)
300 /* Convenient shortcuts */
301 #define PIPE_BUFFER_USAGE_CPU_READ_WRITE \
302 ( PIPE_BUFFER_USAGE_CPU_READ | PIPE_BUFFER_USAGE_CPU_WRITE )
303 #define PIPE_BUFFER_USAGE_GPU_READ_WRITE \
304 ( PIPE_BUFFER_USAGE_GPU_READ | PIPE_BUFFER_USAGE_GPU_WRITE )
305 #define PIPE_BUFFER_USAGE_WRITE \
306 ( PIPE_BUFFER_USAGE_CPU_WRITE | PIPE_BUFFER_USAGE_GPU_WRITE )
312 #define PIPE_FLUSH_RENDER_CACHE 0x1
313 #define PIPE_FLUSH_TEXTURE_CACHE 0x2
314 #define PIPE_FLUSH_SWAPBUFFERS 0x4
315 #define PIPE_FLUSH_FRAME 0x8 /**< Mark the end of a frame */
321 #define PIPE_SHADER_VERTEX 0
322 #define PIPE_SHADER_FRAGMENT 1
323 #define PIPE_SHADER_GEOMETRY 2
324 #define PIPE_SHADER_TYPES 3
330 #define PIPE_PRIM_POINTS 0
331 #define PIPE_PRIM_LINES 1
332 #define PIPE_PRIM_LINE_LOOP 2
333 #define PIPE_PRIM_LINE_STRIP 3
334 #define PIPE_PRIM_TRIANGLES 4
335 #define PIPE_PRIM_TRIANGLE_STRIP 5
336 #define PIPE_PRIM_TRIANGLE_FAN 6
337 #define PIPE_PRIM_QUADS 7
338 #define PIPE_PRIM_QUAD_STRIP 8
339 #define PIPE_PRIM_POLYGON 9
340 #define PIPE_PRIM_LINES_ADJACENCY 10
341 #define PIPE_PRIM_LINE_STRIP_ADJACENCY 11
342 #define PIPE_PRIM_TRIANGLES_ADJACENCY 12
343 #define PIPE_PRIM_TRIANGLE_STRIP_ADJACENCY 13
344 #define PIPE_PRIM_MAX 14
350 #define PIPE_QUERY_OCCLUSION_COUNTER 0
351 #define PIPE_QUERY_PRIMITIVES_GENERATED 1
352 #define PIPE_QUERY_PRIMITIVES_EMITTED 2
353 #define PIPE_QUERY_TYPES 3
357 * Conditional rendering modes
359 #define PIPE_RENDER_COND_WAIT 0
360 #define PIPE_RENDER_COND_NO_WAIT 1
361 #define PIPE_RENDER_COND_BY_REGION_WAIT 2
362 #define PIPE_RENDER_COND_BY_REGION_NO_WAIT 3
366 * Point sprite coord modes
368 #define PIPE_SPRITE_COORD_UPPER_LEFT 0
369 #define PIPE_SPRITE_COORD_LOWER_LEFT 1
373 * Implementation capabilities/limits which are queried through
374 * pipe_screen::get_param() and pipe_screen::get_paramf().
376 #define PIPE_CAP_MAX_TEXTURE_IMAGE_UNITS 1
377 #define PIPE_CAP_NPOT_TEXTURES 2
378 #define PIPE_CAP_TWO_SIDED_STENCIL 3
379 #define PIPE_CAP_GLSL 4 /* XXX need something better */
380 #define PIPE_CAP_DUAL_SOURCE_BLEND 5
381 #define PIPE_CAP_ANISOTROPIC_FILTER 6
382 #define PIPE_CAP_POINT_SPRITE 7
383 #define PIPE_CAP_MAX_RENDER_TARGETS 8
384 #define PIPE_CAP_OCCLUSION_QUERY 9
385 #define PIPE_CAP_TEXTURE_SHADOW_MAP 10
386 #define PIPE_CAP_MAX_TEXTURE_2D_LEVELS 11
387 #define PIPE_CAP_MAX_TEXTURE_3D_LEVELS 12
388 #define PIPE_CAP_MAX_TEXTURE_CUBE_LEVELS 13
389 #define PIPE_CAP_MAX_LINE_WIDTH 14
390 #define PIPE_CAP_MAX_LINE_WIDTH_AA 15
391 #define PIPE_CAP_MAX_POINT_WIDTH 16
392 #define PIPE_CAP_MAX_POINT_WIDTH_AA 17
393 #define PIPE_CAP_MAX_TEXTURE_ANISOTROPY 18
394 #define PIPE_CAP_MAX_TEXTURE_LOD_BIAS 19
395 #define PIPE_CAP_GUARD_BAND_LEFT 20 /*< float */
396 #define PIPE_CAP_GUARD_BAND_TOP 21 /*< float */
397 #define PIPE_CAP_GUARD_BAND_RIGHT 22 /*< float */
398 #define PIPE_CAP_GUARD_BAND_BOTTOM 23 /*< float */
399 #define PIPE_CAP_TEXTURE_MIRROR_CLAMP 24
400 #define PIPE_CAP_TEXTURE_MIRROR_REPEAT 25
401 #define PIPE_CAP_MAX_VERTEX_TEXTURE_UNITS 26
402 #define PIPE_CAP_TGSI_CONT_SUPPORTED 27
403 #define PIPE_CAP_BLEND_EQUATION_SEPARATE 28
404 #define PIPE_CAP_SM3 29 /*< Shader Model 3 supported */
405 #define PIPE_CAP_MAX_PREDICATE_REGISTERS 30
406 #define PIPE_CAP_MAX_COMBINED_SAMPLERS 31 /*< Maximum texture image units accessible from vertex
407 and fragment shaders combined */
408 #define PIPE_CAP_MAX_CONST_BUFFERS 32
409 #define PIPE_CAP_MAX_CONST_BUFFER_SIZE 33 /*< In bytes */
410 #define PIPE_CAP_INDEP_BLEND_ENABLE 34 /*< blend enables and write masks per rendertarget */
411 #define PIPE_CAP_INDEP_BLEND_FUNC 35 /*< different blend funcs per rendertarget */
412 #define PIPE_CAP_TGSI_FS_COORD_ORIGIN_UPPER_LEFT 36
413 #define PIPE_CAP_TGSI_FS_COORD_ORIGIN_LOWER_LEFT 37
414 #define PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_HALF_INTEGER 38
415 #define PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_INTEGER 39
419 * Referenced query flags.
422 #define PIPE_UNREFERENCED 0
423 #define PIPE_REFERENCED_FOR_READ (1 << 0)
424 #define PIPE_REFERENCED_FOR_WRITE (1 << 1)
427 enum pipe_video_codec
429 PIPE_VIDEO_CODEC_UNKNOWN
= 0,
430 PIPE_VIDEO_CODEC_MPEG12
, /**< MPEG1, MPEG2 */
431 PIPE_VIDEO_CODEC_MPEG4
, /**< DIVX, XVID */
432 PIPE_VIDEO_CODEC_VC1
, /**< WMV */
433 PIPE_VIDEO_CODEC_MPEG4_AVC
/**< H.264 */
436 enum pipe_video_profile
438 PIPE_VIDEO_PROFILE_MPEG1
,
439 PIPE_VIDEO_PROFILE_MPEG2_SIMPLE
,
440 PIPE_VIDEO_PROFILE_MPEG2_MAIN
,
441 PIPE_VIDEO_PROFILE_MPEG4_SIMPLE
,
442 PIPE_VIDEO_PROFILE_MPEG4_ADVANCED_SIMPLE
,
443 PIPE_VIDEO_PROFILE_VC1_SIMPLE
,
444 PIPE_VIDEO_PROFILE_VC1_MAIN
,
445 PIPE_VIDEO_PROFILE_VC1_ADVANCED
,
446 PIPE_VIDEO_PROFILE_MPEG4_AVC_BASELINE
,
447 PIPE_VIDEO_PROFILE_MPEG4_AVC_MAIN
,
448 PIPE_VIDEO_PROFILE_MPEG4_AVC_HIGH