p_defines.h revision a45b7f47ee0e38b288cc8fc4f6a1c013e8c227bc
1/************************************************************************** 2 * 3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas. 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 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. 25 * 26 **************************************************************************/ 27 28#ifndef PIPE_DEFINES_H 29#define PIPE_DEFINES_H 30 31#include "p_format.h" 32 33#ifdef __cplusplus 34extern "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 */ 44enum pipe_error { 45 PIPE_OK = 0, 46 PIPE_ERROR = -1, /**< Generic error */ 47 PIPE_ERROR_BAD_INPUT = -2, 48 PIPE_ERROR_OUT_OF_MEMORY = -3, 49 PIPE_ERROR_RETRY = -4 50 /* TODO */ 51}; 52 53 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 73 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 79 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 96 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 102 103 104/** 105 * Inequality functions. Used for depth test, stencil compare, alpha 106 * test, shadow compare, etc. 107 */ 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 116 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 121 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) 127 128/** Stencil ops */ 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 137 138/** Texture types */ 139enum pipe_texture_target { 140 PIPE_BUFFER = 0, 141 PIPE_TEXTURE_1D = 1, 142 PIPE_TEXTURE_2D = 2, 143 PIPE_TEXTURE_3D = 3, 144 PIPE_TEXTURE_CUBE = 4, 145 PIPE_MAX_TEXTURE_TYPES 146}; 147 148#define PIPE_TEX_FACE_POS_X 0 149#define PIPE_TEX_FACE_NEG_X 1 150#define PIPE_TEX_FACE_POS_Y 2 151#define PIPE_TEX_FACE_NEG_Y 3 152#define PIPE_TEX_FACE_POS_Z 4 153#define PIPE_TEX_FACE_NEG_Z 5 154#define PIPE_TEX_FACE_MAX 6 155 156#define PIPE_TEX_WRAP_REPEAT 0 157#define PIPE_TEX_WRAP_CLAMP 1 158#define PIPE_TEX_WRAP_CLAMP_TO_EDGE 2 159#define PIPE_TEX_WRAP_CLAMP_TO_BORDER 3 160#define PIPE_TEX_WRAP_MIRROR_REPEAT 4 161#define PIPE_TEX_WRAP_MIRROR_CLAMP 5 162#define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_EDGE 6 163#define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_BORDER 7 164 165/* Between mipmaps, ie mipfilter 166 */ 167#define PIPE_TEX_MIPFILTER_NEAREST 0 168#define PIPE_TEX_MIPFILTER_LINEAR 1 169#define PIPE_TEX_MIPFILTER_NONE 2 170 171/* Within a mipmap, ie min/mag filter 172 */ 173#define PIPE_TEX_FILTER_NEAREST 0 174#define PIPE_TEX_FILTER_LINEAR 1 175 176#define PIPE_TEX_COMPARE_NONE 0 177#define PIPE_TEX_COMPARE_R_TO_TEXTURE 1 178 179 180/** 181 * Surface layout -- a hint? Or some driver-internal poking out into 182 * the interface? 183 */ 184#define PIPE_SURFACE_LAYOUT_LINEAR 0 185 186 187/** 188 * Clear buffer bits 189 */ 190/** All color buffers currently bound */ 191#define PIPE_CLEAR_COLOR (1 << 0) 192#define PIPE_CLEAR_DEPTH (1 << 1) 193#define PIPE_CLEAR_STENCIL (1 << 2) 194/** Depth/stencil combined */ 195#define PIPE_CLEAR_DEPTHSTENCIL (PIPE_CLEAR_DEPTH | PIPE_CLEAR_STENCIL) 196 197/** 198 * Transfer object usage flags 199 */ 200enum pipe_transfer_usage { 201 /** 202 * Resource contents read back (or accessed directly) at transfer 203 * create time. 204 */ 205 PIPE_TRANSFER_READ = (1 << 0), 206 207 /** 208 * Resource contents will be written back at transfer_destroy 209 * time (or modified as a result of being accessed directly). 210 */ 211 PIPE_TRANSFER_WRITE = (1 << 1), 212 213 /** 214 * Read/modify/write 215 */ 216 PIPE_TRANSFER_READ_WRITE = PIPE_TRANSFER_READ | PIPE_TRANSFER_WRITE, 217 218 /** 219 * The transfer should map the texture storage directly. The driver may 220 * return NULL if that isn't possible, and the state tracker needs to cope 221 * with that and use an alternative path without this flag. 222 * 223 * E.g. the state tracker could have a simpler path which maps textures and 224 * does read/modify/write cycles on them directly, and a more complicated 225 * path which uses minimal read and write transfers. 226 */ 227 PIPE_TRANSFER_MAP_DIRECTLY = (1 << 2), 228 229 /** 230 * Discards the memory within the mapped region. 231 * 232 * It should not be used with PIPE_TRANSFER_CPU_READ. 233 * 234 * See also: 235 * - OpenGL's ARB_map_buffer_range extension, MAP_INVALIDATE_RANGE_BIT flag. 236 * - Direct3D's D3DLOCK_DISCARD flag. 237 */ 238 PIPE_TRANSFER_DISCARD = (1 << 8), 239 240 /** 241 * Fail if the resource cannot be mapped immediately. 242 * 243 * See also: 244 * - Direct3D's D3DLOCK_DONOTWAIT flag. 245 * - Mesa3D's MESA_MAP_NOWAIT_BIT flag. 246 * - WDDM's D3DDDICB_LOCKFLAGS.DonotWait flag. 247 */ 248 PIPE_TRANSFER_DONTBLOCK = (1 << 9), 249 250 /** 251 * Do not attempt to synchronize pending operations on the resource when mapping. 252 * 253 * It should not be used with PIPE_TRANSFER_CPU_READ. 254 * 255 * See also: 256 * - OpenGL's ARB_map_buffer_range extension, MAP_UNSYNCHRONIZED_BIT flag. 257 * - Direct3D's D3DLOCK_NOOVERWRITE flag. 258 * - WDDM's D3DDDICB_LOCKFLAGS.IgnoreSync flag. 259 */ 260 PIPE_TRANSFER_UNSYNCHRONIZED = (1 << 10), 261 PIPE_TRANSFER_NOOVERWRITE = (1 << 10), /* are these really the same?? */ 262 263 /** 264 * Written ranges will be notified later with 265 * pipe_context::transfer_flush_region. 266 * 267 * It should not be used with PIPE_TRANSFER_CPU_READ. 268 * 269 * See also: 270 * - pipe_context::transfer_flush_region 271 * - OpenGL's ARB_map_buffer_range extension, MAP_FLUSH_EXPLICIT_BIT flag. 272 */ 273 PIPE_TRANSFER_FLUSH_EXPLICIT = (1 << 11) 274 275}; 276 277 278/* 279 * Resource binding flags -- state tracker must specify in advance all 280 * the ways a resource might be used. 281 */ 282#define PIPE_BIND_DEPTH_STENCIL (1 << 0) /* get_tex_surface */ 283#define PIPE_BIND_RENDER_TARGET (1 << 1) /* get_tex_surface */ 284#define PIPE_BIND_SAMPLER_VIEW (1 << 2) /* get_sampler_view */ 285#define PIPE_BIND_VERTEX_BUFFER (1 << 3) /* set_vertex_buffers */ 286#define PIPE_BIND_INDEX_BUFFER (1 << 4) /* draw_elements */ 287#define PIPE_BIND_CONSTANT_BUFFER (1 << 5) /* set_constant_buffer */ 288#define PIPE_BIND_DISPLAY_TARGET (1 << 8) /* flush_front_buffer */ 289#define PIPE_BIND_TRANSFER_WRITE (1 << 9) /* get_transfer */ 290#define PIPE_BIND_TRANSFER_READ (1 << 10) /* get_transfer */ 291#define PIPE_BIND_STREAM_OUTPUT (1 << 11) /* set_stream_output_buffers */ 292#define PIPE_BIND_CUSTOM (1 << 16) /* state-tracker/winsys usages */ 293 294/* The first two flags above were previously part of the amorphous 295 * TEXTURE_USAGE, most of which are now descriptions of the ways a 296 * particular texture can be bound to the gallium pipeline. The two flags 297 * below do not fit within that and probably need to be migrated to some 298 * other place. 299 * 300 * It seems like scanout is used by the Xorg state tracker to ask for 301 * a texture suitable for actual scanout (hence the name), which 302 * implies extra layout constraints on some hardware. It may also 303 * have some special meaning regarding mouse cursor images. 304 * 305 * The shared flag is quite underspecified, but certainly isn't a 306 * binding flag - it seems more like a message to the winsys to create 307 * a shareable allocation. 308 */ 309#define PIPE_BIND_SCANOUT (1 << 14) /* */ 310#define PIPE_BIND_SHARED (1 << 15) /* get_texture_handle ??? */ 311 312 313/* Flags for the driver about resource behaviour: 314 */ 315#define PIPE_RESOURCE_FLAG_GEN_MIPS (1 << 0) /* Driver performs autogen mips */ 316#define PIPE_RESOURCE_FLAG_DRV_PRIV (1 << 16) /* driver/winsys private */ 317#define PIPE_RESOURCE_FLAG_ST_PRIV (1 << 24) /* state-tracker/winsys private */ 318 319/* Hint about the expected lifecycle of a resource. 320 */ 321#define PIPE_USAGE_DEFAULT 0 /* many uploads, draws intermixed */ 322#define PIPE_USAGE_DYNAMIC 1 /* many uploads, draws intermixed */ 323#define PIPE_USAGE_STATIC 2 /* same as immutable?? */ 324#define PIPE_USAGE_IMMUTABLE 3 /* no change after first upload */ 325#define PIPE_USAGE_STREAM 4 /* upload, draw, upload, draw */ 326#define PIPE_USAGE_STAGING 5 /* supports data transfers from the GPU to the CPU */ 327 328 329/* These are intended to be used in calls to is_format_supported, but 330 * no driver actually uses these flags, and only the glx/xlib state 331 * tracker issues them. 332 * 333 * Deprecate? 334 */ 335#define PIPE_TEXTURE_GEOM_NON_SQUARE 0x1 336#define PIPE_TEXTURE_GEOM_NON_POWER_OF_TWO 0x2 337 338 339/** 340 * Flush types: 341 */ 342#define PIPE_FLUSH_RENDER_CACHE 0x1 343#define PIPE_FLUSH_TEXTURE_CACHE 0x2 344#define PIPE_FLUSH_SWAPBUFFERS 0x4 345#define PIPE_FLUSH_FRAME 0x8 /**< Mark the end of a frame */ 346 347 348/** 349 * Shaders 350 */ 351#define PIPE_SHADER_VERTEX 0 352#define PIPE_SHADER_FRAGMENT 1 353#define PIPE_SHADER_GEOMETRY 2 354#define PIPE_SHADER_TYPES 3 355 356 357/** 358 * Primitive types: 359 */ 360#define PIPE_PRIM_POINTS 0 361#define PIPE_PRIM_LINES 1 362#define PIPE_PRIM_LINE_LOOP 2 363#define PIPE_PRIM_LINE_STRIP 3 364#define PIPE_PRIM_TRIANGLES 4 365#define PIPE_PRIM_TRIANGLE_STRIP 5 366#define PIPE_PRIM_TRIANGLE_FAN 6 367#define PIPE_PRIM_QUADS 7 368#define PIPE_PRIM_QUAD_STRIP 8 369#define PIPE_PRIM_POLYGON 9 370#define PIPE_PRIM_LINES_ADJACENCY 10 371#define PIPE_PRIM_LINE_STRIP_ADJACENCY 11 372#define PIPE_PRIM_TRIANGLES_ADJACENCY 12 373#define PIPE_PRIM_TRIANGLE_STRIP_ADJACENCY 13 374#define PIPE_PRIM_MAX 14 375 376 377/** 378 * Query object types 379 */ 380#define PIPE_QUERY_OCCLUSION_COUNTER 0 381#define PIPE_QUERY_PRIMITIVES_GENERATED 1 382#define PIPE_QUERY_PRIMITIVES_EMITTED 2 383#define PIPE_QUERY_TIME_ELAPSED 3 384#define PIPE_QUERY_TYPES 4 385 386 387/** 388 * Conditional rendering modes 389 */ 390#define PIPE_RENDER_COND_WAIT 0 391#define PIPE_RENDER_COND_NO_WAIT 1 392#define PIPE_RENDER_COND_BY_REGION_WAIT 2 393#define PIPE_RENDER_COND_BY_REGION_NO_WAIT 3 394 395 396/** 397 * Point sprite coord modes 398 */ 399#define PIPE_SPRITE_COORD_UPPER_LEFT 0 400#define PIPE_SPRITE_COORD_LOWER_LEFT 1 401 402 403/** 404 * Texture swizzles 405 */ 406#define PIPE_SWIZZLE_RED 0 407#define PIPE_SWIZZLE_GREEN 1 408#define PIPE_SWIZZLE_BLUE 2 409#define PIPE_SWIZZLE_ALPHA 3 410#define PIPE_SWIZZLE_ZERO 4 411#define PIPE_SWIZZLE_ONE 5 412 413 414/** 415 * Implementation capabilities/limits which are queried through 416 * pipe_screen::get_param() and pipe_screen::get_paramf(). 417 */ 418enum pipe_cap { 419 PIPE_CAP_MAX_TEXTURE_IMAGE_UNITS, 420 PIPE_CAP_NPOT_TEXTURES, 421 PIPE_CAP_TWO_SIDED_STENCIL, 422 PIPE_CAP_GLSL, /* XXX need something better */ 423 PIPE_CAP_DUAL_SOURCE_BLEND, 424 PIPE_CAP_ANISOTROPIC_FILTER, 425 PIPE_CAP_POINT_SPRITE, 426 PIPE_CAP_MAX_RENDER_TARGETS, 427 PIPE_CAP_OCCLUSION_QUERY, 428 PIPE_CAP_TIMER_QUERY, 429 PIPE_CAP_TEXTURE_SHADOW_MAP, 430 PIPE_CAP_TEXTURE_SWIZZLE, 431 PIPE_CAP_MAX_TEXTURE_2D_LEVELS, 432 PIPE_CAP_MAX_TEXTURE_3D_LEVELS, 433 PIPE_CAP_MAX_TEXTURE_CUBE_LEVELS, 434 PIPE_CAP_MAX_LINE_WIDTH, 435 PIPE_CAP_MAX_LINE_WIDTH_AA, 436 PIPE_CAP_MAX_POINT_WIDTH, 437 PIPE_CAP_MAX_POINT_WIDTH_AA, 438 PIPE_CAP_MAX_TEXTURE_ANISOTROPY, 439 PIPE_CAP_MAX_TEXTURE_LOD_BIAS, 440 PIPE_CAP_GUARD_BAND_LEFT, /*< float */ 441 PIPE_CAP_GUARD_BAND_TOP, /*< float */ 442 PIPE_CAP_GUARD_BAND_RIGHT, /*< float */ 443 PIPE_CAP_GUARD_BAND_BOTTOM, /*< float */ 444 PIPE_CAP_TEXTURE_MIRROR_CLAMP, 445 PIPE_CAP_TEXTURE_MIRROR_REPEAT, 446 PIPE_CAP_MAX_VERTEX_TEXTURE_UNITS, 447 PIPE_CAP_TGSI_CONT_SUPPORTED, 448 PIPE_CAP_BLEND_EQUATION_SEPARATE, 449 PIPE_CAP_SM3, /*< Shader Model, supported */ 450 PIPE_CAP_MAX_PREDICATE_REGISTERS, 451 /** Maximum texture image units accessible from vertex and fragment shaders 452 * combined */ 453 PIPE_CAP_MAX_COMBINED_SAMPLERS, 454 PIPE_CAP_MAX_CONST_BUFFERS, 455 PIPE_CAP_MAX_CONST_BUFFER_SIZE, /*< In bytes */ 456 /** blend enables and write masks per rendertarget */ 457 PIPE_CAP_INDEP_BLEND_ENABLE, 458 /** different blend funcs per rendertarget */ 459 PIPE_CAP_INDEP_BLEND_FUNC, 460 PIPE_CAP_DEPTHSTENCIL_CLEAR_SEPARATE, 461 PIPE_CAP_TGSI_FS_COORD_ORIGIN_UPPER_LEFT, 462 PIPE_CAP_TGSI_FS_COORD_ORIGIN_LOWER_LEFT, 463 PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_HALF_INTEGER, 464 PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_INTEGER, 465 466 /* 467 * Shader limits. 468 */ 469 PIPE_CAP_MAX_FS_INSTRUCTIONS, 470 PIPE_CAP_MAX_FS_ALU_INSTRUCTIONS, 471 PIPE_CAP_MAX_FS_TEX_INSTRUCTIONS, 472 PIPE_CAP_MAX_FS_TEX_INDIRECTIONS, 473 PIPE_CAP_MAX_FS_CONTROL_FLOW_DEPTH, 474 PIPE_CAP_MAX_FS_INPUTS, 475 PIPE_CAP_MAX_FS_CONSTS, 476 PIPE_CAP_MAX_FS_TEMPS, 477 PIPE_CAP_MAX_FS_ADDRS, 478 PIPE_CAP_MAX_FS_PREDS, 479 PIPE_CAP_MAX_VS_INSTRUCTIONS, 480 PIPE_CAP_MAX_VS_ALU_INSTRUCTIONS, 481 PIPE_CAP_MAX_VS_TEX_INSTRUCTIONS, 482 PIPE_CAP_MAX_VS_TEX_INDIRECTIONS, 483 PIPE_CAP_MAX_VS_CONTROL_FLOW_DEPTH, 484 PIPE_CAP_MAX_VS_INPUTS, 485 PIPE_CAP_MAX_VS_CONSTS, 486 PIPE_CAP_MAX_VS_TEMPS, 487 PIPE_CAP_MAX_VS_ADDRS, 488 PIPE_CAP_MAX_VS_PREDS 489}; 490 491 492/** 493 * Referenced query flags. 494 */ 495 496#define PIPE_UNREFERENCED 0 497#define PIPE_REFERENCED_FOR_READ (1 << 0) 498#define PIPE_REFERENCED_FOR_WRITE (1 << 1) 499 500 501#ifdef __cplusplus 502} 503#endif 504 505#endif 506