src/gallium/include/pipe/p_defines.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   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:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  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.
  25  *
  26  **************************************************************************/
  27
  28 #ifndef PIPE_DEFINES_H
  29 #define PIPE_DEFINES_H
  30
  31 #include "p_compiler.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /**
  38  * Gallium error codes.
  39  *
  40  * - A zero value always means success.
  41  * - A negative value always means failure.
  42  * - The meaning of a positive value is function dependent.
  43  */
  44 enum pipe_error
  45 {
  46    PIPE_OK = 0,
  47    PIPE_ERROR = -1,    /**< Generic error */
  48    PIPE_ERROR_BAD_INPUT = -2,
  49    PIPE_ERROR_OUT_OF_MEMORY = -3,
  50    PIPE_ERROR_RETRY = -4
  51    /* TODO */
  52 };
  53
  54 enum pipe_blendfactor {
  55    PIPE_BLENDFACTOR_ONE = 1,
  56    PIPE_BLENDFACTOR_SRC_COLOR,
  57    PIPE_BLENDFACTOR_SRC_ALPHA,
  58    PIPE_BLENDFACTOR_DST_ALPHA,
  59    PIPE_BLENDFACTOR_DST_COLOR,
  60    PIPE_BLENDFACTOR_SRC_ALPHA_SATURATE,
  61    PIPE_BLENDFACTOR_CONST_COLOR,
  62    PIPE_BLENDFACTOR_CONST_ALPHA,
  63    PIPE_BLENDFACTOR_SRC1_COLOR,
  64    PIPE_BLENDFACTOR_SRC1_ALPHA,
  65
  66    PIPE_BLENDFACTOR_ZERO = 0x11,
  67    PIPE_BLENDFACTOR_INV_SRC_COLOR,
  68    PIPE_BLENDFACTOR_INV_SRC_ALPHA,
  69    PIPE_BLENDFACTOR_INV_DST_ALPHA,
  70    PIPE_BLENDFACTOR_INV_DST_COLOR,
  71
  72    PIPE_BLENDFACTOR_INV_CONST_COLOR = 0x17,
  73    PIPE_BLENDFACTOR_INV_CONST_ALPHA,
  74    PIPE_BLENDFACTOR_INV_SRC1_COLOR,
  75    PIPE_BLENDFACTOR_INV_SRC1_ALPHA,
  76 };
  77
  78 enum pipe_blend_func {
  79    PIPE_BLEND_ADD,
  80    PIPE_BLEND_SUBTRACT,
  81    PIPE_BLEND_REVERSE_SUBTRACT,
  82    PIPE_BLEND_MIN,
  83    PIPE_BLEND_MAX,
  84 };
  85
  86 enum pipe_logicop {
  87    PIPE_LOGICOP_CLEAR,
  88    PIPE_LOGICOP_NOR,
  89    PIPE_LOGICOP_AND_INVERTED,
  90    PIPE_LOGICOP_COPY_INVERTED,
  91    PIPE_LOGICOP_AND_REVERSE,
  92    PIPE_LOGICOP_INVERT,
  93    PIPE_LOGICOP_XOR,
  94    PIPE_LOGICOP_NAND,
  95    PIPE_LOGICOP_AND,
  96    PIPE_LOGICOP_EQUIV,
  97    PIPE_LOGICOP_NOOP,
  98    PIPE_LOGICOP_OR_INVERTED,
  99    PIPE_LOGICOP_COPY,
 100    PIPE_LOGICOP_OR_REVERSE,
 101    PIPE_LOGICOP_OR,
 102    PIPE_LOGICOP_SET,
 103 };
 104
 105 #define PIPE_MASK_R  0x1
 106 #define PIPE_MASK_G  0x2
 107 #define PIPE_MASK_B  0x4
 108 #define PIPE_MASK_A  0x8
 109 #define PIPE_MASK_RGBA 0xf
 110 #define PIPE_MASK_Z  0x10
 111 #define PIPE_MASK_S  0x20
 112 #define PIPE_MASK_ZS 0x30
 113 #define PIPE_MASK_RGBAZS (PIPE_MASK_RGBA|PIPE_MASK_ZS)
 114
 115
 116 /**
 117  * Inequality functions.  Used for depth test, stencil compare, alpha
 118  * test, shadow compare, etc.
 119  */
 120 enum pipe_compare_func {
 121    PIPE_FUNC_NEVER,
 122    PIPE_FUNC_LESS,
 123    PIPE_FUNC_EQUAL,
 124    PIPE_FUNC_LEQUAL,
 125    PIPE_FUNC_GREATER,
 126    PIPE_FUNC_NOTEQUAL,
 127    PIPE_FUNC_GEQUAL,
 128    PIPE_FUNC_ALWAYS,
 129 };
 130
 131 /** Polygon fill mode */
 132 enum {
 133    PIPE_POLYGON_MODE_FILL,
 134    PIPE_POLYGON_MODE_LINE,
 135    PIPE_POLYGON_MODE_POINT,
 136    PIPE_POLYGON_MODE_FILL_RECTANGLE,
 137 };
 138
 139 /** Polygon face specification, eg for culling */
 140 #define PIPE_FACE_NONE           0
 141 #define PIPE_FACE_FRONT          1
 142 #define PIPE_FACE_BACK           2
 143 #define PIPE_FACE_FRONT_AND_BACK (PIPE_FACE_FRONT | PIPE_FACE_BACK)
 144
 145 /** Stencil ops */
 146 enum pipe_stencil_op {
 147    PIPE_STENCIL_OP_KEEP,
 148    PIPE_STENCIL_OP_ZERO,
 149    PIPE_STENCIL_OP_REPLACE,
 150    PIPE_STENCIL_OP_INCR,
 151    PIPE_STENCIL_OP_DECR,
 152    PIPE_STENCIL_OP_INCR_WRAP,
 153    PIPE_STENCIL_OP_DECR_WRAP,
 154    PIPE_STENCIL_OP_INVERT,
 155 };
 156
 157 /** Texture types.
 158  * See the documentation for info on PIPE_TEXTURE_RECT vs PIPE_TEXTURE_2D
 159  */
 160 enum pipe_texture_target
 161 {
 162    PIPE_BUFFER,
 163    PIPE_TEXTURE_1D,
 164    PIPE_TEXTURE_2D,
 165    PIPE_TEXTURE_3D,
 166    PIPE_TEXTURE_CUBE,
 167    PIPE_TEXTURE_RECT,
 168    PIPE_TEXTURE_1D_ARRAY,
 169    PIPE_TEXTURE_2D_ARRAY,
 170    PIPE_TEXTURE_CUBE_ARRAY,
 171    PIPE_MAX_TEXTURE_TYPES,
 172 };
 173
 174 enum pipe_tex_face {
 175    PIPE_TEX_FACE_POS_X,
 176    PIPE_TEX_FACE_NEG_X,
 177    PIPE_TEX_FACE_POS_Y,
 178    PIPE_TEX_FACE_NEG_Y,
 179    PIPE_TEX_FACE_POS_Z,
 180    PIPE_TEX_FACE_NEG_Z,
 181    PIPE_TEX_FACE_MAX,
 182 };
 183
 184 enum pipe_tex_wrap {
 185    PIPE_TEX_WRAP_REPEAT,
 186    PIPE_TEX_WRAP_CLAMP,
 187    PIPE_TEX_WRAP_CLAMP_TO_EDGE,
 188    PIPE_TEX_WRAP_CLAMP_TO_BORDER,
 189    PIPE_TEX_WRAP_MIRROR_REPEAT,
 190    PIPE_TEX_WRAP_MIRROR_CLAMP,
 191    PIPE_TEX_WRAP_MIRROR_CLAMP_TO_EDGE,
 192    PIPE_TEX_WRAP_MIRROR_CLAMP_TO_BORDER,
 193 };
 194
 195 /** Between mipmaps, ie mipfilter */
 196 enum pipe_tex_mipfilter {
 197    PIPE_TEX_MIPFILTER_NEAREST,
 198    PIPE_TEX_MIPFILTER_LINEAR,
 199    PIPE_TEX_MIPFILTER_NONE,
 200 };
 201
 202 /** Within a mipmap, ie min/mag filter */
 203 enum pipe_tex_filter {
 204    PIPE_TEX_FILTER_NEAREST,
 205    PIPE_TEX_FILTER_LINEAR,
 206 };
 207
 208 enum pipe_tex_compare {
 209    PIPE_TEX_COMPARE_NONE,
 210    PIPE_TEX_COMPARE_R_TO_TEXTURE,
 211 };
 212
 213 /**
 214  * Clear buffer bits
 215  */
 216 #define PIPE_CLEAR_DEPTH        (1 << 0)
 217 #define PIPE_CLEAR_STENCIL      (1 << 1)
 218 #define PIPE_CLEAR_COLOR0       (1 << 2)
 219 #define PIPE_CLEAR_COLOR1       (1 << 3)
 220 #define PIPE_CLEAR_COLOR2       (1 << 4)
 221 #define PIPE_CLEAR_COLOR3       (1 << 5)
 222 #define PIPE_CLEAR_COLOR4       (1 << 6)
 223 #define PIPE_CLEAR_COLOR5       (1 << 7)
 224 #define PIPE_CLEAR_COLOR6       (1 << 8)
 225 #define PIPE_CLEAR_COLOR7       (1 << 9)
 226 /** Combined flags */
 227 /** All color buffers currently bound */
 228 #define PIPE_CLEAR_COLOR        (PIPE_CLEAR_COLOR0 | PIPE_CLEAR_COLOR1 | \
 229                                  PIPE_CLEAR_COLOR2 | PIPE_CLEAR_COLOR3 | \
 230                                  PIPE_CLEAR_COLOR4 | PIPE_CLEAR_COLOR5 | \
 231                                  PIPE_CLEAR_COLOR6 | PIPE_CLEAR_COLOR7)
 232 #define PIPE_CLEAR_DEPTHSTENCIL (PIPE_CLEAR_DEPTH | PIPE_CLEAR_STENCIL)
 233
 234 /**
 235  * Transfer object usage flags
 236  */
 237 enum pipe_transfer_usage
 238 {
 239    /**
 240     * Resource contents read back (or accessed directly) at transfer
 241     * create time.
 242     */
 243    PIPE_TRANSFER_READ = (1 << 0),
 244
 245    /**
 246     * Resource contents will be written back at transfer_unmap
 247     * time (or modified as a result of being accessed directly).
 248     */
 249    PIPE_TRANSFER_WRITE = (1 << 1),
 250
 251    /**
 252     * Read/modify/write
 253     */
 254    PIPE_TRANSFER_READ_WRITE = PIPE_TRANSFER_READ | PIPE_TRANSFER_WRITE,
 255
 256    /**
 257     * The transfer should map the texture storage directly. The driver may
 258     * return NULL if that isn't possible, and the state tracker needs to cope
 259     * with that and use an alternative path without this flag.
 260     *
 261     * E.g. the state tracker could have a simpler path which maps textures and
 262     * does read/modify/write cycles on them directly, and a more complicated
 263     * path which uses minimal read and write transfers.
 264     *
 265     * This flag supresses implicit "DISCARD" for buffer_subdata.
 266     */
 267    PIPE_TRANSFER_MAP_DIRECTLY = (1 << 2),
 268
 269    /**
 270     * Discards the memory within the mapped region.
 271     *
 272     * It should not be used with PIPE_TRANSFER_READ.
 273     *
 274     * See also:
 275     * - OpenGL's ARB_map_buffer_range extension, MAP_INVALIDATE_RANGE_BIT flag.
 276     */
 277    PIPE_TRANSFER_DISCARD_RANGE = (1 << 8),
 278
 279    /**
 280     * Fail if the resource cannot be mapped immediately.
 281     *
 282     * See also:
 283     * - Direct3D's D3DLOCK_DONOTWAIT flag.
 284     * - Mesa's MESA_MAP_NOWAIT_BIT flag.
 285     * - WDDM's D3DDDICB_LOCKFLAGS.DonotWait flag.
 286     */
 287    PIPE_TRANSFER_DONTBLOCK = (1 << 9),
 288
 289    /**
 290     * Do not attempt to synchronize pending operations on the resource when mapping.
 291     *
 292     * It should not be used with PIPE_TRANSFER_READ.
 293     *
 294     * See also:
 295     * - OpenGL's ARB_map_buffer_range extension, MAP_UNSYNCHRONIZED_BIT flag.
 296     * - Direct3D's D3DLOCK_NOOVERWRITE flag.
 297     * - WDDM's D3DDDICB_LOCKFLAGS.IgnoreSync flag.
 298     */
 299    PIPE_TRANSFER_UNSYNCHRONIZED = (1 << 10),
 300
 301    /**
 302     * Written ranges will be notified later with
 303     * pipe_context::transfer_flush_region.
 304     *
 305     * It should not be used with PIPE_TRANSFER_READ.
 306     *
 307     * See also:
 308     * - pipe_context::transfer_flush_region
 309     * - OpenGL's ARB_map_buffer_range extension, MAP_FLUSH_EXPLICIT_BIT flag.
 310     */
 311    PIPE_TRANSFER_FLUSH_EXPLICIT = (1 << 11),
 312
 313    /**
 314     * Discards all memory backing the resource.
 315     *
 316     * It should not be used with PIPE_TRANSFER_READ.
 317     *
 318     * This is equivalent to:
 319     * - OpenGL's ARB_map_buffer_range extension, MAP_INVALIDATE_BUFFER_BIT
 320     * - BufferData(NULL) on a GL buffer
 321     * - Direct3D's D3DLOCK_DISCARD flag.
 322     * - WDDM's D3DDDICB_LOCKFLAGS.Discard flag.
 323     * - D3D10 DDI's D3D10_DDI_MAP_WRITE_DISCARD flag
 324     * - D3D10's D3D10_MAP_WRITE_DISCARD flag.
 325     */
 326    PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE = (1 << 12),
 327
 328    /**
 329     * Allows the resource to be used for rendering while mapped.
 330     *
 331     * PIPE_RESOURCE_FLAG_MAP_PERSISTENT must be set when creating
 332     * the resource.
 333     *
 334     * If COHERENT is not set, memory_barrier(PIPE_BARRIER_MAPPED_BUFFER)
 335     * must be called to ensure the device can see what the CPU has written.
 336     */
 337    PIPE_TRANSFER_PERSISTENT = (1 << 13),
 338
 339    /**
 340     * If PERSISTENT is set, this ensures any writes done by the device are
 341     * immediately visible to the CPU and vice versa.
 342     *
 343     * PIPE_RESOURCE_FLAG_MAP_COHERENT must be set when creating
 344     * the resource.
 345     */
 346    PIPE_TRANSFER_COHERENT = (1 << 14),
 347
 348    /**
 349     * This and higher bits are reserved for private use by drivers. Drivers
 350     * should use this as (PIPE_TRANSFER_DRV_PRV << i).
 351     */
 352    PIPE_TRANSFER_DRV_PRV = (1 << 24)
 353 };
 354
 355 /**
 356  * Flags for the flush function.
 357  */
 358 enum pipe_flush_flags
 359 {
 360    PIPE_FLUSH_END_OF_FRAME = (1 << 0),
 361    PIPE_FLUSH_DEFERRED = (1 << 1),
 362    PIPE_FLUSH_FENCE_FD = (1 << 2),
 363    PIPE_FLUSH_ASYNC = (1 << 3),
 364    PIPE_FLUSH_HINT_FINISH = (1 << 4),
 365    PIPE_FLUSH_TOP_OF_PIPE = (1 << 5),
 366    PIPE_FLUSH_BOTTOM_OF_PIPE = (1 << 6),
 367 };
 368
 369 /**
 370  * Flags for pipe_context::dump_debug_state.
 371  */
 372 #define PIPE_DUMP_DEVICE_STATUS_REGISTERS    (1 << 0)
 373
 374 /**
 375  * Create a compute-only context. Use in pipe_screen::context_create.
 376  * This disables draw, blit, and clear*, render_condition, and other graphics
 377  * functions. Interop with other graphics contexts is still allowed.
 378  * This allows scheduling jobs on a compute-only hardware command queue that
 379  * can run in parallel with graphics without stalling it.
 380  */
 381 #define PIPE_CONTEXT_COMPUTE_ONLY      (1 << 0)
 382
 383 /**
 384  * Gather debug information and expect that pipe_context::dump_debug_state
 385  * will be called. Use in pipe_screen::context_create.
 386  */
 387 #define PIPE_CONTEXT_DEBUG             (1 << 1)
 388
 389 /**
 390  * Whether out-of-bounds shader loads must return zero and out-of-bounds
 391  * shader stores must be dropped.
 392  */
 393 #define PIPE_CONTEXT_ROBUST_BUFFER_ACCESS (1 << 2)
 394
 395 /**
 396  * Prefer threaded pipe_context. It also implies that video codec functions
 397  * will not be used. (they will be either no-ops or NULL when threading is
 398  * enabled)
 399  */
 400 #define PIPE_CONTEXT_PREFER_THREADED   (1 << 3)
 401
 402 /**
 403  * Create a high priority context.
 404  */
 405 #define PIPE_CONTEXT_HIGH_PRIORITY     (1 << 4)
 406
 407 /**
 408  * Create a low priority context.
 409  */
 410 #define PIPE_CONTEXT_LOW_PRIORITY      (1 << 5)
 411
 412 /** Stop execution if the device is reset. */
 413 #define PIPE_CONTEXT_LOSE_CONTEXT_ON_RESET (1 << 6)
 414
 415 /**
 416  * Flags for pipe_context::memory_barrier.
 417  */
 418 #define PIPE_BARRIER_MAPPED_BUFFER     (1 << 0)
 419 #define PIPE_BARRIER_SHADER_BUFFER     (1 << 1)
 420 #define PIPE_BARRIER_QUERY_BUFFER      (1 << 2)
 421 #define PIPE_BARRIER_VERTEX_BUFFER     (1 << 3)
 422 #define PIPE_BARRIER_INDEX_BUFFER      (1 << 4)
 423 #define PIPE_BARRIER_CONSTANT_BUFFER   (1 << 5)
 424 #define PIPE_BARRIER_INDIRECT_BUFFER   (1 << 6)
 425 #define PIPE_BARRIER_TEXTURE           (1 << 7)
 426 #define PIPE_BARRIER_IMAGE             (1 << 8)
 427 #define PIPE_BARRIER_FRAMEBUFFER       (1 << 9)
 428 #define PIPE_BARRIER_STREAMOUT_BUFFER  (1 << 10)
 429 #define PIPE_BARRIER_GLOBAL_BUFFER     (1 << 11)
 430 #define PIPE_BARRIER_UPDATE_BUFFER     (1 << 12)
 431 #define PIPE_BARRIER_UPDATE_TEXTURE    (1 << 13)
 432 #define PIPE_BARRIER_ALL               ((1 << 14) - 1)
 433
 434 #define PIPE_BARRIER_UPDATE \
 435    (PIPE_BARRIER_UPDATE_BUFFER | PIPE_BARRIER_UPDATE_TEXTURE)
 436
 437 /**
 438  * Flags for pipe_context::texture_barrier.
 439  */
 440 #define PIPE_TEXTURE_BARRIER_SAMPLER      (1 << 0)
 441 #define PIPE_TEXTURE_BARRIER_FRAMEBUFFER  (1 << 1)
 442
 443 /**
 444  * Resource binding flags -- state tracker must specify in advance all
 445  * the ways a resource might be used.
 446  */
 447 #define PIPE_BIND_DEPTH_STENCIL        (1 << 0) /* create_surface */
 448 #define PIPE_BIND_RENDER_TARGET        (1 << 1) /* create_surface */
 449 #define PIPE_BIND_BLENDABLE            (1 << 2) /* create_surface */
 450 #define PIPE_BIND_SAMPLER_VIEW         (1 << 3) /* create_sampler_view */
 451 #define PIPE_BIND_VERTEX_BUFFER        (1 << 4) /* set_vertex_buffers */
 452 #define PIPE_BIND_INDEX_BUFFER         (1 << 5) /* draw_elements */
 453 #define PIPE_BIND_CONSTANT_BUFFER      (1 << 6) /* set_constant_buffer */
 454 #define PIPE_BIND_DISPLAY_TARGET       (1 << 7) /* flush_front_buffer */
 455 /* gap */
 456 #define PIPE_BIND_STREAM_OUTPUT        (1 << 10) /* set_stream_output_buffers */
 457 #define PIPE_BIND_CURSOR               (1 << 11) /* mouse cursor */
 458 #define PIPE_BIND_CUSTOM               (1 << 12) /* state-tracker/winsys usages */
 459 #define PIPE_BIND_GLOBAL               (1 << 13) /* set_global_binding */
 460 #define PIPE_BIND_SHADER_BUFFER        (1 << 14) /* set_shader_buffers */
 461 #define PIPE_BIND_SHADER_IMAGE         (1 << 15) /* set_shader_images */
 462 #define PIPE_BIND_COMPUTE_RESOURCE     (1 << 16) /* set_compute_resources */
 463 #define PIPE_BIND_COMMAND_ARGS_BUFFER  (1 << 17) /* pipe_draw_info.indirect */
 464 #define PIPE_BIND_QUERY_BUFFER         (1 << 18) /* get_query_result_resource */
 465
 466 /**
 467  * The first two flags above were previously part of the amorphous
 468  * TEXTURE_USAGE, most of which are now descriptions of the ways a
 469  * particular texture can be bound to the gallium pipeline.  The two flags
 470  * below do not fit within that and probably need to be migrated to some
 471  * other place.
 472  *
 473  * It seems like scanout is used by the Xorg state tracker to ask for
 474  * a texture suitable for actual scanout (hence the name), which
 475  * implies extra layout constraints on some hardware.  It may also
 476  * have some special meaning regarding mouse cursor images.
 477  *
 478  * The shared flag is quite underspecified, but certainly isn't a
 479  * binding flag - it seems more like a message to the winsys to create
 480  * a shareable allocation.
 481  *
 482  * The third flag has been added to be able to force textures to be created
 483  * in linear mode (no tiling).
 484  */
 485 #define PIPE_BIND_SCANOUT     (1 << 19) /*  */
 486 #define PIPE_BIND_SHARED      (1 << 20) /* get_texture_handle ??? */
 487 #define PIPE_BIND_LINEAR      (1 << 21)
 488
 489
 490 /**
 491  * Flags for the driver about resource behaviour:
 492  */
 493 #define PIPE_RESOURCE_FLAG_MAP_PERSISTENT (1 << 0)
 494 #define PIPE_RESOURCE_FLAG_MAP_COHERENT   (1 << 1)
 495 #define PIPE_RESOURCE_FLAG_TEXTURING_MORE_LIKELY (1 << 2)
 496 #define PIPE_RESOURCE_FLAG_SPARSE                (1 << 3)
 497 #define PIPE_RESOURCE_FLAG_SINGLE_THREAD_USE     (1 << 4)
 498 #define PIPE_RESOURCE_FLAG_DRV_PRIV    (1 << 8) /* driver/winsys private */
 499 #define PIPE_RESOURCE_FLAG_ST_PRIV     (1 << 24) /* state-tracker/winsys private */
 500
 501 /**
 502  * Hint about the expected lifecycle of a resource.
 503  * Sorted according to GPU vs CPU access.
 504  */
 505 enum pipe_resource_usage {
 506    PIPE_USAGE_DEFAULT,        /* fast GPU access */
 507    PIPE_USAGE_IMMUTABLE,      /* fast GPU access, immutable */
 508    PIPE_USAGE_DYNAMIC,        /* uploaded data is used multiple times */
 509    PIPE_USAGE_STREAM,         /* uploaded data is used once */
 510    PIPE_USAGE_STAGING,        /* fast CPU access */
 511 };
 512
 513 /**
 514  * Shaders
 515  */
 516 enum pipe_shader_type {
 517    PIPE_SHADER_VERTEX,
 518    PIPE_SHADER_FRAGMENT,
 519    PIPE_SHADER_GEOMETRY,
 520    PIPE_SHADER_TESS_CTRL,
 521    PIPE_SHADER_TESS_EVAL,
 522    PIPE_SHADER_COMPUTE,
 523    PIPE_SHADER_TYPES,
 524 };
 525
 526 /**
 527  * Primitive types:
 528  */
 529 enum pipe_prim_type {
 530    PIPE_PRIM_POINTS,
 531    PIPE_PRIM_LINES,
 532    PIPE_PRIM_LINE_LOOP,
 533    PIPE_PRIM_LINE_STRIP,
 534    PIPE_PRIM_TRIANGLES,
 535    PIPE_PRIM_TRIANGLE_STRIP,
 536    PIPE_PRIM_TRIANGLE_FAN,
 537    PIPE_PRIM_QUADS,
 538    PIPE_PRIM_QUAD_STRIP,
 539    PIPE_PRIM_POLYGON,
 540    PIPE_PRIM_LINES_ADJACENCY,
 541    PIPE_PRIM_LINE_STRIP_ADJACENCY,
 542    PIPE_PRIM_TRIANGLES_ADJACENCY,
 543    PIPE_PRIM_TRIANGLE_STRIP_ADJACENCY,
 544    PIPE_PRIM_PATCHES,
 545    PIPE_PRIM_MAX,
 546 };
 547
 548 /**
 549  * Tessellator spacing types
 550  */
 551 enum pipe_tess_spacing {
 552    PIPE_TESS_SPACING_FRACTIONAL_ODD,
 553    PIPE_TESS_SPACING_FRACTIONAL_EVEN,
 554    PIPE_TESS_SPACING_EQUAL,
 555 };
 556
 557 /**
 558  * Query object types
 559  */
 560 enum pipe_query_type {
 561    PIPE_QUERY_OCCLUSION_COUNTER,
 562    PIPE_QUERY_OCCLUSION_PREDICATE,
 563    PIPE_QUERY_OCCLUSION_PREDICATE_CONSERVATIVE,
 564    PIPE_QUERY_TIMESTAMP,
 565    PIPE_QUERY_TIMESTAMP_DISJOINT,
 566    PIPE_QUERY_TIME_ELAPSED,
 567    PIPE_QUERY_PRIMITIVES_GENERATED,
 568    PIPE_QUERY_PRIMITIVES_EMITTED,
 569    PIPE_QUERY_SO_STATISTICS,
 570    PIPE_QUERY_SO_OVERFLOW_PREDICATE,
 571    PIPE_QUERY_SO_OVERFLOW_ANY_PREDICATE,
 572    PIPE_QUERY_GPU_FINISHED,
 573    PIPE_QUERY_PIPELINE_STATISTICS,
 574    PIPE_QUERY_PIPELINE_STATISTICS_SINGLE,
 575    PIPE_QUERY_TYPES,
 576    /* start of driver queries, see pipe_screen::get_driver_query_info */
 577    PIPE_QUERY_DRIVER_SPECIFIC = 256,
 578 };
 579
 580 /**
 581  * Index for PIPE_QUERY_PIPELINE_STATISTICS subqueries.
 582  */
 583 enum pipe_statistics_query_index {
 584    PIPE_STAT_QUERY_IA_VERTICES,
 585    PIPE_STAT_QUERY_IA_PRIMITIVES,
 586    PIPE_STAT_QUERY_VS_INVOCATIONS,
 587    PIPE_STAT_QUERY_GS_INVOCATIONS,
 588    PIPE_STAT_QUERY_GS_PRIMITIVES,
 589    PIPE_STAT_QUERY_C_INVOCATIONS,
 590    PIPE_STAT_QUERY_C_PRIMITIVES,
 591    PIPE_STAT_QUERY_PS_INVOCATIONS,
 592    PIPE_STAT_QUERY_HS_INVOCATIONS,
 593    PIPE_STAT_QUERY_DS_INVOCATIONS,
 594    PIPE_STAT_QUERY_CS_INVOCATIONS,
 595 };
 596
 597 /**
 598  * Conditional rendering modes
 599  */
 600 enum pipe_render_cond_flag {
 601    PIPE_RENDER_COND_WAIT,
 602    PIPE_RENDER_COND_NO_WAIT,
 603    PIPE_RENDER_COND_BY_REGION_WAIT,
 604    PIPE_RENDER_COND_BY_REGION_NO_WAIT,
 605 };
 606
 607 /**
 608  * Point sprite coord modes
 609  */
 610 enum pipe_sprite_coord_mode {
 611    PIPE_SPRITE_COORD_UPPER_LEFT,
 612    PIPE_SPRITE_COORD_LOWER_LEFT,
 613 };
 614
 615 /**
 616  * Texture & format swizzles
 617  */
 618 enum pipe_swizzle {
 619    PIPE_SWIZZLE_X,
 620    PIPE_SWIZZLE_Y,
 621    PIPE_SWIZZLE_Z,
 622    PIPE_SWIZZLE_W,
 623    PIPE_SWIZZLE_0,
 624    PIPE_SWIZZLE_1,
 625    PIPE_SWIZZLE_NONE,
 626    PIPE_SWIZZLE_MAX, /**< Number of enums counter (must be last) */
 627 };
 628
 629 /**
 630  * Viewport swizzles
 631  */
 632 enum pipe_viewport_swizzle {
 633    PIPE_VIEWPORT_SWIZZLE_POSITIVE_X,
 634    PIPE_VIEWPORT_SWIZZLE_NEGATIVE_X,
 635    PIPE_VIEWPORT_SWIZZLE_POSITIVE_Y,
 636    PIPE_VIEWPORT_SWIZZLE_NEGATIVE_Y,
 637    PIPE_VIEWPORT_SWIZZLE_POSITIVE_Z,
 638    PIPE_VIEWPORT_SWIZZLE_NEGATIVE_Z,
 639    PIPE_VIEWPORT_SWIZZLE_POSITIVE_W,
 640    PIPE_VIEWPORT_SWIZZLE_NEGATIVE_W,
 641 };
 642
 643 #define PIPE_TIMEOUT_INFINITE 0xffffffffffffffffull
 644
 645
 646 /**
 647  * Device reset status.
 648  */
 649 enum pipe_reset_status
 650 {
 651    PIPE_NO_RESET,
 652    PIPE_GUILTY_CONTEXT_RESET,
 653    PIPE_INNOCENT_CONTEXT_RESET,
 654    PIPE_UNKNOWN_CONTEXT_RESET,
 655 };
 656
 657
 658 /**
 659  * Conservative rasterization modes.
 660  */
 661 enum pipe_conservative_raster_mode
 662 {
 663    PIPE_CONSERVATIVE_RASTER_OFF,
 664
 665    /**
 666     * The post-snap mode means the conservative rasterization occurs after
 667     * the conversion from floating-point to fixed-point coordinates
 668     * on the subpixel grid.
 669     */
 670    PIPE_CONSERVATIVE_RASTER_POST_SNAP,
 671
 672    /**
 673     * The pre-snap mode means the conservative rasterization occurs before
 674     * the conversion from floating-point to fixed-point coordinates.
 675     */
 676    PIPE_CONSERVATIVE_RASTER_PRE_SNAP,
 677 };
 678
 679
 680 /**
 681  * resource_get_handle flags.
 682  */
 683 /* Requires pipe_context::flush_resource before external use. */
 684 #define PIPE_HANDLE_USAGE_EXPLICIT_FLUSH     (1 << 0)
 685 /* Expected external use of the resource: */
 686 #define PIPE_HANDLE_USAGE_FRAMEBUFFER_WRITE  (1 << 1)
 687 #define PIPE_HANDLE_USAGE_SHADER_WRITE       (1 << 2)
 688
 689 /**
 690  * pipe_image_view access flags.
 691  */
 692 #define PIPE_IMAGE_ACCESS_READ       (1 << 0)
 693 #define PIPE_IMAGE_ACCESS_WRITE      (1 << 1)
 694 #define PIPE_IMAGE_ACCESS_READ_WRITE (PIPE_IMAGE_ACCESS_READ | \
 695                                       PIPE_IMAGE_ACCESS_WRITE)
 696
 697 /**
 698  * Implementation capabilities/limits which are queried through
 699  * pipe_screen::get_param()
 700  */
 701 enum pipe_cap
 702 {
 703    PIPE_CAP_GRAPHICS,
 704    PIPE_CAP_NPOT_TEXTURES,
 705    PIPE_CAP_MAX_DUAL_SOURCE_RENDER_TARGETS,
 706    PIPE_CAP_ANISOTROPIC_FILTER,
 707    PIPE_CAP_POINT_SPRITE,
 708    PIPE_CAP_MAX_RENDER_TARGETS,
 709    PIPE_CAP_OCCLUSION_QUERY,
 710    PIPE_CAP_QUERY_TIME_ELAPSED,
 711    PIPE_CAP_TEXTURE_SHADOW_MAP,
 712    PIPE_CAP_TEXTURE_SWIZZLE,
 713    PIPE_CAP_MAX_TEXTURE_2D_SIZE,
 714    PIPE_CAP_MAX_TEXTURE_3D_LEVELS,
 715    PIPE_CAP_MAX_TEXTURE_CUBE_LEVELS,
 716    PIPE_CAP_TEXTURE_MIRROR_CLAMP,
 717    PIPE_CAP_BLEND_EQUATION_SEPARATE,
 718    PIPE_CAP_MAX_STREAM_OUTPUT_BUFFERS,
 719    PIPE_CAP_PRIMITIVE_RESTART,
 720    /** blend enables and write masks per rendertarget */
 721    PIPE_CAP_INDEP_BLEND_ENABLE,
 722    /** different blend funcs per rendertarget */
 723    PIPE_CAP_INDEP_BLEND_FUNC,
 724    PIPE_CAP_MAX_TEXTURE_ARRAY_LAYERS,
 725    PIPE_CAP_TGSI_FS_COORD_ORIGIN_UPPER_LEFT,
 726    PIPE_CAP_TGSI_FS_COORD_ORIGIN_LOWER_LEFT,
 727    PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_HALF_INTEGER,
 728    PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_INTEGER,
 729    PIPE_CAP_DEPTH_CLIP_DISABLE,
 730    PIPE_CAP_DEPTH_CLIP_DISABLE_SEPARATE,
 731    PIPE_CAP_SHADER_STENCIL_EXPORT,
 732    PIPE_CAP_TGSI_INSTANCEID,
 733    PIPE_CAP_VERTEX_ELEMENT_INSTANCE_DIVISOR,
 734    PIPE_CAP_FRAGMENT_COLOR_CLAMPED,
 735    PIPE_CAP_MIXED_COLORBUFFER_FORMATS,
 736    PIPE_CAP_SEAMLESS_CUBE_MAP,
 737    PIPE_CAP_SEAMLESS_CUBE_MAP_PER_TEXTURE,
 738    PIPE_CAP_MIN_TEXEL_OFFSET,
 739    PIPE_CAP_MAX_TEXEL_OFFSET,
 740    PIPE_CAP_CONDITIONAL_RENDER,
 741    PIPE_CAP_TEXTURE_BARRIER,
 742    PIPE_CAP_MAX_STREAM_OUTPUT_SEPARATE_COMPONENTS,
 743    PIPE_CAP_MAX_STREAM_OUTPUT_INTERLEAVED_COMPONENTS,
 744    PIPE_CAP_STREAM_OUTPUT_PAUSE_RESUME,
 745    PIPE_CAP_TGSI_CAN_COMPACT_CONSTANTS,
 746    PIPE_CAP_VERTEX_COLOR_UNCLAMPED,
 747    PIPE_CAP_VERTEX_COLOR_CLAMPED,
 748    PIPE_CAP_GLSL_FEATURE_LEVEL,
 749    PIPE_CAP_GLSL_FEATURE_LEVEL_COMPATIBILITY,
 750    PIPE_CAP_ESSL_FEATURE_LEVEL,
 751    PIPE_CAP_QUADS_FOLLOW_PROVOKING_VERTEX_CONVENTION,
 752    PIPE_CAP_USER_VERTEX_BUFFERS,
 753    PIPE_CAP_VERTEX_BUFFER_OFFSET_4BYTE_ALIGNED_ONLY,
 754    PIPE_CAP_VERTEX_BUFFER_STRIDE_4BYTE_ALIGNED_ONLY,
 755    PIPE_CAP_VERTEX_ELEMENT_SRC_OFFSET_4BYTE_ALIGNED_ONLY,
 756    PIPE_CAP_COMPUTE,
 757    PIPE_CAP_CONSTANT_BUFFER_OFFSET_ALIGNMENT,
 758    PIPE_CAP_START_INSTANCE,
 759    PIPE_CAP_QUERY_TIMESTAMP,
 760    PIPE_CAP_TEXTURE_MULTISAMPLE,
 761    PIPE_CAP_MIN_MAP_BUFFER_ALIGNMENT,
 762    PIPE_CAP_CUBE_MAP_ARRAY,
 763    PIPE_CAP_TEXTURE_BUFFER_OBJECTS,
 764    PIPE_CAP_TEXTURE_BUFFER_OFFSET_ALIGNMENT,
 765    PIPE_CAP_BUFFER_SAMPLER_VIEW_RGBA_ONLY,
 766    PIPE_CAP_TGSI_TEXCOORD,
 767    PIPE_CAP_PREFER_BLIT_BASED_TEXTURE_TRANSFER,
 768    PIPE_CAP_QUERY_PIPELINE_STATISTICS,
 769    PIPE_CAP_TEXTURE_BORDER_COLOR_QUIRK,
 770    PIPE_CAP_MAX_TEXTURE_BUFFER_SIZE,
 771    PIPE_CAP_MAX_VIEWPORTS,
 772    PIPE_CAP_ENDIANNESS,
 773    PIPE_CAP_MIXED_FRAMEBUFFER_SIZES,
 774    PIPE_CAP_TGSI_VS_LAYER_VIEWPORT,
 775    PIPE_CAP_MAX_GEOMETRY_OUTPUT_VERTICES,
 776    PIPE_CAP_MAX_GEOMETRY_TOTAL_OUTPUT_COMPONENTS,
 777    PIPE_CAP_MAX_TEXTURE_GATHER_COMPONENTS,
 778    PIPE_CAP_TEXTURE_GATHER_SM5,
 779    PIPE_CAP_BUFFER_MAP_PERSISTENT_COHERENT,
 780    PIPE_CAP_FAKE_SW_MSAA,
 781    PIPE_CAP_TEXTURE_QUERY_LOD,
 782    PIPE_CAP_MIN_TEXTURE_GATHER_OFFSET,
 783    PIPE_CAP_MAX_TEXTURE_GATHER_OFFSET,
 784    PIPE_CAP_SAMPLE_SHADING,
 785    PIPE_CAP_TEXTURE_GATHER_OFFSETS,
 786    PIPE_CAP_TGSI_VS_WINDOW_SPACE_POSITION,
 787    PIPE_CAP_MAX_VERTEX_STREAMS,
 788    PIPE_CAP_DRAW_INDIRECT,
 789    PIPE_CAP_TGSI_FS_FINE_DERIVATIVE,
 790    PIPE_CAP_VENDOR_ID,
 791    PIPE_CAP_DEVICE_ID,
 792    PIPE_CAP_ACCELERATED,
 793    PIPE_CAP_VIDEO_MEMORY,
 794    PIPE_CAP_UMA,
 795    PIPE_CAP_CONDITIONAL_RENDER_INVERTED,
 796    PIPE_CAP_MAX_VERTEX_ATTRIB_STRIDE,
 797    PIPE_CAP_SAMPLER_VIEW_TARGET,
 798    PIPE_CAP_CLIP_HALFZ,
 799    PIPE_CAP_VERTEXID_NOBASE,
 800    PIPE_CAP_POLYGON_OFFSET_CLAMP,
 801    PIPE_CAP_MULTISAMPLE_Z_RESOLVE,
 802    PIPE_CAP_RESOURCE_FROM_USER_MEMORY,
 803    PIPE_CAP_DEVICE_RESET_STATUS_QUERY,
 804    PIPE_CAP_MAX_SHADER_PATCH_VARYINGS,
 805    PIPE_CAP_TEXTURE_FLOAT_LINEAR,
 806    PIPE_CAP_TEXTURE_HALF_FLOAT_LINEAR,
 807    PIPE_CAP_DEPTH_BOUNDS_TEST,
 808    PIPE_CAP_TGSI_TXQS,
 809    PIPE_CAP_FORCE_PERSAMPLE_INTERP,
 810    PIPE_CAP_SHAREABLE_SHADERS,
 811    PIPE_CAP_COPY_BETWEEN_COMPRESSED_AND_PLAIN_FORMATS,
 812    PIPE_CAP_CLEAR_TEXTURE,
 813    PIPE_CAP_DRAW_PARAMETERS,
 814    PIPE_CAP_TGSI_PACK_HALF_FLOAT,
 815    PIPE_CAP_MULTI_DRAW_INDIRECT,
 816    PIPE_CAP_MULTI_DRAW_INDIRECT_PARAMS,
 817    PIPE_CAP_TGSI_FS_POSITION_IS_SYSVAL,
 818    PIPE_CAP_TGSI_FS_POINT_IS_SYSVAL,
 819    PIPE_CAP_TGSI_FS_FACE_IS_INTEGER_SYSVAL,
 820    PIPE_CAP_SHADER_BUFFER_OFFSET_ALIGNMENT,
 821    PIPE_CAP_INVALIDATE_BUFFER,
 822    PIPE_CAP_GENERATE_MIPMAP,
 823    PIPE_CAP_STRING_MARKER,
 824    PIPE_CAP_SURFACE_REINTERPRET_BLOCKS,
 825    PIPE_CAP_QUERY_BUFFER_OBJECT,
 826    PIPE_CAP_QUERY_MEMORY_INFO,
 827    PIPE_CAP_PCI_GROUP,
 828    PIPE_CAP_PCI_BUS,
 829    PIPE_CAP_PCI_DEVICE,
 830    PIPE_CAP_PCI_FUNCTION,
 831    PIPE_CAP_FRAMEBUFFER_NO_ATTACHMENT,
 832    PIPE_CAP_ROBUST_BUFFER_ACCESS_BEHAVIOR,
 833    PIPE_CAP_CULL_DISTANCE,
 834    PIPE_CAP_PRIMITIVE_RESTART_FOR_PATCHES,
 835    PIPE_CAP_TGSI_VOTE,
 836    PIPE_CAP_MAX_WINDOW_RECTANGLES,
 837    PIPE_CAP_POLYGON_OFFSET_UNITS_UNSCALED,
 838    PIPE_CAP_VIEWPORT_SUBPIXEL_BITS,
 839    PIPE_CAP_RASTERIZER_SUBPIXEL_BITS,
 840    PIPE_CAP_MIXED_COLOR_DEPTH_BITS,
 841    PIPE_CAP_TGSI_ARRAY_COMPONENTS,
 842    PIPE_CAP_STREAM_OUTPUT_INTERLEAVE_BUFFERS,
 843    PIPE_CAP_TGSI_CAN_READ_OUTPUTS,
 844    PIPE_CAP_NATIVE_FENCE_FD,
 845    PIPE_CAP_GLSL_OPTIMIZE_CONSERVATIVELY,
 846    PIPE_CAP_GLSL_TESS_LEVELS_AS_INPUTS,
 847    PIPE_CAP_FBFETCH,
 848    PIPE_CAP_TGSI_MUL_ZERO_WINS,
 849    PIPE_CAP_DOUBLES,
 850    PIPE_CAP_INT64,
 851    PIPE_CAP_INT64_DIVMOD,
 852    PIPE_CAP_TGSI_TEX_TXF_LZ,
 853    PIPE_CAP_TGSI_CLOCK,
 854    PIPE_CAP_POLYGON_MODE_FILL_RECTANGLE,
 855    PIPE_CAP_SPARSE_BUFFER_PAGE_SIZE,
 856    PIPE_CAP_TGSI_BALLOT,
 857    PIPE_CAP_TGSI_TES_LAYER_VIEWPORT,
 858    PIPE_CAP_CAN_BIND_CONST_BUFFER_AS_VERTEX,
 859    PIPE_CAP_ALLOW_MAPPED_BUFFERS_DURING_EXECUTION,
 860    PIPE_CAP_POST_DEPTH_COVERAGE,
 861    PIPE_CAP_BINDLESS_TEXTURE,
 862    PIPE_CAP_NIR_SAMPLERS_AS_DEREF,
 863    PIPE_CAP_QUERY_SO_OVERFLOW,
 864    PIPE_CAP_MEMOBJ,
 865    PIPE_CAP_LOAD_CONSTBUF,
 866    PIPE_CAP_TGSI_ANY_REG_AS_ADDRESS,
 867    PIPE_CAP_TILE_RASTER_ORDER,
 868    PIPE_CAP_MAX_COMBINED_SHADER_OUTPUT_RESOURCES,
 869    PIPE_CAP_FRAMEBUFFER_MSAA_CONSTRAINTS,
 870    PIPE_CAP_SIGNED_VERTEX_BUFFER_OFFSET,
 871    PIPE_CAP_CONTEXT_PRIORITY_MASK,
 872    PIPE_CAP_FENCE_SIGNAL,
 873    PIPE_CAP_CONSTBUF0_FLAGS,
 874    PIPE_CAP_PACKED_UNIFORMS,
 875    PIPE_CAP_CONSERVATIVE_RASTER_POST_SNAP_TRIANGLES,
 876    PIPE_CAP_CONSERVATIVE_RASTER_POST_SNAP_POINTS_LINES,
 877    PIPE_CAP_CONSERVATIVE_RASTER_PRE_SNAP_TRIANGLES,
 878    PIPE_CAP_CONSERVATIVE_RASTER_PRE_SNAP_POINTS_LINES,
 879    PIPE_CAP_MAX_CONSERVATIVE_RASTER_SUBPIXEL_PRECISION_BIAS,
 880    PIPE_CAP_CONSERVATIVE_RASTER_POST_DEPTH_COVERAGE,
 881    PIPE_CAP_CONSERVATIVE_RASTER_INNER_COVERAGE,
 882    PIPE_CAP_PROGRAMMABLE_SAMPLE_LOCATIONS,
 883    PIPE_CAP_MAX_GS_INVOCATIONS,
 884    PIPE_CAP_MAX_SHADER_BUFFER_SIZE,
 885    PIPE_CAP_TEXTURE_MIRROR_CLAMP_TO_EDGE,
 886    PIPE_CAP_MAX_COMBINED_SHADER_BUFFERS,
 887    PIPE_CAP_MAX_COMBINED_HW_ATOMIC_COUNTERS,
 888    PIPE_CAP_MAX_COMBINED_HW_ATOMIC_COUNTER_BUFFERS,
 889    PIPE_CAP_MAX_TEXTURE_UPLOAD_MEMORY_BUDGET,
 890    PIPE_CAP_MAX_VERTEX_ELEMENT_SRC_OFFSET,
 891    PIPE_CAP_SURFACE_SAMPLE_COUNT,
 892    PIPE_CAP_TGSI_ATOMFADD,
 893    PIPE_CAP_QUERY_PIPELINE_STATISTICS_SINGLE,
 894    PIPE_CAP_RGB_OVERRIDE_DST_ALPHA_BLEND,
 895    PIPE_CAP_DEST_SURFACE_SRGB_CONTROL,
 896    PIPE_CAP_NIR_COMPACT_ARRAYS,
 897    PIPE_CAP_MAX_VARYINGS,
 898    PIPE_CAP_COMPUTE_GRID_INFO_LAST_BLOCK,
 899    PIPE_CAP_COMPUTE_SHADER_DERIVATIVES,
 900    PIPE_CAP_TGSI_SKIP_SHRINK_IO_ARRAYS,
 901    PIPE_CAP_IMAGE_LOAD_FORMATTED,
 902    PIPE_CAP_THROTTLE,
 903    PIPE_CAP_DMABUF,
 904    PIPE_CAP_PREFER_COMPUTE_FOR_MULTIMEDIA,
 905    PIPE_CAP_FRAGMENT_SHADER_INTERLOCK,
 906    PIPE_CAP_FBFETCH_COHERENT,
 907    PIPE_CAP_CS_DERIVED_SYSTEM_VALUES_SUPPORTED,
 908    PIPE_CAP_ATOMIC_FLOAT_MINMAX,
 909    PIPE_CAP_TGSI_DIV,
 910    PIPE_CAP_FRAGMENT_SHADER_TEXTURE_LOD,
 911    PIPE_CAP_FRAGMENT_SHADER_DERIVATIVES,
 912    PIPE_CAP_VERTEX_SHADER_SATURATE,
 913    PIPE_CAP_TEXTURE_SHADOW_LOD,
 914    PIPE_CAP_SHADER_SAMPLES_IDENTICAL,
 915    PIPE_CAP_TGSI_ATOMINC_WRAP,
 916    PIPE_CAP_PREFER_IMM_ARRAYS_AS_CONSTBUF,
 917    PIPE_CAP_GL_SPIRV,
 918    PIPE_CAP_GL_SPIRV_VARIABLE_POINTERS,
 919    PIPE_CAP_DEMOTE_TO_HELPER_INVOCATION,
 920    PIPE_CAP_TGSI_TG4_COMPONENT_IN_SWIZZLE,
 921    PIPE_CAP_FLATSHADE,
 922    PIPE_CAP_ALPHA_TEST,
 923    PIPE_CAP_POINT_SIZE_FIXED,
 924    PIPE_CAP_TWO_SIDED_COLOR,
 925    PIPE_CAP_CLIP_PLANES,
 926    PIPE_CAP_MAX_VERTEX_BUFFERS,
 927    PIPE_CAP_OPENCL_INTEGER_FUNCTIONS,
 928    PIPE_CAP_INTEGER_MULTIPLY_32X16,
 929    /* Turn draw, dispatch, blit into NOOP */
 930    PIPE_CAP_FRONTEND_NOOP,
 931    PIPE_CAP_NIR_IMAGES_AS_DEREF,
 932    PIPE_CAP_PACKED_STREAM_OUTPUT,
 933    PIPE_CAP_VIEWPORT_TRANSFORM_LOWERED,
 934    PIPE_CAP_PSIZ_CLAMPED,
 935    PIPE_CAP_DRAW_INFO_START_WITH_USER_INDICES,
 936    PIPE_CAP_GL_BEGIN_END_BUFFER_SIZE,
 937    PIPE_CAP_VIEWPORT_SWIZZLE,
 938    PIPE_CAP_SYSTEM_SVM,
 939    PIPE_CAP_VIEWPORT_MASK,
 940 };
 941
 942 /**
 943  * Possible bits for PIPE_CAP_CONTEXT_PRIORITY_MASK param, which should
 944  * return a bitmask of the supported priorities.  If the driver does not
 945  * support prioritized contexts, it can return 0.
 946  *
 947  * Note that these match __DRI2_RENDERER_HAS_CONTEXT_PRIORITY_*
 948  */
 949 #define PIPE_CONTEXT_PRIORITY_LOW     (1 << 0)
 950 #define PIPE_CONTEXT_PRIORITY_MEDIUM  (1 << 1)
 951 #define PIPE_CONTEXT_PRIORITY_HIGH    (1 << 2)
 952
 953 #define PIPE_QUIRK_TEXTURE_BORDER_COLOR_SWIZZLE_NV50 (1 << 0)
 954 #define PIPE_QUIRK_TEXTURE_BORDER_COLOR_SWIZZLE_R600 (1 << 1)
 955
 956 enum pipe_endian
 957 {
 958    PIPE_ENDIAN_LITTLE = 0,
 959    PIPE_ENDIAN_BIG = 1,
 960 #if UTIL_ARCH_LITTLE_ENDIAN
 961    PIPE_ENDIAN_NATIVE = PIPE_ENDIAN_LITTLE
 962 #elif UTIL_ARCH_BIG_ENDIAN
 963    PIPE_ENDIAN_NATIVE = PIPE_ENDIAN_BIG
 964 #endif
 965 };
 966
 967 /**
 968  * Implementation limits which are queried through
 969  * pipe_screen::get_paramf()
 970  */
 971 enum pipe_capf
 972 {
 973    PIPE_CAPF_MAX_LINE_WIDTH,
 974    PIPE_CAPF_MAX_LINE_WIDTH_AA,
 975    PIPE_CAPF_MAX_POINT_WIDTH,
 976    PIPE_CAPF_MAX_POINT_WIDTH_AA,
 977    PIPE_CAPF_MAX_TEXTURE_ANISOTROPY,
 978    PIPE_CAPF_MAX_TEXTURE_LOD_BIAS,
 979    PIPE_CAPF_MIN_CONSERVATIVE_RASTER_DILATE,
 980    PIPE_CAPF_MAX_CONSERVATIVE_RASTER_DILATE,
 981    PIPE_CAPF_CONSERVATIVE_RASTER_DILATE_GRANULARITY,
 982 };
 983
 984 /** Shader caps not specific to any single stage */
 985 enum pipe_shader_cap
 986 {
 987    PIPE_SHADER_CAP_MAX_INSTRUCTIONS, /* if 0, it means the stage is unsupported */
 988    PIPE_SHADER_CAP_MAX_ALU_INSTRUCTIONS,
 989    PIPE_SHADER_CAP_MAX_TEX_INSTRUCTIONS,
 990    PIPE_SHADER_CAP_MAX_TEX_INDIRECTIONS,
 991    PIPE_SHADER_CAP_MAX_CONTROL_FLOW_DEPTH,
 992    PIPE_SHADER_CAP_MAX_INPUTS,
 993    PIPE_SHADER_CAP_MAX_OUTPUTS,
 994    PIPE_SHADER_CAP_MAX_CONST_BUFFER_SIZE,
 995    PIPE_SHADER_CAP_MAX_CONST_BUFFERS,
 996    PIPE_SHADER_CAP_MAX_TEMPS,
 997    /* boolean caps */
 998    PIPE_SHADER_CAP_TGSI_CONT_SUPPORTED,
 999    PIPE_SHADER_CAP_INDIRECT_INPUT_ADDR,
1000    PIPE_SHADER_CAP_INDIRECT_OUTPUT_ADDR,
1001    PIPE_SHADER_CAP_INDIRECT_TEMP_ADDR,
1002    PIPE_SHADER_CAP_INDIRECT_CONST_ADDR,
1003    PIPE_SHADER_CAP_SUBROUTINES, /* BGNSUB, ENDSUB, CAL, RET */
1004    PIPE_SHADER_CAP_INTEGERS,
1005    PIPE_SHADER_CAP_INT64_ATOMICS,
1006    PIPE_SHADER_CAP_FP16,
1007    PIPE_SHADER_CAP_MAX_TEXTURE_SAMPLERS,
1008    PIPE_SHADER_CAP_PREFERRED_IR,
1009    PIPE_SHADER_CAP_TGSI_SQRT_SUPPORTED,
1010    PIPE_SHADER_CAP_MAX_SAMPLER_VIEWS,
1011    PIPE_SHADER_CAP_TGSI_DROUND_SUPPORTED, /* all rounding modes */
1012    PIPE_SHADER_CAP_TGSI_DFRACEXP_DLDEXP_SUPPORTED,
1013    PIPE_SHADER_CAP_TGSI_FMA_SUPPORTED,
1014    PIPE_SHADER_CAP_TGSI_ANY_INOUT_DECL_RANGE,
1015    PIPE_SHADER_CAP_MAX_UNROLL_ITERATIONS_HINT,
1016    PIPE_SHADER_CAP_MAX_SHADER_BUFFERS,
1017    PIPE_SHADER_CAP_SUPPORTED_IRS,
1018    PIPE_SHADER_CAP_MAX_SHADER_IMAGES,
1019    PIPE_SHADER_CAP_LOWER_IF_THRESHOLD,
1020    PIPE_SHADER_CAP_TGSI_SKIP_MERGE_REGISTERS,
1021    PIPE_SHADER_CAP_TGSI_LDEXP_SUPPORTED,
1022    PIPE_SHADER_CAP_MAX_HW_ATOMIC_COUNTERS,
1023    PIPE_SHADER_CAP_MAX_HW_ATOMIC_COUNTER_BUFFERS,
1024 };
1025
1026 /**
1027  * Shader intermediate representation.
1028  *
1029  * Note that if the driver requests something other than TGSI, it must
1030  * always be prepared to receive TGSI in addition to its preferred IR.
1031  * If the driver requests TGSI as its preferred IR, it will *always*
1032  * get TGSI.
1033  *
1034  * Note that PIPE_SHADER_IR_TGSI should be zero for backwards compat with
1035  * state trackers that only understand TGSI.
1036  */
1037 enum pipe_shader_ir
1038 {
1039    PIPE_SHADER_IR_TGSI = 0,
1040    PIPE_SHADER_IR_NATIVE,
1041    PIPE_SHADER_IR_NIR,
1042    PIPE_SHADER_IR_NIR_SERIALIZED,
1043 };
1044
1045 /**
1046  * Compute-specific implementation capability.  They can be queried
1047  * using pipe_screen::get_compute_param.
1048  */
1049 enum pipe_compute_cap
1050 {
1051    PIPE_COMPUTE_CAP_ADDRESS_BITS,
1052    PIPE_COMPUTE_CAP_IR_TARGET,
1053    PIPE_COMPUTE_CAP_GRID_DIMENSION,
1054    PIPE_COMPUTE_CAP_MAX_GRID_SIZE,
1055    PIPE_COMPUTE_CAP_MAX_BLOCK_SIZE,
1056    PIPE_COMPUTE_CAP_MAX_THREADS_PER_BLOCK,
1057    PIPE_COMPUTE_CAP_MAX_GLOBAL_SIZE,
1058    PIPE_COMPUTE_CAP_MAX_LOCAL_SIZE,
1059    PIPE_COMPUTE_CAP_MAX_PRIVATE_SIZE,
1060    PIPE_COMPUTE_CAP_MAX_INPUT_SIZE,
1061    PIPE_COMPUTE_CAP_MAX_MEM_ALLOC_SIZE,
1062    PIPE_COMPUTE_CAP_MAX_CLOCK_FREQUENCY,
1063    PIPE_COMPUTE_CAP_MAX_COMPUTE_UNITS,
1064    PIPE_COMPUTE_CAP_IMAGES_SUPPORTED,
1065    PIPE_COMPUTE_CAP_SUBGROUP_SIZE,
1066    PIPE_COMPUTE_CAP_MAX_VARIABLE_THREADS_PER_BLOCK,
1067 };
1068
1069 /**
1070  * Resource parameters. They can be queried using
1071  * pipe_screen::get_resource_param.
1072  */
1073 enum pipe_resource_param
1074 {
1075    PIPE_RESOURCE_PARAM_NPLANES,
1076    PIPE_RESOURCE_PARAM_STRIDE,
1077    PIPE_RESOURCE_PARAM_OFFSET,
1078    PIPE_RESOURCE_PARAM_MODIFIER,
1079    PIPE_RESOURCE_PARAM_HANDLE_TYPE_SHARED,
1080    PIPE_RESOURCE_PARAM_HANDLE_TYPE_KMS,
1081    PIPE_RESOURCE_PARAM_HANDLE_TYPE_FD,
1082 };
1083
1084 /**
1085  * Types of parameters for pipe_context::set_context_param.
1086  */
1087 enum pipe_context_param
1088 {
1089    /* A hint for the driver that it should pin its execution threads to
1090     * a group of cores sharing a specific L3 cache if the CPU has multiple
1091     * L3 caches. This is needed for good multithreading performance on
1092     * AMD Zen CPUs. "value" is the L3 cache index. Drivers that don't have
1093     * any internal threads or don't run on affected CPUs can ignore this.
1094     */
1095    PIPE_CONTEXT_PARAM_PIN_THREADS_TO_L3_CACHE,
1096 };
1097
1098 /**
1099  * Composite query types
1100  */
1101
1102 /**
1103  * Query result for PIPE_QUERY_SO_STATISTICS.
1104  */
1105 struct pipe_query_data_so_statistics
1106 {
1107    uint64_t num_primitives_written;
1108    uint64_t primitives_storage_needed;
1109 };
1110
1111 /**
1112  * Query result for PIPE_QUERY_TIMESTAMP_DISJOINT.
1113  */
1114 struct pipe_query_data_timestamp_disjoint
1115 {
1116    uint64_t frequency;
1117    bool     disjoint;
1118 };
1119
1120 /**
1121  * Query result for PIPE_QUERY_PIPELINE_STATISTICS.
1122  */
1123 struct pipe_query_data_pipeline_statistics
1124 {
1125    uint64_t ia_vertices;    /**< Num vertices read by the vertex fetcher. */
1126    uint64_t ia_primitives;  /**< Num primitives read by the vertex fetcher. */
1127    uint64_t vs_invocations; /**< Num vertex shader invocations. */
1128    uint64_t gs_invocations; /**< Num geometry shader invocations. */
1129    uint64_t gs_primitives;  /**< Num primitives output by a geometry shader. */
1130    uint64_t c_invocations;  /**< Num primitives sent to the rasterizer. */
1131    uint64_t c_primitives;   /**< Num primitives that were rendered. */
1132    uint64_t ps_invocations; /**< Num pixel shader invocations. */
1133    uint64_t hs_invocations; /**< Num hull shader invocations. */
1134    uint64_t ds_invocations; /**< Num domain shader invocations. */
1135    uint64_t cs_invocations; /**< Num compute shader invocations. */
1136 };
1137
1138 /**
1139  * For batch queries.
1140  */
1141 union pipe_numeric_type_union
1142 {
1143    uint64_t u64;
1144    uint32_t u32;
1145    float f;
1146 };
1147
1148 /**
1149  * Query result (returned by pipe_context::get_query_result).
1150  */
1151 union pipe_query_result
1152 {
1153    /* PIPE_QUERY_OCCLUSION_PREDICATE */
1154    /* PIPE_QUERY_OCCLUSION_PREDICATE_CONSERVATIVE */
1155    /* PIPE_QUERY_SO_OVERFLOW_PREDICATE */
1156    /* PIPE_QUERY_SO_OVERFLOW_ANY_PREDICATE */
1157    /* PIPE_QUERY_GPU_FINISHED */
1158    bool b;
1159
1160    /* PIPE_QUERY_OCCLUSION_COUNTER */
1161    /* PIPE_QUERY_TIMESTAMP */
1162    /* PIPE_QUERY_TIME_ELAPSED */
1163    /* PIPE_QUERY_PRIMITIVES_GENERATED */
1164    /* PIPE_QUERY_PRIMITIVES_EMITTED */
1165    /* PIPE_DRIVER_QUERY_TYPE_UINT64 */
1166    /* PIPE_DRIVER_QUERY_TYPE_BYTES */
1167    /* PIPE_DRIVER_QUERY_TYPE_MICROSECONDS */
1168    /* PIPE_DRIVER_QUERY_TYPE_HZ */
1169    uint64_t u64;
1170
1171    /* PIPE_DRIVER_QUERY_TYPE_UINT */
1172    uint32_t u32;
1173
1174    /* PIPE_DRIVER_QUERY_TYPE_FLOAT */
1175    /* PIPE_DRIVER_QUERY_TYPE_PERCENTAGE */
1176    float f;
1177
1178    /* PIPE_QUERY_SO_STATISTICS */
1179    struct pipe_query_data_so_statistics so_statistics;
1180
1181    /* PIPE_QUERY_TIMESTAMP_DISJOINT */
1182    struct pipe_query_data_timestamp_disjoint timestamp_disjoint;
1183
1184    /* PIPE_QUERY_PIPELINE_STATISTICS */
1185    struct pipe_query_data_pipeline_statistics pipeline_statistics;
1186
1187    /* batch queries (variable length) */
1188    union pipe_numeric_type_union batch[1];
1189 };
1190
1191 enum pipe_query_value_type
1192 {
1193    PIPE_QUERY_TYPE_I32,
1194    PIPE_QUERY_TYPE_U32,
1195    PIPE_QUERY_TYPE_I64,
1196    PIPE_QUERY_TYPE_U64,
1197 };
1198
1199 union pipe_color_union
1200 {
1201    float f[4];
1202    int i[4];
1203    unsigned int ui[4];
1204 };
1205
1206 enum pipe_driver_query_type
1207 {
1208    PIPE_DRIVER_QUERY_TYPE_UINT64,
1209    PIPE_DRIVER_QUERY_TYPE_UINT,
1210    PIPE_DRIVER_QUERY_TYPE_FLOAT,
1211    PIPE_DRIVER_QUERY_TYPE_PERCENTAGE,
1212    PIPE_DRIVER_QUERY_TYPE_BYTES,
1213    PIPE_DRIVER_QUERY_TYPE_MICROSECONDS,
1214    PIPE_DRIVER_QUERY_TYPE_HZ,
1215    PIPE_DRIVER_QUERY_TYPE_DBM,
1216    PIPE_DRIVER_QUERY_TYPE_TEMPERATURE,
1217    PIPE_DRIVER_QUERY_TYPE_VOLTS,
1218    PIPE_DRIVER_QUERY_TYPE_AMPS,
1219    PIPE_DRIVER_QUERY_TYPE_WATTS,
1220 };
1221
1222 /* Whether an average value per frame or a cumulative value should be
1223  * displayed.
1224  */
1225 enum pipe_driver_query_result_type
1226 {
1227    PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE,
1228    PIPE_DRIVER_QUERY_RESULT_TYPE_CUMULATIVE,
1229 };
1230
1231 /**
1232  * Some hardware requires some hardware-specific queries to be submitted
1233  * as batched queries. The corresponding query objects are created using
1234  * create_batch_query, and at most one such query may be active at
1235  * any time.
1236  */
1237 #define PIPE_DRIVER_QUERY_FLAG_BATCH     (1 << 0)
1238
1239 /* Do not list this query in the HUD. */
1240 #define PIPE_DRIVER_QUERY_FLAG_DONT_LIST (1 << 1)
1241
1242 struct pipe_driver_query_info
1243 {
1244    const char *name;
1245    unsigned query_type; /* PIPE_QUERY_DRIVER_SPECIFIC + i */
1246    union pipe_numeric_type_union max_value; /* max value that can be returned */
1247    enum pipe_driver_query_type type;
1248    enum pipe_driver_query_result_type result_type;
1249    unsigned group_id;
1250    unsigned flags;
1251 };
1252
1253 struct pipe_driver_query_group_info
1254 {
1255    const char *name;
1256    unsigned max_active_queries;
1257    unsigned num_queries;
1258 };
1259
1260 enum pipe_fd_type
1261 {
1262    PIPE_FD_TYPE_NATIVE_SYNC,
1263    PIPE_FD_TYPE_SYNCOBJ,
1264 };
1265
1266 /**
1267  * counter type and counter data type enums used by INTEL_performance_query
1268  * APIs in gallium drivers.
1269  */
1270 enum pipe_perf_counter_type
1271 {
1272    PIPE_PERF_COUNTER_TYPE_EVENT,
1273    PIPE_PERF_COUNTER_TYPE_DURATION_NORM,
1274    PIPE_PERF_COUNTER_TYPE_DURATION_RAW,
1275    PIPE_PERF_COUNTER_TYPE_THROUGHPUT,
1276    PIPE_PERF_COUNTER_TYPE_RAW,
1277    PIPE_PERF_COUNTER_TYPE_TIMESTAMP,
1278 };
1279
1280 enum pipe_perf_counter_data_type
1281 {
1282    PIPE_PERF_COUNTER_DATA_TYPE_BOOL32,
1283    PIPE_PERF_COUNTER_DATA_TYPE_UINT32,
1284    PIPE_PERF_COUNTER_DATA_TYPE_UINT64,
1285    PIPE_PERF_COUNTER_DATA_TYPE_FLOAT,
1286    PIPE_PERF_COUNTER_DATA_TYPE_DOUBLE,
1287 };
1288
1289 #define PIPE_UUID_SIZE 16
1290
1291 #ifdef __cplusplus
1292 }
1293 #endif
1294
1295 #endif