src/gallium/include/pipe/p_defines.h

   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
  34 extern "C" {
  35 #endif
  36
  37 #define PIPE_BLENDFACTOR_ONE                 0x1
  38 #define PIPE_BLENDFACTOR_SRC_COLOR           0x2
  39 #define PIPE_BLENDFACTOR_SRC_ALPHA           0x3
  40 #define PIPE_BLENDFACTOR_DST_ALPHA           0x4
  41 #define PIPE_BLENDFACTOR_DST_COLOR           0x5
  42 #define PIPE_BLENDFACTOR_SRC_ALPHA_SATURATE  0x6
  43 #define PIPE_BLENDFACTOR_CONST_COLOR         0x7
  44 #define PIPE_BLENDFACTOR_CONST_ALPHA         0x8
  45 #define PIPE_BLENDFACTOR_SRC1_COLOR          0x9
  46 #define PIPE_BLENDFACTOR_SRC1_ALPHA          0x0A
  47 #define PIPE_BLENDFACTOR_ZERO                0x11
  48 #define PIPE_BLENDFACTOR_INV_SRC_COLOR       0x12
  49 #define PIPE_BLENDFACTOR_INV_SRC_ALPHA       0x13
  50 #define PIPE_BLENDFACTOR_INV_DST_ALPHA       0x14
  51 #define PIPE_BLENDFACTOR_INV_DST_COLOR       0x15
  52 #define PIPE_BLENDFACTOR_INV_CONST_COLOR     0x17
  53 #define PIPE_BLENDFACTOR_INV_CONST_ALPHA     0x18
  54 #define PIPE_BLENDFACTOR_INV_SRC1_COLOR      0x19
  55 #define PIPE_BLENDFACTOR_INV_SRC1_ALPHA      0x1A
  56
  57 #define PIPE_BLEND_ADD               0
  58 #define PIPE_BLEND_SUBTRACT          1
  59 #define PIPE_BLEND_REVERSE_SUBTRACT  2
  60 #define PIPE_BLEND_MIN               3
  61 #define PIPE_BLEND_MAX               4
  62
  63 #define PIPE_LOGICOP_CLEAR            0
  64 #define PIPE_LOGICOP_NOR              1
  65 #define PIPE_LOGICOP_AND_INVERTED     2
  66 #define PIPE_LOGICOP_COPY_INVERTED    3
  67 #define PIPE_LOGICOP_AND_REVERSE      4
  68 #define PIPE_LOGICOP_INVERT           5
  69 #define PIPE_LOGICOP_XOR              6
  70 #define PIPE_LOGICOP_NAND             7
  71 #define PIPE_LOGICOP_AND              8
  72 #define PIPE_LOGICOP_EQUIV            9
  73 #define PIPE_LOGICOP_NOOP             10
  74 #define PIPE_LOGICOP_OR_INVERTED      11
  75 #define PIPE_LOGICOP_COPY             12
  76 #define PIPE_LOGICOP_OR_REVERSE       13
  77 #define PIPE_LOGICOP_OR               14
  78 #define PIPE_LOGICOP_SET              15
  79
  80 #define PIPE_MASK_R  0x1
  81 #define PIPE_MASK_G  0x2
  82 #define PIPE_MASK_B  0x4
  83 #define PIPE_MASK_A  0x8
  84 #define PIPE_MASK_RGBA 0xf
  85
  86
  87 /**
  88  * Inequality functions.  Used for depth test, stencil compare, alpha
  89  * test, shadow compare, etc.
  90  */
  91 #define PIPE_FUNC_NEVER    0
  92 #define PIPE_FUNC_LESS     1
  93 #define PIPE_FUNC_EQUAL    2
  94 #define PIPE_FUNC_LEQUAL   3
  95 #define PIPE_FUNC_GREATER  4
  96 #define PIPE_FUNC_NOTEQUAL 5
  97 #define PIPE_FUNC_GEQUAL   6
  98 #define PIPE_FUNC_ALWAYS   7
  99
 100 /** Polygon fill mode */
 101 #define PIPE_POLYGON_MODE_FILL  0
 102 #define PIPE_POLYGON_MODE_LINE  1
 103 #define PIPE_POLYGON_MODE_POINT 2
 104
 105 /** Polygon front/back window, also for culling */
 106 #define PIPE_WINDING_NONE 0
 107 #define PIPE_WINDING_CW   1
 108 #define PIPE_WINDING_CCW  2
 109 #define PIPE_WINDING_BOTH (PIPE_WINDING_CW | PIPE_WINDING_CCW)
 110
 111 /** Stencil ops */
 112 #define PIPE_STENCIL_OP_KEEP       0
 113 #define PIPE_STENCIL_OP_ZERO       1
 114 #define PIPE_STENCIL_OP_REPLACE    2
 115 #define PIPE_STENCIL_OP_INCR       3
 116 #define PIPE_STENCIL_OP_DECR       4
 117 #define PIPE_STENCIL_OP_INCR_WRAP  5
 118 #define PIPE_STENCIL_OP_DECR_WRAP  6
 119 #define PIPE_STENCIL_OP_INVERT     7
 120
 121 /** Texture types */
 122 enum pipe_texture_target {
 123    PIPE_TEXTURE_1D   = 0,
 124    PIPE_TEXTURE_2D   = 1,
 125    PIPE_TEXTURE_3D   = 2,
 126    PIPE_TEXTURE_CUBE = 3
 127 };
 128
 129 #define PIPE_TEX_FACE_POS_X 0
 130 #define PIPE_TEX_FACE_NEG_X 1
 131 #define PIPE_TEX_FACE_POS_Y 2
 132 #define PIPE_TEX_FACE_NEG_Y 3
 133 #define PIPE_TEX_FACE_POS_Z 4
 134 #define PIPE_TEX_FACE_NEG_Z 5
 135 #define PIPE_TEX_FACE_MAX   6
 136
 137 #define PIPE_TEX_WRAP_REPEAT                   0
 138 #define PIPE_TEX_WRAP_CLAMP                    1
 139 #define PIPE_TEX_WRAP_CLAMP_TO_EDGE            2
 140 #define PIPE_TEX_WRAP_CLAMP_TO_BORDER          3
 141 #define PIPE_TEX_WRAP_MIRROR_REPEAT            4
 142 #define PIPE_TEX_WRAP_MIRROR_CLAMP             5
 143 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_EDGE     6
 144 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_BORDER   7
 145
 146 /* Between mipmaps, ie mipfilter
 147  */
 148 #define PIPE_TEX_MIPFILTER_NEAREST  0
 149 #define PIPE_TEX_MIPFILTER_LINEAR   1
 150 #define PIPE_TEX_MIPFILTER_NONE     2
 151
 152 /* Within a mipmap, ie min/mag filter
 153  */
 154 #define PIPE_TEX_FILTER_NEAREST      0
 155 #define PIPE_TEX_FILTER_LINEAR       1
 156 #define PIPE_TEX_FILTER_ANISO        2
 157
 158
 159 #define PIPE_TEX_COMPARE_NONE          0
 160 #define PIPE_TEX_COMPARE_R_TO_TEXTURE  1
 161
 162 #define PIPE_TEXTURE_USAGE_RENDER_TARGET   0x1
 163 #define PIPE_TEXTURE_USAGE_DISPLAY_TARGET  0x2 /* ie a backbuffer */
 164 #define PIPE_TEXTURE_USAGE_PRIMARY         0x4 /* ie a frontbuffer */
 165 #define PIPE_TEXTURE_USAGE_DEPTH_STENCIL   0x8
 166 #define PIPE_TEXTURE_USAGE_SAMPLER         0x10
 167 #define PIPE_TEXTURE_USAGE_DYNAMIC         0x20
 168 /** Pipe driver custom usage flags should be greater or equal to this value */
 169 #define PIPE_TEXTURE_USAGE_CUSTOM          (1 << 16)
 170
 171 #define PIPE_TEXTURE_GEOM_NON_SQUARE       0x1
 172 #define PIPE_TEXTURE_GEOM_NON_POWER_OF_TWO 0x2
 173
 174
 175 /**
 176  * Surface layout
 177  */
 178 #define PIPE_SURFACE_LAYOUT_LINEAR  0
 179
 180
 181 /**
 182  * Clear buffer bits
 183  */
 184 /** All color buffers currently bound */
 185 #define PIPE_CLEAR_COLOR        (1 << 0)
 186 /** Depth/stencil combined */
 187 #define PIPE_CLEAR_DEPTHSTENCIL (1 << 1)
 188
 189
 190 /**
 191  * Transfer object usage flags
 192  */
 193 enum pipe_transfer_usage {
 194    PIPE_TRANSFER_READ = (1 << 0),
 195    PIPE_TRANSFER_WRITE = (1 << 1),
 196    /** Read/modify/write */
 197    PIPE_TRANSFER_READ_WRITE = PIPE_TRANSFER_READ | PIPE_TRANSFER_WRITE,
 198    /**
 199     * The transfer should map the texture storage directly. The driver may
 200     * return NULL if that isn't possible, and the state tracker needs to cope
 201     * with that and use an alternative path without this flag.
 202     *
 203     * E.g. the state tracker could have a simpler path which maps textures and
 204     * does read/modify/write cycles on them directly, and a more complicated
 205     * path which uses minimal read and write transfers.
 206     */
 207    PIPE_TRANSFER_MAP_DIRECTLY = (1 << 2)
 208 };
 209
 210
 211 /**
 212  * Buffer usage flags
 213  */
 214 #define PIPE_BUFFER_USAGE_CPU_READ  (1 << 0)
 215 #define PIPE_BUFFER_USAGE_CPU_WRITE (1 << 1)
 216 #define PIPE_BUFFER_USAGE_GPU_READ  (1 << 2)
 217 #define PIPE_BUFFER_USAGE_GPU_WRITE (1 << 3)
 218 #define PIPE_BUFFER_USAGE_PIXEL     (1 << 4)
 219 #define PIPE_BUFFER_USAGE_VERTEX    (1 << 5)
 220 #define PIPE_BUFFER_USAGE_INDEX     (1 << 6)
 221 #define PIPE_BUFFER_USAGE_CONSTANT  (1 << 7)
 222 #define PIPE_BUFFER_USAGE_DISCARD   (1 << 8)
 223 #define PIPE_BUFFER_USAGE_DONTBLOCK (1 << 9)
 224 #define PIPE_BUFFER_USAGE_FLUSH_EXPLICIT (1 << 10) /**< See pipe_screen::buffer_flush_mapped_range */
 225 /** Pipe driver custom usage flags should be greater or equal to this value */
 226 #define PIPE_BUFFER_USAGE_CUSTOM    (1 << 16)
 227
 228 /* Convenient shortcuts */
 229 #define PIPE_BUFFER_USAGE_CPU_READ_WRITE \
 230    ( PIPE_BUFFER_USAGE_CPU_READ | PIPE_BUFFER_USAGE_CPU_WRITE )
 231 #define PIPE_BUFFER_USAGE_GPU_READ_WRITE \
 232    ( PIPE_BUFFER_USAGE_GPU_READ | PIPE_BUFFER_USAGE_GPU_WRITE )
 233 #define PIPE_BUFFER_USAGE_WRITE \
 234    ( PIPE_BUFFER_USAGE_CPU_WRITE | PIPE_BUFFER_USAGE_GPU_WRITE )
 235
 236
 237 /**
 238  * Flush types:
 239  */
 240 #define PIPE_FLUSH_RENDER_CACHE   0x1
 241 #define PIPE_FLUSH_TEXTURE_CACHE  0x2
 242 #define PIPE_FLUSH_SWAPBUFFERS    0x4
 243 #define PIPE_FLUSH_FRAME          0x8 /**< Mark the end of a frame */
 244
 245
 246 /**
 247  * Shaders
 248  */
 249 #define PIPE_SHADER_VERTEX   0
 250 #define PIPE_SHADER_FRAGMENT 1
 251 #define PIPE_SHADER_TYPES    2
 252
 253
 254 /**
 255  * Primitive types:
 256  */
 257 #define PIPE_PRIM_POINTS          0
 258 #define PIPE_PRIM_LINES           1
 259 #define PIPE_PRIM_LINE_LOOP       2
 260 #define PIPE_PRIM_LINE_STRIP      3
 261 #define PIPE_PRIM_TRIANGLES       4
 262 #define PIPE_PRIM_TRIANGLE_STRIP  5
 263 #define PIPE_PRIM_TRIANGLE_FAN    6
 264 #define PIPE_PRIM_QUADS           7
 265 #define PIPE_PRIM_QUAD_STRIP      8
 266 #define PIPE_PRIM_POLYGON         9
 267 #define PIPE_PRIM_MAX             10
 268
 269
 270 /**
 271  * Query object types
 272  */
 273 #define PIPE_QUERY_OCCLUSION_COUNTER     0
 274 #define PIPE_QUERY_PRIMITIVES_GENERATED  1
 275 #define PIPE_QUERY_PRIMITIVES_EMITTED    2
 276 #define PIPE_QUERY_TYPES                 3
 277
 278
 279 /**
 280  * Point sprite coord modes
 281  */
 282 #define PIPE_SPRITE_COORD_NONE       0
 283 #define PIPE_SPRITE_COORD_UPPER_LEFT 1
 284 #define PIPE_SPRITE_COORD_LOWER_LEFT 2
 285
 286
 287 /**
 288  * Implementation capabilities/limits which are queried through
 289  * pipe_screen::get_param() and pipe_screen::get_paramf().
 290  */
 291 #define PIPE_CAP_MAX_TEXTURE_IMAGE_UNITS 1
 292 #define PIPE_CAP_NPOT_TEXTURES           2
 293 #define PIPE_CAP_TWO_SIDED_STENCIL       3
 294 #define PIPE_CAP_GLSL                    4  /* XXX need something better */
 295 #define PIPE_CAP_S3TC                    5  /* XXX: deprecated; cap determined via supported sampler formats */
 296 #define PIPE_CAP_ANISOTROPIC_FILTER      6
 297 #define PIPE_CAP_POINT_SPRITE            7
 298 #define PIPE_CAP_MAX_RENDER_TARGETS      8
 299 #define PIPE_CAP_OCCLUSION_QUERY         9
 300 #define PIPE_CAP_TEXTURE_SHADOW_MAP      10
 301 #define PIPE_CAP_MAX_TEXTURE_2D_LEVELS   11
 302 #define PIPE_CAP_MAX_TEXTURE_3D_LEVELS   12
 303 #define PIPE_CAP_MAX_TEXTURE_CUBE_LEVELS 13
 304 #define PIPE_CAP_MAX_LINE_WIDTH          14
 305 #define PIPE_CAP_MAX_LINE_WIDTH_AA       15
 306 #define PIPE_CAP_MAX_POINT_WIDTH         16
 307 #define PIPE_CAP_MAX_POINT_WIDTH_AA      17
 308 #define PIPE_CAP_MAX_TEXTURE_ANISOTROPY  18
 309 #define PIPE_CAP_MAX_TEXTURE_LOD_BIAS    19
 310 #define PIPE_CAP_GUARD_BAND_LEFT         20  /*< float */
 311 #define PIPE_CAP_GUARD_BAND_TOP          21  /*< float */
 312 #define PIPE_CAP_GUARD_BAND_RIGHT        22  /*< float */
 313 #define PIPE_CAP_GUARD_BAND_BOTTOM       23  /*< float */
 314 #define PIPE_CAP_TEXTURE_MIRROR_CLAMP    24
 315 #define PIPE_CAP_TEXTURE_MIRROR_REPEAT   25
 316 #define PIPE_CAP_MAX_VERTEX_TEXTURE_UNITS 26
 317 #define PIPE_CAP_TGSI_CONT_SUPPORTED     27
 318 #define PIPE_CAP_BLEND_EQUATION_SEPARATE 28
 319
 320
 321 /**
 322  * Referenced query flags.
 323  */
 324
 325 #define PIPE_UNREFERENCED         0
 326 #define PIPE_REFERENCED_FOR_READ  (1 << 0)
 327 #define PIPE_REFERENCED_FOR_WRITE (1 << 1)
 328
 329
 330 enum pipe_video_codec
 331 {
 332    PIPE_VIDEO_CODEC_UNKNOWN = 0,
 333    PIPE_VIDEO_CODEC_MPEG12,   /**< MPEG1, MPEG2 */
 334    PIPE_VIDEO_CODEC_MPEG4,    /**< DIVX, XVID */
 335    PIPE_VIDEO_CODEC_VC1,      /**< WMV */
 336    PIPE_VIDEO_CODEC_MPEG4_AVC /**< H.264 */
 337 };
 338
 339 enum pipe_video_profile
 340 {
 341    PIPE_VIDEO_PROFILE_MPEG1,
 342    PIPE_VIDEO_PROFILE_MPEG2_SIMPLE,
 343    PIPE_VIDEO_PROFILE_MPEG2_MAIN,
 344    PIPE_VIDEO_PROFILE_MPEG4_SIMPLE,
 345    PIPE_VIDEO_PROFILE_MPEG4_ADVANCED_SIMPLE,
 346    PIPE_VIDEO_PROFILE_VC1_SIMPLE,
 347    PIPE_VIDEO_PROFILE_VC1_MAIN,
 348    PIPE_VIDEO_PROFILE_VC1_ADVANCED,
 349    PIPE_VIDEO_PROFILE_MPEG4_AVC_BASELINE,
 350    PIPE_VIDEO_PROFILE_MPEG4_AVC_MAIN,
 351    PIPE_VIDEO_PROFILE_MPEG4_AVC_HIGH
 352 };
 353
 354 #ifdef __cplusplus
 355 }
 356 #endif
 357
 358 #endif