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
31 #include "p_compiler.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 face specification, eg for culling */
123 #define PIPE_FACE_NONE 0
124 #define PIPE_FACE_FRONT 1
125 #define PIPE_FACE_BACK 2
126 #define PIPE_FACE_FRONT_AND_BACK (PIPE_FACE_FRONT | PIPE_FACE_BACK)
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 * See the documentation for info on PIPE_TEXTURE_RECT vs PIPE_TEXTURE_2D */
140 enum pipe_texture_target
{
145 PIPE_TEXTURE_CUBE
= 4,
146 PIPE_TEXTURE_RECT
= 5,
147 PIPE_MAX_TEXTURE_TYPES
150 #define PIPE_TEX_FACE_POS_X 0
151 #define PIPE_TEX_FACE_NEG_X 1
152 #define PIPE_TEX_FACE_POS_Y 2
153 #define PIPE_TEX_FACE_NEG_Y 3
154 #define PIPE_TEX_FACE_POS_Z 4
155 #define PIPE_TEX_FACE_NEG_Z 5
156 #define PIPE_TEX_FACE_MAX 6
158 #define PIPE_TEX_WRAP_REPEAT 0
159 #define PIPE_TEX_WRAP_CLAMP 1
160 #define PIPE_TEX_WRAP_CLAMP_TO_EDGE 2
161 #define PIPE_TEX_WRAP_CLAMP_TO_BORDER 3
162 #define PIPE_TEX_WRAP_MIRROR_REPEAT 4
163 #define PIPE_TEX_WRAP_MIRROR_CLAMP 5
164 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_EDGE 6
165 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_BORDER 7
167 /* Between mipmaps, ie mipfilter
169 #define PIPE_TEX_MIPFILTER_NEAREST 0
170 #define PIPE_TEX_MIPFILTER_LINEAR 1
171 #define PIPE_TEX_MIPFILTER_NONE 2
173 /* Within a mipmap, ie min/mag filter
175 #define PIPE_TEX_FILTER_NEAREST 0
176 #define PIPE_TEX_FILTER_LINEAR 1
178 #define PIPE_TEX_COMPARE_NONE 0
179 #define PIPE_TEX_COMPARE_R_TO_TEXTURE 1
183 * Surface layout -- a hint? Or some driver-internal poking out into
186 #define PIPE_SURFACE_LAYOUT_LINEAR 0
192 /** All color buffers currently bound */
193 #define PIPE_CLEAR_COLOR (1 << 0)
194 #define PIPE_CLEAR_DEPTH (1 << 1)
195 #define PIPE_CLEAR_STENCIL (1 << 2)
196 /** Depth/stencil combined */
197 #define PIPE_CLEAR_DEPTHSTENCIL (PIPE_CLEAR_DEPTH | PIPE_CLEAR_STENCIL)
200 * Transfer object usage flags
202 enum pipe_transfer_usage
{
204 * Resource contents read back (or accessed directly) at transfer
207 PIPE_TRANSFER_READ
= (1 << 0),
210 * Resource contents will be written back at transfer_destroy
211 * time (or modified as a result of being accessed directly).
213 PIPE_TRANSFER_WRITE
= (1 << 1),
218 PIPE_TRANSFER_READ_WRITE
= PIPE_TRANSFER_READ
| PIPE_TRANSFER_WRITE
,
221 * The transfer should map the texture storage directly. The driver may
222 * return NULL if that isn't possible, and the state tracker needs to cope
223 * with that and use an alternative path without this flag.
225 * E.g. the state tracker could have a simpler path which maps textures and
226 * does read/modify/write cycles on them directly, and a more complicated
227 * path which uses minimal read and write transfers.
229 PIPE_TRANSFER_MAP_DIRECTLY
= (1 << 2),
232 * Discards the memory within the mapped region.
234 * It should not be used with PIPE_TRANSFER_CPU_READ.
237 * - OpenGL's ARB_map_buffer_range extension, MAP_INVALIDATE_RANGE_BIT flag.
238 * - Direct3D's D3DLOCK_DISCARD flag.
240 PIPE_TRANSFER_DISCARD
= (1 << 8),
243 * Fail if the resource cannot be mapped immediately.
246 * - Direct3D's D3DLOCK_DONOTWAIT flag.
247 * - Mesa3D's MESA_MAP_NOWAIT_BIT flag.
248 * - WDDM's D3DDDICB_LOCKFLAGS.DonotWait flag.
250 PIPE_TRANSFER_DONTBLOCK
= (1 << 9),
253 * Do not attempt to synchronize pending operations on the resource when mapping.
255 * It should not be used with PIPE_TRANSFER_CPU_READ.
258 * - OpenGL's ARB_map_buffer_range extension, MAP_UNSYNCHRONIZED_BIT flag.
259 * - Direct3D's D3DLOCK_NOOVERWRITE flag.
260 * - WDDM's D3DDDICB_LOCKFLAGS.IgnoreSync flag.
262 PIPE_TRANSFER_UNSYNCHRONIZED
= (1 << 10),
263 PIPE_TRANSFER_NOOVERWRITE
= (1 << 10), /* are these really the same?? */
266 * Written ranges will be notified later with
267 * pipe_context::transfer_flush_region.
269 * It should not be used with PIPE_TRANSFER_CPU_READ.
272 * - pipe_context::transfer_flush_region
273 * - OpenGL's ARB_map_buffer_range extension, MAP_FLUSH_EXPLICIT_BIT flag.
275 PIPE_TRANSFER_FLUSH_EXPLICIT
= (1 << 11)
281 * Resource binding flags -- state tracker must specify in advance all
282 * the ways a resource might be used.
284 #define PIPE_BIND_DEPTH_STENCIL (1 << 0) /* get_tex_surface */
285 #define PIPE_BIND_RENDER_TARGET (1 << 1) /* get_tex_surface */
286 #define PIPE_BIND_SAMPLER_VIEW (1 << 2) /* get_sampler_view */
287 #define PIPE_BIND_VERTEX_BUFFER (1 << 3) /* set_vertex_buffers */
288 #define PIPE_BIND_INDEX_BUFFER (1 << 4) /* draw_elements */
289 #define PIPE_BIND_CONSTANT_BUFFER (1 << 5) /* set_constant_buffer */
290 #define PIPE_BIND_DISPLAY_TARGET (1 << 8) /* flush_front_buffer */
291 #define PIPE_BIND_TRANSFER_WRITE (1 << 9) /* get_transfer */
292 #define PIPE_BIND_TRANSFER_READ (1 << 10) /* get_transfer */
293 #define PIPE_BIND_STREAM_OUTPUT (1 << 11) /* set_stream_output_buffers */
294 #define PIPE_BIND_CUSTOM (1 << 16) /* state-tracker/winsys usages */
296 /* The first two flags above were previously part of the amorphous
297 * TEXTURE_USAGE, most of which are now descriptions of the ways a
298 * particular texture can be bound to the gallium pipeline. The two flags
299 * below do not fit within that and probably need to be migrated to some
302 * It seems like scanout is used by the Xorg state tracker to ask for
303 * a texture suitable for actual scanout (hence the name), which
304 * implies extra layout constraints on some hardware. It may also
305 * have some special meaning regarding mouse cursor images.
307 * The shared flag is quite underspecified, but certainly isn't a
308 * binding flag - it seems more like a message to the winsys to create
309 * a shareable allocation.
311 #define PIPE_BIND_SCANOUT (1 << 14) /* */
312 #define PIPE_BIND_SHARED (1 << 15) /* get_texture_handle ??? */
315 /* Flags for the driver about resource behaviour:
317 #define PIPE_RESOURCE_FLAG_GEN_MIPS (1 << 0) /* Driver performs autogen mips */
318 #define PIPE_RESOURCE_FLAG_DRV_PRIV (1 << 16) /* driver/winsys private */
319 #define PIPE_RESOURCE_FLAG_ST_PRIV (1 << 24) /* state-tracker/winsys private */
321 /* Hint about the expected lifecycle of a resource.
323 #define PIPE_USAGE_DEFAULT 0 /* many uploads, draws intermixed */
324 #define PIPE_USAGE_DYNAMIC 1 /* many uploads, draws intermixed */
325 #define PIPE_USAGE_STATIC 2 /* same as immutable?? */
326 #define PIPE_USAGE_IMMUTABLE 3 /* no change after first upload */
327 #define PIPE_USAGE_STREAM 4 /* upload, draw, upload, draw */
328 #define PIPE_USAGE_STAGING 5 /* supports data transfers from the GPU to the CPU */
331 /* These are intended to be used in calls to is_format_supported, but
332 * no driver actually uses these flags, and only the glx/xlib state
333 * tracker issues them.
337 #define PIPE_TEXTURE_GEOM_NON_SQUARE 0x1
338 #define PIPE_TEXTURE_GEOM_NON_POWER_OF_TWO 0x2
344 #define PIPE_FLUSH_RENDER_CACHE 0x1
345 #define PIPE_FLUSH_TEXTURE_CACHE 0x2
346 #define PIPE_FLUSH_SWAPBUFFERS 0x4
347 #define PIPE_FLUSH_FRAME 0x8 /**< Mark the end of a frame */
353 #define PIPE_SHADER_VERTEX 0
354 #define PIPE_SHADER_FRAGMENT 1
355 #define PIPE_SHADER_GEOMETRY 2
356 #define PIPE_SHADER_TYPES 3
362 #define PIPE_PRIM_POINTS 0
363 #define PIPE_PRIM_LINES 1
364 #define PIPE_PRIM_LINE_LOOP 2
365 #define PIPE_PRIM_LINE_STRIP 3
366 #define PIPE_PRIM_TRIANGLES 4
367 #define PIPE_PRIM_TRIANGLE_STRIP 5
368 #define PIPE_PRIM_TRIANGLE_FAN 6
369 #define PIPE_PRIM_QUADS 7
370 #define PIPE_PRIM_QUAD_STRIP 8
371 #define PIPE_PRIM_POLYGON 9
372 #define PIPE_PRIM_LINES_ADJACENCY 10
373 #define PIPE_PRIM_LINE_STRIP_ADJACENCY 11
374 #define PIPE_PRIM_TRIANGLES_ADJACENCY 12
375 #define PIPE_PRIM_TRIANGLE_STRIP_ADJACENCY 13
376 #define PIPE_PRIM_MAX 14
382 #define PIPE_QUERY_OCCLUSION_COUNTER 0
383 #define PIPE_QUERY_PRIMITIVES_GENERATED 1
384 #define PIPE_QUERY_PRIMITIVES_EMITTED 2
385 #define PIPE_QUERY_TIME_ELAPSED 3
386 #define PIPE_QUERY_SO_STATISTICS 5
387 #define PIPE_QUERY_GPU_FINISHED 6
388 #define PIPE_QUERY_TIMESTAMP_DISJOINT 7
389 #define PIPE_QUERY_TYPES 8
393 * Conditional rendering modes
395 #define PIPE_RENDER_COND_WAIT 0
396 #define PIPE_RENDER_COND_NO_WAIT 1
397 #define PIPE_RENDER_COND_BY_REGION_WAIT 2
398 #define PIPE_RENDER_COND_BY_REGION_NO_WAIT 3
402 * Point sprite coord modes
404 #define PIPE_SPRITE_COORD_UPPER_LEFT 0
405 #define PIPE_SPRITE_COORD_LOWER_LEFT 1
411 #define PIPE_SWIZZLE_RED 0
412 #define PIPE_SWIZZLE_GREEN 1
413 #define PIPE_SWIZZLE_BLUE 2
414 #define PIPE_SWIZZLE_ALPHA 3
415 #define PIPE_SWIZZLE_ZERO 4
416 #define PIPE_SWIZZLE_ONE 5
420 * Implementation capabilities/limits which are queried through
421 * pipe_screen::get_param() and pipe_screen::get_paramf().
424 PIPE_CAP_MAX_TEXTURE_IMAGE_UNITS
,
425 PIPE_CAP_NPOT_TEXTURES
,
426 PIPE_CAP_TWO_SIDED_STENCIL
,
427 PIPE_CAP_GLSL
, /* XXX need something better */
428 PIPE_CAP_DUAL_SOURCE_BLEND
,
429 PIPE_CAP_ANISOTROPIC_FILTER
,
430 PIPE_CAP_POINT_SPRITE
,
431 PIPE_CAP_MAX_RENDER_TARGETS
,
432 PIPE_CAP_OCCLUSION_QUERY
,
433 PIPE_CAP_TIMER_QUERY
,
434 PIPE_CAP_TEXTURE_SHADOW_MAP
,
435 PIPE_CAP_TEXTURE_SWIZZLE
,
436 PIPE_CAP_MAX_TEXTURE_2D_LEVELS
,
437 PIPE_CAP_MAX_TEXTURE_3D_LEVELS
,
438 PIPE_CAP_MAX_TEXTURE_CUBE_LEVELS
,
439 PIPE_CAP_MAX_LINE_WIDTH
,
440 PIPE_CAP_MAX_LINE_WIDTH_AA
,
441 PIPE_CAP_MAX_POINT_WIDTH
,
442 PIPE_CAP_MAX_POINT_WIDTH_AA
,
443 PIPE_CAP_MAX_TEXTURE_ANISOTROPY
,
444 PIPE_CAP_MAX_TEXTURE_LOD_BIAS
,
445 PIPE_CAP_GUARD_BAND_LEFT
, /*< float */
446 PIPE_CAP_GUARD_BAND_TOP
, /*< float */
447 PIPE_CAP_GUARD_BAND_RIGHT
, /*< float */
448 PIPE_CAP_GUARD_BAND_BOTTOM
, /*< float */
449 PIPE_CAP_TEXTURE_MIRROR_CLAMP
,
450 PIPE_CAP_TEXTURE_MIRROR_REPEAT
,
451 PIPE_CAP_MAX_VERTEX_TEXTURE_UNITS
,
452 PIPE_CAP_BLEND_EQUATION_SEPARATE
,
453 PIPE_CAP_SM3
, /*< Shader Model, supported */
454 PIPE_CAP_STREAM_OUTPUT
,
455 PIPE_CAP_PRIMITIVE_RESTART
,
456 /** Maximum texture image units accessible from vertex and fragment shaders
458 PIPE_CAP_MAX_COMBINED_SAMPLERS
,
459 /** blend enables and write masks per rendertarget */
460 PIPE_CAP_INDEP_BLEND_ENABLE
,
461 /** different blend funcs per rendertarget */
462 PIPE_CAP_INDEP_BLEND_FUNC
,
463 PIPE_CAP_DEPTHSTENCIL_CLEAR_SEPARATE
,
464 PIPE_CAP_TGSI_FS_COORD_ORIGIN_UPPER_LEFT
,
465 PIPE_CAP_TGSI_FS_COORD_ORIGIN_LOWER_LEFT
,
466 PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_HALF_INTEGER
,
467 PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_INTEGER
,
468 PIPE_CAP_DEPTH_CLAMP
,
469 PIPE_CAP_SHADER_STENCIL_EXPORT
,
472 /* Shader caps not specific to any single stage */
475 PIPE_SHADER_CAP_MAX_INSTRUCTIONS
, /* if 0, it means the stage is unsupported */
476 PIPE_SHADER_CAP_MAX_ALU_INSTRUCTIONS
,
477 PIPE_SHADER_CAP_MAX_TEX_INSTRUCTIONS
,
478 PIPE_SHADER_CAP_MAX_TEX_INDIRECTIONS
,
479 PIPE_SHADER_CAP_MAX_CONTROL_FLOW_DEPTH
,
480 PIPE_SHADER_CAP_MAX_INPUTS
,
481 PIPE_SHADER_CAP_MAX_CONSTS
,
482 PIPE_SHADER_CAP_MAX_CONST_BUFFERS
,
483 PIPE_SHADER_CAP_MAX_TEMPS
,
484 PIPE_SHADER_CAP_MAX_ADDRS
,
485 PIPE_SHADER_CAP_MAX_PREDS
,
486 PIPE_SHADER_CAP_TGSI_CONT_SUPPORTED
,
490 * Referenced query flags.
493 #define PIPE_UNREFERENCED 0
494 #define PIPE_REFERENCED_FOR_READ (1 << 0)
495 #define PIPE_REFERENCED_FOR_WRITE (1 << 1)
498 * Composite query types
500 struct pipe_query_data_so_statistics
502 uint64_t num_primitives_written
;
503 uint64_t primitives_storage_needed
;
505 struct pipe_query_data_timestamp_disjoint