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 **************************************************************************/
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.
47 PIPE_ERROR
= -1, /**< Generic error */
48 PIPE_ERROR_BAD_INPUT
= -2,
49 PIPE_ERROR_OUT_OF_MEMORY
= -3,
55 #define PIPE_BLENDFACTOR_ONE 0x1
56 #define PIPE_BLENDFACTOR_SRC_COLOR 0x2
57 #define PIPE_BLENDFACTOR_SRC_ALPHA 0x3
58 #define PIPE_BLENDFACTOR_DST_ALPHA 0x4
59 #define PIPE_BLENDFACTOR_DST_COLOR 0x5
60 #define PIPE_BLENDFACTOR_SRC_ALPHA_SATURATE 0x6
61 #define PIPE_BLENDFACTOR_CONST_COLOR 0x7
62 #define PIPE_BLENDFACTOR_CONST_ALPHA 0x8
63 #define PIPE_BLENDFACTOR_SRC1_COLOR 0x9
64 #define PIPE_BLENDFACTOR_SRC1_ALPHA 0x0A
65 #define PIPE_BLENDFACTOR_ZERO 0x11
66 #define PIPE_BLENDFACTOR_INV_SRC_COLOR 0x12
67 #define PIPE_BLENDFACTOR_INV_SRC_ALPHA 0x13
68 #define PIPE_BLENDFACTOR_INV_DST_ALPHA 0x14
69 #define PIPE_BLENDFACTOR_INV_DST_COLOR 0x15
70 #define PIPE_BLENDFACTOR_INV_CONST_COLOR 0x17
71 #define PIPE_BLENDFACTOR_INV_CONST_ALPHA 0x18
72 #define PIPE_BLENDFACTOR_INV_SRC1_COLOR 0x19
73 #define PIPE_BLENDFACTOR_INV_SRC1_ALPHA 0x1A
75 #define PIPE_BLEND_ADD 0
76 #define PIPE_BLEND_SUBTRACT 1
77 #define PIPE_BLEND_REVERSE_SUBTRACT 2
78 #define PIPE_BLEND_MIN 3
79 #define PIPE_BLEND_MAX 4
81 #define PIPE_LOGICOP_CLEAR 0
82 #define PIPE_LOGICOP_NOR 1
83 #define PIPE_LOGICOP_AND_INVERTED 2
84 #define PIPE_LOGICOP_COPY_INVERTED 3
85 #define PIPE_LOGICOP_AND_REVERSE 4
86 #define PIPE_LOGICOP_INVERT 5
87 #define PIPE_LOGICOP_XOR 6
88 #define PIPE_LOGICOP_NAND 7
89 #define PIPE_LOGICOP_AND 8
90 #define PIPE_LOGICOP_EQUIV 9
91 #define PIPE_LOGICOP_NOOP 10
92 #define PIPE_LOGICOP_OR_INVERTED 11
93 #define PIPE_LOGICOP_COPY 12
94 #define PIPE_LOGICOP_OR_REVERSE 13
95 #define PIPE_LOGICOP_OR 14
96 #define PIPE_LOGICOP_SET 15
98 #define PIPE_MASK_R 0x1
99 #define PIPE_MASK_G 0x2
100 #define PIPE_MASK_B 0x4
101 #define PIPE_MASK_A 0x8
102 #define PIPE_MASK_RGBA 0xf
103 #define PIPE_MASK_Z 0x10
104 #define PIPE_MASK_S 0x20
105 #define PIPE_MASK_ZS 0x30
106 #define PIPE_MASK_RGBAZS (PIPE_MASK_RGBA|PIPE_MASK_ZS)
110 * Inequality functions. Used for depth test, stencil compare, alpha
111 * test, shadow compare, etc.
113 #define PIPE_FUNC_NEVER 0
114 #define PIPE_FUNC_LESS 1
115 #define PIPE_FUNC_EQUAL 2
116 #define PIPE_FUNC_LEQUAL 3
117 #define PIPE_FUNC_GREATER 4
118 #define PIPE_FUNC_NOTEQUAL 5
119 #define PIPE_FUNC_GEQUAL 6
120 #define PIPE_FUNC_ALWAYS 7
122 /** Polygon fill mode */
123 #define PIPE_POLYGON_MODE_FILL 0
124 #define PIPE_POLYGON_MODE_LINE 1
125 #define PIPE_POLYGON_MODE_POINT 2
127 /** Polygon face specification, eg for culling */
128 #define PIPE_FACE_NONE 0
129 #define PIPE_FACE_FRONT 1
130 #define PIPE_FACE_BACK 2
131 #define PIPE_FACE_FRONT_AND_BACK (PIPE_FACE_FRONT | PIPE_FACE_BACK)
134 #define PIPE_STENCIL_OP_KEEP 0
135 #define PIPE_STENCIL_OP_ZERO 1
136 #define PIPE_STENCIL_OP_REPLACE 2
137 #define PIPE_STENCIL_OP_INCR 3
138 #define PIPE_STENCIL_OP_DECR 4
139 #define PIPE_STENCIL_OP_INCR_WRAP 5
140 #define PIPE_STENCIL_OP_DECR_WRAP 6
141 #define PIPE_STENCIL_OP_INVERT 7
144 * See the documentation for info on PIPE_TEXTURE_RECT vs PIPE_TEXTURE_2D
146 enum pipe_texture_target
152 PIPE_TEXTURE_CUBE
= 4,
153 PIPE_TEXTURE_RECT
= 5,
154 PIPE_TEXTURE_1D_ARRAY
= 6,
155 PIPE_TEXTURE_2D_ARRAY
= 7,
156 PIPE_TEXTURE_CUBE_ARRAY
= 8,
157 PIPE_MAX_TEXTURE_TYPES
160 #define PIPE_TEX_FACE_POS_X 0
161 #define PIPE_TEX_FACE_NEG_X 1
162 #define PIPE_TEX_FACE_POS_Y 2
163 #define PIPE_TEX_FACE_NEG_Y 3
164 #define PIPE_TEX_FACE_POS_Z 4
165 #define PIPE_TEX_FACE_NEG_Z 5
166 #define PIPE_TEX_FACE_MAX 6
168 #define PIPE_TEX_WRAP_REPEAT 0
169 #define PIPE_TEX_WRAP_CLAMP 1
170 #define PIPE_TEX_WRAP_CLAMP_TO_EDGE 2
171 #define PIPE_TEX_WRAP_CLAMP_TO_BORDER 3
172 #define PIPE_TEX_WRAP_MIRROR_REPEAT 4
173 #define PIPE_TEX_WRAP_MIRROR_CLAMP 5
174 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_EDGE 6
175 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_BORDER 7
177 /** Between mipmaps, ie mipfilter */
178 #define PIPE_TEX_MIPFILTER_NEAREST 0
179 #define PIPE_TEX_MIPFILTER_LINEAR 1
180 #define PIPE_TEX_MIPFILTER_NONE 2
182 /** Within a mipmap, ie min/mag filter */
183 #define PIPE_TEX_FILTER_NEAREST 0
184 #define PIPE_TEX_FILTER_LINEAR 1
186 #define PIPE_TEX_COMPARE_NONE 0
187 #define PIPE_TEX_COMPARE_R_TO_TEXTURE 1
192 #define PIPE_CLEAR_DEPTH (1 << 0)
193 #define PIPE_CLEAR_STENCIL (1 << 1)
194 #define PIPE_CLEAR_COLOR0 (1 << 2)
195 #define PIPE_CLEAR_COLOR1 (1 << 3)
196 #define PIPE_CLEAR_COLOR2 (1 << 4)
197 #define PIPE_CLEAR_COLOR3 (1 << 5)
198 #define PIPE_CLEAR_COLOR4 (1 << 6)
199 #define PIPE_CLEAR_COLOR5 (1 << 7)
200 #define PIPE_CLEAR_COLOR6 (1 << 8)
201 #define PIPE_CLEAR_COLOR7 (1 << 9)
202 /** Combined flags */
203 /** All color buffers currently bound */
204 #define PIPE_CLEAR_COLOR (PIPE_CLEAR_COLOR0 | PIPE_CLEAR_COLOR1 | \
205 PIPE_CLEAR_COLOR2 | PIPE_CLEAR_COLOR3 | \
206 PIPE_CLEAR_COLOR4 | PIPE_CLEAR_COLOR5 | \
207 PIPE_CLEAR_COLOR6 | PIPE_CLEAR_COLOR7)
208 #define PIPE_CLEAR_DEPTHSTENCIL (PIPE_CLEAR_DEPTH | PIPE_CLEAR_STENCIL)
211 * Transfer object usage flags
213 enum pipe_transfer_usage
216 * Resource contents read back (or accessed directly) at transfer
219 PIPE_TRANSFER_READ
= (1 << 0),
222 * Resource contents will be written back at transfer_unmap
223 * time (or modified as a result of being accessed directly).
225 PIPE_TRANSFER_WRITE
= (1 << 1),
230 PIPE_TRANSFER_READ_WRITE
= PIPE_TRANSFER_READ
| PIPE_TRANSFER_WRITE
,
233 * The transfer should map the texture storage directly. The driver may
234 * return NULL if that isn't possible, and the state tracker needs to cope
235 * with that and use an alternative path without this flag.
237 * E.g. the state tracker could have a simpler path which maps textures and
238 * does read/modify/write cycles on them directly, and a more complicated
239 * path which uses minimal read and write transfers.
241 PIPE_TRANSFER_MAP_DIRECTLY
= (1 << 2),
244 * Discards the memory within the mapped region.
246 * It should not be used with PIPE_TRANSFER_READ.
249 * - OpenGL's ARB_map_buffer_range extension, MAP_INVALIDATE_RANGE_BIT flag.
251 PIPE_TRANSFER_DISCARD_RANGE
= (1 << 8),
254 * Fail if the resource cannot be mapped immediately.
257 * - Direct3D's D3DLOCK_DONOTWAIT flag.
258 * - Mesa3D's MESA_MAP_NOWAIT_BIT flag.
259 * - WDDM's D3DDDICB_LOCKFLAGS.DonotWait flag.
261 PIPE_TRANSFER_DONTBLOCK
= (1 << 9),
264 * Do not attempt to synchronize pending operations on the resource when mapping.
266 * It should not be used with PIPE_TRANSFER_READ.
269 * - OpenGL's ARB_map_buffer_range extension, MAP_UNSYNCHRONIZED_BIT flag.
270 * - Direct3D's D3DLOCK_NOOVERWRITE flag.
271 * - WDDM's D3DDDICB_LOCKFLAGS.IgnoreSync flag.
273 PIPE_TRANSFER_UNSYNCHRONIZED
= (1 << 10),
276 * Written ranges will be notified later with
277 * pipe_context::transfer_flush_region.
279 * It should not be used with PIPE_TRANSFER_READ.
282 * - pipe_context::transfer_flush_region
283 * - OpenGL's ARB_map_buffer_range extension, MAP_FLUSH_EXPLICIT_BIT flag.
285 PIPE_TRANSFER_FLUSH_EXPLICIT
= (1 << 11),
288 * Discards all memory backing the resource.
290 * It should not be used with PIPE_TRANSFER_READ.
292 * This is equivalent to:
293 * - OpenGL's ARB_map_buffer_range extension, MAP_INVALIDATE_BUFFER_BIT
294 * - BufferData(NULL) on a GL buffer
295 * - Direct3D's D3DLOCK_DISCARD flag.
296 * - WDDM's D3DDDICB_LOCKFLAGS.Discard flag.
297 * - D3D10 DDI's D3D10_DDI_MAP_WRITE_DISCARD flag
298 * - D3D10's D3D10_MAP_WRITE_DISCARD flag.
300 PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE
= (1 << 12),
303 * Allows the resource to be used for rendering while mapped.
305 * PIPE_RESOURCE_FLAG_MAP_PERSISTENT must be set when creating
308 * If COHERENT is not set, memory_barrier(PIPE_BARRIER_MAPPED_BUFFER)
309 * must be called to ensure the device can see what the CPU has written.
311 PIPE_TRANSFER_PERSISTENT
= (1 << 13),
314 * If PERSISTENT is set, this ensures any writes done by the device are
315 * immediately visible to the CPU and vice versa.
317 * PIPE_RESOURCE_FLAG_MAP_COHERENT must be set when creating
320 PIPE_TRANSFER_COHERENT
= (1 << 14)
324 * Flags for the flush function.
326 enum pipe_flush_flags
328 PIPE_FLUSH_END_OF_FRAME
= (1 << 0)
332 * Flags for pipe_context::dump_debug_state.
334 #define PIPE_DEBUG_DEVICE_IS_HUNG (1 << 0)
337 * Create a compute-only context. Use in pipe_screen::context_create.
338 * This disables draw, blit, and clear*, render_condition, and other graphics
339 * functions. Interop with other graphics contexts is still allowed.
340 * This allows scheduling jobs on a compute-only hardware command queue that
341 * can run in parallel with graphics without stalling it.
343 #define PIPE_CONTEXT_COMPUTE_ONLY (1 << 0)
346 * Gather debug information and expect that pipe_context::dump_debug_state
347 * will be called. Use in pipe_screen::context_create.
349 #define PIPE_CONTEXT_DEBUG (1 << 1)
352 * Flags for pipe_context::memory_barrier.
354 #define PIPE_BARRIER_MAPPED_BUFFER (1 << 0)
355 #define PIPE_BARRIER_SHADER_BUFFER (1 << 1)
358 * Resource binding flags -- state tracker must specify in advance all
359 * the ways a resource might be used.
361 #define PIPE_BIND_DEPTH_STENCIL (1 << 0) /* create_surface */
362 #define PIPE_BIND_RENDER_TARGET (1 << 1) /* create_surface */
363 #define PIPE_BIND_BLENDABLE (1 << 2) /* create_surface */
364 #define PIPE_BIND_SAMPLER_VIEW (1 << 3) /* create_sampler_view */
365 #define PIPE_BIND_VERTEX_BUFFER (1 << 4) /* set_vertex_buffers */
366 #define PIPE_BIND_INDEX_BUFFER (1 << 5) /* draw_elements */
367 #define PIPE_BIND_CONSTANT_BUFFER (1 << 6) /* set_constant_buffer */
368 #define PIPE_BIND_DISPLAY_TARGET (1 << 7) /* flush_front_buffer */
369 #define PIPE_BIND_TRANSFER_WRITE (1 << 8) /* transfer_map */
370 #define PIPE_BIND_TRANSFER_READ (1 << 9) /* transfer_map */
371 #define PIPE_BIND_STREAM_OUTPUT (1 << 10) /* set_stream_output_buffers */
372 #define PIPE_BIND_CURSOR (1 << 11) /* mouse cursor */
373 #define PIPE_BIND_CUSTOM (1 << 12) /* state-tracker/winsys usages */
374 #define PIPE_BIND_GLOBAL (1 << 13) /* set_global_binding */
375 #define PIPE_BIND_SHADER_BUFFER (1 << 14) /* set_shader_buffers */
376 #define PIPE_BIND_SHADER_IMAGE (1 << 15) /* set_shader_images */
377 #define PIPE_BIND_COMPUTE_RESOURCE (1 << 16) /* set_compute_resources */
378 #define PIPE_BIND_COMMAND_ARGS_BUFFER (1 << 17) /* pipe_draw_info.indirect */
381 * The first two flags above were previously part of the amorphous
382 * TEXTURE_USAGE, most of which are now descriptions of the ways a
383 * particular texture can be bound to the gallium pipeline. The two flags
384 * below do not fit within that and probably need to be migrated to some
387 * It seems like scanout is used by the Xorg state tracker to ask for
388 * a texture suitable for actual scanout (hence the name), which
389 * implies extra layout constraints on some hardware. It may also
390 * have some special meaning regarding mouse cursor images.
392 * The shared flag is quite underspecified, but certainly isn't a
393 * binding flag - it seems more like a message to the winsys to create
394 * a shareable allocation.
396 * The third flag has been added to be able to force textures to be created
397 * in linear mode (no tiling).
399 #define PIPE_BIND_SCANOUT (1 << 18) /* */
400 #define PIPE_BIND_SHARED (1 << 19) /* get_texture_handle ??? */
401 #define PIPE_BIND_LINEAR (1 << 20)
405 * Flags for the driver about resource behaviour:
407 #define PIPE_RESOURCE_FLAG_MAP_PERSISTENT (1 << 0)
408 #define PIPE_RESOURCE_FLAG_MAP_COHERENT (1 << 1)
409 #define PIPE_RESOURCE_FLAG_DRV_PRIV (1 << 16) /* driver/winsys private */
410 #define PIPE_RESOURCE_FLAG_ST_PRIV (1 << 24) /* state-tracker/winsys private */
413 * Hint about the expected lifecycle of a resource.
414 * Sorted according to GPU vs CPU access.
416 #define PIPE_USAGE_DEFAULT 0 /* fast GPU access */
417 #define PIPE_USAGE_IMMUTABLE 1 /* fast GPU access, immutable */
418 #define PIPE_USAGE_DYNAMIC 2 /* uploaded data is used multiple times */
419 #define PIPE_USAGE_STREAM 3 /* uploaded data is used once */
420 #define PIPE_USAGE_STAGING 4 /* fast CPU access */
426 #define PIPE_SHADER_VERTEX 0
427 #define PIPE_SHADER_FRAGMENT 1
428 #define PIPE_SHADER_GEOMETRY 2
429 #define PIPE_SHADER_TESS_CTRL 3
430 #define PIPE_SHADER_TESS_EVAL 4
431 #define PIPE_SHADER_COMPUTE 5
432 #define PIPE_SHADER_TYPES 6
438 #define PIPE_PRIM_POINTS 0
439 #define PIPE_PRIM_LINES 1
440 #define PIPE_PRIM_LINE_LOOP 2
441 #define PIPE_PRIM_LINE_STRIP 3
442 #define PIPE_PRIM_TRIANGLES 4
443 #define PIPE_PRIM_TRIANGLE_STRIP 5
444 #define PIPE_PRIM_TRIANGLE_FAN 6
445 #define PIPE_PRIM_QUADS 7
446 #define PIPE_PRIM_QUAD_STRIP 8
447 #define PIPE_PRIM_POLYGON 9
448 #define PIPE_PRIM_LINES_ADJACENCY 10
449 #define PIPE_PRIM_LINE_STRIP_ADJACENCY 11
450 #define PIPE_PRIM_TRIANGLES_ADJACENCY 12
451 #define PIPE_PRIM_TRIANGLE_STRIP_ADJACENCY 13
452 #define PIPE_PRIM_PATCHES 14
453 #define PIPE_PRIM_MAX 15
457 * Tessellator spacing types
459 #define PIPE_TESS_SPACING_FRACTIONAL_ODD 0
460 #define PIPE_TESS_SPACING_FRACTIONAL_EVEN 1
461 #define PIPE_TESS_SPACING_EQUAL 2
466 #define PIPE_QUERY_OCCLUSION_COUNTER 0
467 #define PIPE_QUERY_OCCLUSION_PREDICATE 1
468 #define PIPE_QUERY_TIMESTAMP 2
469 #define PIPE_QUERY_TIMESTAMP_DISJOINT 3
470 #define PIPE_QUERY_TIME_ELAPSED 4
471 #define PIPE_QUERY_PRIMITIVES_GENERATED 5
472 #define PIPE_QUERY_PRIMITIVES_EMITTED 6
473 #define PIPE_QUERY_SO_STATISTICS 7
474 #define PIPE_QUERY_SO_OVERFLOW_PREDICATE 8
475 #define PIPE_QUERY_GPU_FINISHED 9
476 #define PIPE_QUERY_PIPELINE_STATISTICS 10
477 #define PIPE_QUERY_TYPES 11
478 /* start of driver queries, see pipe_screen::get_driver_query_info */
479 #define PIPE_QUERY_DRIVER_SPECIFIC 256
483 * Conditional rendering modes
485 #define PIPE_RENDER_COND_WAIT 0
486 #define PIPE_RENDER_COND_NO_WAIT 1
487 #define PIPE_RENDER_COND_BY_REGION_WAIT 2
488 #define PIPE_RENDER_COND_BY_REGION_NO_WAIT 3
492 * Point sprite coord modes
494 #define PIPE_SPRITE_COORD_UPPER_LEFT 0
495 #define PIPE_SPRITE_COORD_LOWER_LEFT 1
501 #define PIPE_SWIZZLE_RED 0
502 #define PIPE_SWIZZLE_GREEN 1
503 #define PIPE_SWIZZLE_BLUE 2
504 #define PIPE_SWIZZLE_ALPHA 3
505 #define PIPE_SWIZZLE_ZERO 4
506 #define PIPE_SWIZZLE_ONE 5
509 #define PIPE_TIMEOUT_INFINITE 0xffffffffffffffffull
513 * Device reset status.
515 enum pipe_reset_status
518 PIPE_GUILTY_CONTEXT_RESET
= 1,
519 PIPE_INNOCENT_CONTEXT_RESET
= 2,
520 PIPE_UNKNOWN_CONTEXT_RESET
= 3
525 * Implementation capabilities/limits which are queried through
526 * pipe_screen::get_param()
530 PIPE_CAP_NPOT_TEXTURES
,
531 PIPE_CAP_TWO_SIDED_STENCIL
,
532 PIPE_CAP_MAX_DUAL_SOURCE_RENDER_TARGETS
,
533 PIPE_CAP_ANISOTROPIC_FILTER
,
534 PIPE_CAP_POINT_SPRITE
,
535 PIPE_CAP_MAX_RENDER_TARGETS
,
536 PIPE_CAP_OCCLUSION_QUERY
,
537 PIPE_CAP_QUERY_TIME_ELAPSED
,
538 PIPE_CAP_TEXTURE_SHADOW_MAP
,
539 PIPE_CAP_TEXTURE_SWIZZLE
,
540 PIPE_CAP_MAX_TEXTURE_2D_LEVELS
,
541 PIPE_CAP_MAX_TEXTURE_3D_LEVELS
,
542 PIPE_CAP_MAX_TEXTURE_CUBE_LEVELS
,
543 PIPE_CAP_TEXTURE_MIRROR_CLAMP
,
544 PIPE_CAP_BLEND_EQUATION_SEPARATE
,
546 PIPE_CAP_MAX_STREAM_OUTPUT_BUFFERS
,
547 PIPE_CAP_PRIMITIVE_RESTART
,
548 /** blend enables and write masks per rendertarget */
549 PIPE_CAP_INDEP_BLEND_ENABLE
,
550 /** different blend funcs per rendertarget */
551 PIPE_CAP_INDEP_BLEND_FUNC
,
552 PIPE_CAP_MAX_TEXTURE_ARRAY_LAYERS
,
553 PIPE_CAP_TGSI_FS_COORD_ORIGIN_UPPER_LEFT
,
554 PIPE_CAP_TGSI_FS_COORD_ORIGIN_LOWER_LEFT
,
555 PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_HALF_INTEGER
,
556 PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_INTEGER
,
557 PIPE_CAP_DEPTH_CLIP_DISABLE
,
558 PIPE_CAP_SHADER_STENCIL_EXPORT
,
559 PIPE_CAP_TGSI_INSTANCEID
,
560 PIPE_CAP_VERTEX_ELEMENT_INSTANCE_DIVISOR
,
561 PIPE_CAP_FRAGMENT_COLOR_CLAMPED
,
562 PIPE_CAP_MIXED_COLORBUFFER_FORMATS
,
563 PIPE_CAP_SEAMLESS_CUBE_MAP
,
564 PIPE_CAP_SEAMLESS_CUBE_MAP_PER_TEXTURE
,
565 PIPE_CAP_MIN_TEXEL_OFFSET
,
566 PIPE_CAP_MAX_TEXEL_OFFSET
,
567 PIPE_CAP_CONDITIONAL_RENDER
,
568 PIPE_CAP_TEXTURE_BARRIER
,
569 PIPE_CAP_MAX_STREAM_OUTPUT_SEPARATE_COMPONENTS
,
570 PIPE_CAP_MAX_STREAM_OUTPUT_INTERLEAVED_COMPONENTS
,
571 PIPE_CAP_STREAM_OUTPUT_PAUSE_RESUME
,
572 PIPE_CAP_TGSI_CAN_COMPACT_CONSTANTS
,
573 PIPE_CAP_VERTEX_COLOR_UNCLAMPED
,
574 PIPE_CAP_VERTEX_COLOR_CLAMPED
,
575 PIPE_CAP_GLSL_FEATURE_LEVEL
,
576 PIPE_CAP_QUADS_FOLLOW_PROVOKING_VERTEX_CONVENTION
,
577 PIPE_CAP_USER_VERTEX_BUFFERS
,
578 PIPE_CAP_VERTEX_BUFFER_OFFSET_4BYTE_ALIGNED_ONLY
,
579 PIPE_CAP_VERTEX_BUFFER_STRIDE_4BYTE_ALIGNED_ONLY
,
580 PIPE_CAP_VERTEX_ELEMENT_SRC_OFFSET_4BYTE_ALIGNED_ONLY
,
582 PIPE_CAP_USER_INDEX_BUFFERS
,
583 PIPE_CAP_USER_CONSTANT_BUFFERS
,
584 PIPE_CAP_CONSTANT_BUFFER_OFFSET_ALIGNMENT
,
585 PIPE_CAP_START_INSTANCE
,
586 PIPE_CAP_QUERY_TIMESTAMP
,
587 PIPE_CAP_TEXTURE_MULTISAMPLE
,
588 PIPE_CAP_MIN_MAP_BUFFER_ALIGNMENT
,
589 PIPE_CAP_CUBE_MAP_ARRAY
,
590 PIPE_CAP_TEXTURE_BUFFER_OBJECTS
,
591 PIPE_CAP_TEXTURE_BUFFER_OFFSET_ALIGNMENT
,
592 PIPE_CAP_BUFFER_SAMPLER_VIEW_RGBA_ONLY
,
593 PIPE_CAP_TGSI_TEXCOORD
,
594 PIPE_CAP_PREFER_BLIT_BASED_TEXTURE_TRANSFER
,
595 PIPE_CAP_QUERY_PIPELINE_STATISTICS
,
596 PIPE_CAP_TEXTURE_BORDER_COLOR_QUIRK
,
597 PIPE_CAP_MAX_TEXTURE_BUFFER_SIZE
,
598 PIPE_CAP_MAX_VIEWPORTS
,
600 PIPE_CAP_MIXED_FRAMEBUFFER_SIZES
,
601 PIPE_CAP_TGSI_VS_LAYER_VIEWPORT
,
602 PIPE_CAP_MAX_GEOMETRY_OUTPUT_VERTICES
,
603 PIPE_CAP_MAX_GEOMETRY_TOTAL_OUTPUT_COMPONENTS
,
604 PIPE_CAP_MAX_TEXTURE_GATHER_COMPONENTS
,
605 PIPE_CAP_TEXTURE_GATHER_SM5
,
606 PIPE_CAP_BUFFER_MAP_PERSISTENT_COHERENT
,
607 PIPE_CAP_FAKE_SW_MSAA
,
608 PIPE_CAP_TEXTURE_QUERY_LOD
,
609 PIPE_CAP_MIN_TEXTURE_GATHER_OFFSET
,
610 PIPE_CAP_MAX_TEXTURE_GATHER_OFFSET
,
611 PIPE_CAP_SAMPLE_SHADING
,
612 PIPE_CAP_TEXTURE_GATHER_OFFSETS
,
613 PIPE_CAP_TGSI_VS_WINDOW_SPACE_POSITION
,
614 PIPE_CAP_MAX_VERTEX_STREAMS
,
615 PIPE_CAP_DRAW_INDIRECT
,
616 PIPE_CAP_TGSI_FS_FINE_DERIVATIVE
,
619 PIPE_CAP_ACCELERATED
,
620 PIPE_CAP_VIDEO_MEMORY
,
622 PIPE_CAP_CONDITIONAL_RENDER_INVERTED
,
623 PIPE_CAP_MAX_VERTEX_ATTRIB_STRIDE
,
624 PIPE_CAP_SAMPLER_VIEW_TARGET
,
626 PIPE_CAP_VERTEXID_NOBASE
,
627 PIPE_CAP_POLYGON_OFFSET_CLAMP
,
628 PIPE_CAP_MULTISAMPLE_Z_RESOLVE
,
629 PIPE_CAP_RESOURCE_FROM_USER_MEMORY
,
630 PIPE_CAP_DEVICE_RESET_STATUS_QUERY
,
631 PIPE_CAP_MAX_SHADER_PATCH_VARYINGS
,
632 PIPE_CAP_TEXTURE_FLOAT_LINEAR
,
633 PIPE_CAP_TEXTURE_HALF_FLOAT_LINEAR
,
634 PIPE_CAP_DEPTH_BOUNDS_TEST
,
636 PIPE_CAP_FORCE_PERSAMPLE_INTERP
,
637 PIPE_CAP_SHAREABLE_SHADERS
,
638 PIPE_CAP_COPY_BETWEEN_COMPRESSED_AND_PLAIN_FORMATS
,
639 PIPE_CAP_CLEAR_TEXTURE
,
640 PIPE_CAP_DRAW_PARAMETERS
,
641 PIPE_CAP_TGSI_PACK_HALF_FLOAT
,
642 PIPE_CAP_MULTI_DRAW_INDIRECT
,
643 PIPE_CAP_MULTI_DRAW_INDIRECT_PARAMS
,
644 PIPE_CAP_TGSI_FS_POSITION_IS_SYSVAL
,
645 PIPE_CAP_TGSI_FS_FACE_IS_INTEGER_SYSVAL
,
646 PIPE_CAP_SHADER_BUFFER_OFFSET_ALIGNMENT
,
647 PIPE_CAP_INVALIDATE_BUFFER
,
648 PIPE_CAP_GENERATE_MIPMAP
,
649 PIPE_CAP_STRING_MARKER
,
650 PIPE_CAP_SURFACE_REINTERPRET_BLOCKS
,
653 #define PIPE_QUIRK_TEXTURE_BORDER_COLOR_SWIZZLE_NV50 (1 << 0)
654 #define PIPE_QUIRK_TEXTURE_BORDER_COLOR_SWIZZLE_R600 (1 << 1)
658 PIPE_ENDIAN_LITTLE
= 0,
660 #if defined(PIPE_ARCH_LITTLE_ENDIAN)
661 PIPE_ENDIAN_NATIVE
= PIPE_ENDIAN_LITTLE
662 #elif defined(PIPE_ARCH_BIG_ENDIAN)
663 PIPE_ENDIAN_NATIVE
= PIPE_ENDIAN_BIG
668 * Implementation limits which are queried through
669 * pipe_screen::get_paramf()
673 PIPE_CAPF_MAX_LINE_WIDTH
,
674 PIPE_CAPF_MAX_LINE_WIDTH_AA
,
675 PIPE_CAPF_MAX_POINT_WIDTH
,
676 PIPE_CAPF_MAX_POINT_WIDTH_AA
,
677 PIPE_CAPF_MAX_TEXTURE_ANISOTROPY
,
678 PIPE_CAPF_MAX_TEXTURE_LOD_BIAS
,
679 PIPE_CAPF_GUARD_BAND_LEFT
,
680 PIPE_CAPF_GUARD_BAND_TOP
,
681 PIPE_CAPF_GUARD_BAND_RIGHT
,
682 PIPE_CAPF_GUARD_BAND_BOTTOM
685 /** Shader caps not specific to any single stage */
688 PIPE_SHADER_CAP_MAX_INSTRUCTIONS
, /* if 0, it means the stage is unsupported */
689 PIPE_SHADER_CAP_MAX_ALU_INSTRUCTIONS
,
690 PIPE_SHADER_CAP_MAX_TEX_INSTRUCTIONS
,
691 PIPE_SHADER_CAP_MAX_TEX_INDIRECTIONS
,
692 PIPE_SHADER_CAP_MAX_CONTROL_FLOW_DEPTH
,
693 PIPE_SHADER_CAP_MAX_INPUTS
,
694 PIPE_SHADER_CAP_MAX_OUTPUTS
,
695 PIPE_SHADER_CAP_MAX_CONST_BUFFER_SIZE
,
696 PIPE_SHADER_CAP_MAX_CONST_BUFFERS
,
697 PIPE_SHADER_CAP_MAX_TEMPS
,
698 PIPE_SHADER_CAP_MAX_PREDS
,
700 PIPE_SHADER_CAP_TGSI_CONT_SUPPORTED
,
701 PIPE_SHADER_CAP_INDIRECT_INPUT_ADDR
,
702 PIPE_SHADER_CAP_INDIRECT_OUTPUT_ADDR
,
703 PIPE_SHADER_CAP_INDIRECT_TEMP_ADDR
,
704 PIPE_SHADER_CAP_INDIRECT_CONST_ADDR
,
705 PIPE_SHADER_CAP_SUBROUTINES
, /* BGNSUB, ENDSUB, CAL, RET */
706 PIPE_SHADER_CAP_INTEGERS
,
707 PIPE_SHADER_CAP_MAX_TEXTURE_SAMPLERS
,
708 PIPE_SHADER_CAP_PREFERRED_IR
,
709 PIPE_SHADER_CAP_TGSI_SQRT_SUPPORTED
,
710 PIPE_SHADER_CAP_MAX_SAMPLER_VIEWS
,
711 PIPE_SHADER_CAP_DOUBLES
,
712 PIPE_SHADER_CAP_TGSI_DROUND_SUPPORTED
, /* all rounding modes */
713 PIPE_SHADER_CAP_TGSI_DFRACEXP_DLDEXP_SUPPORTED
,
714 PIPE_SHADER_CAP_TGSI_FMA_SUPPORTED
,
715 PIPE_SHADER_CAP_TGSI_ANY_INOUT_DECL_RANGE
,
716 PIPE_SHADER_CAP_MAX_UNROLL_ITERATIONS_HINT
,
717 PIPE_SHADER_CAP_MAX_SHADER_BUFFERS
,
721 * Shader intermediate representation.
727 PIPE_SHADER_IR_NATIVE
731 * Compute-specific implementation capability. They can be queried
732 * using pipe_screen::get_compute_param.
734 enum pipe_compute_cap
736 PIPE_COMPUTE_CAP_IR_TARGET
,
737 PIPE_COMPUTE_CAP_GRID_DIMENSION
,
738 PIPE_COMPUTE_CAP_MAX_GRID_SIZE
,
739 PIPE_COMPUTE_CAP_MAX_BLOCK_SIZE
,
740 PIPE_COMPUTE_CAP_MAX_THREADS_PER_BLOCK
,
741 PIPE_COMPUTE_CAP_MAX_GLOBAL_SIZE
,
742 PIPE_COMPUTE_CAP_MAX_LOCAL_SIZE
,
743 PIPE_COMPUTE_CAP_MAX_PRIVATE_SIZE
,
744 PIPE_COMPUTE_CAP_MAX_INPUT_SIZE
,
745 PIPE_COMPUTE_CAP_MAX_MEM_ALLOC_SIZE
,
746 PIPE_COMPUTE_CAP_MAX_CLOCK_FREQUENCY
,
747 PIPE_COMPUTE_CAP_MAX_COMPUTE_UNITS
,
748 PIPE_COMPUTE_CAP_IMAGES_SUPPORTED
,
749 PIPE_COMPUTE_CAP_SUBGROUP_SIZE
753 * Composite query types
757 * Query result for PIPE_QUERY_SO_STATISTICS.
759 struct pipe_query_data_so_statistics
761 uint64_t num_primitives_written
;
762 uint64_t primitives_storage_needed
;
766 * Query result for PIPE_QUERY_TIMESTAMP_DISJOINT.
768 struct pipe_query_data_timestamp_disjoint
775 * Query result for PIPE_QUERY_PIPELINE_STATISTICS.
777 struct pipe_query_data_pipeline_statistics
779 uint64_t ia_vertices
; /**< Num vertices read by the vertex fetcher. */
780 uint64_t ia_primitives
; /**< Num primitives read by the vertex fetcher. */
781 uint64_t vs_invocations
; /**< Num vertex shader invocations. */
782 uint64_t gs_invocations
; /**< Num geometry shader invocations. */
783 uint64_t gs_primitives
; /**< Num primitives output by a geometry shader. */
784 uint64_t c_invocations
; /**< Num primitives sent to the rasterizer. */
785 uint64_t c_primitives
; /**< Num primitives that were rendered. */
786 uint64_t ps_invocations
; /**< Num pixel shader invocations. */
787 uint64_t hs_invocations
; /**< Num hull shader invocations. */
788 uint64_t ds_invocations
; /**< Num domain shader invocations. */
789 uint64_t cs_invocations
; /**< Num compute shader invocations. */
795 union pipe_numeric_type_union
803 * Query result (returned by pipe_context::get_query_result).
805 union pipe_query_result
807 /* PIPE_QUERY_OCCLUSION_PREDICATE */
808 /* PIPE_QUERY_SO_OVERFLOW_PREDICATE */
809 /* PIPE_QUERY_GPU_FINISHED */
812 /* PIPE_QUERY_OCCLUSION_COUNTER */
813 /* PIPE_QUERY_TIMESTAMP */
814 /* PIPE_QUERY_TIME_ELAPSED */
815 /* PIPE_QUERY_PRIMITIVES_GENERATED */
816 /* PIPE_QUERY_PRIMITIVES_EMITTED */
817 /* PIPE_DRIVER_QUERY_TYPE_UINT64 */
818 /* PIPE_DRIVER_QUERY_TYPE_BYTES */
819 /* PIPE_DRIVER_QUERY_TYPE_MICROSECONDS */
820 /* PIPE_DRIVER_QUERY_TYPE_HZ */
823 /* PIPE_DRIVER_QUERY_TYPE_UINT */
826 /* PIPE_DRIVER_QUERY_TYPE_FLOAT */
827 /* PIPE_DRIVER_QUERY_TYPE_PERCENTAGE */
830 /* PIPE_QUERY_SO_STATISTICS */
831 struct pipe_query_data_so_statistics so_statistics
;
833 /* PIPE_QUERY_TIMESTAMP_DISJOINT */
834 struct pipe_query_data_timestamp_disjoint timestamp_disjoint
;
836 /* PIPE_QUERY_PIPELINE_STATISTICS */
837 struct pipe_query_data_pipeline_statistics pipeline_statistics
;
839 /* batch queries (variable length) */
840 union pipe_numeric_type_union batch
[1];
843 union pipe_color_union
850 enum pipe_driver_query_type
852 PIPE_DRIVER_QUERY_TYPE_UINT64
= 0,
853 PIPE_DRIVER_QUERY_TYPE_UINT
= 1,
854 PIPE_DRIVER_QUERY_TYPE_FLOAT
= 2,
855 PIPE_DRIVER_QUERY_TYPE_PERCENTAGE
= 3,
856 PIPE_DRIVER_QUERY_TYPE_BYTES
= 4,
857 PIPE_DRIVER_QUERY_TYPE_MICROSECONDS
= 5,
858 PIPE_DRIVER_QUERY_TYPE_HZ
= 6,
861 /* Whether an average value per frame or a cumulative value should be
864 enum pipe_driver_query_result_type
866 PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE
= 0,
867 PIPE_DRIVER_QUERY_RESULT_TYPE_CUMULATIVE
= 1,
871 * Some hardware requires some hardware-specific queries to be submitted
872 * as batched queries. The corresponding query objects are created using
873 * create_batch_query, and at most one such query may be active at
876 #define PIPE_DRIVER_QUERY_FLAG_BATCH (1 << 0)
878 /* Do not list this query in the HUD. */
879 #define PIPE_DRIVER_QUERY_FLAG_DONT_LIST (1 << 1)
881 struct pipe_driver_query_info
884 unsigned query_type
; /* PIPE_QUERY_DRIVER_SPECIFIC + i */
885 union pipe_numeric_type_union max_value
; /* max value that can be returned */
886 enum pipe_driver_query_type type
;
887 enum pipe_driver_query_result_type result_type
;
892 struct pipe_driver_query_group_info
895 unsigned max_active_queries
;
896 unsigned num_queries
;
901 PIPE_DEBUG_TYPE_OUT_OF_MEMORY
= 1,
902 PIPE_DEBUG_TYPE_ERROR
,
903 PIPE_DEBUG_TYPE_SHADER_INFO
,
904 PIPE_DEBUG_TYPE_PERF_INFO
,
905 PIPE_DEBUG_TYPE_INFO
,
906 PIPE_DEBUG_TYPE_FALLBACK
,
907 PIPE_DEBUG_TYPE_CONFORMANCE
,