p_defines.h revision 42ebe3dfd9b0803913e0d932909ca5872d937c20 
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_CUSTOM               (1 << 16) /* state-tracker/winsys usages */
292
293/* The first two flags above were previously part of the amorphous
294 * TEXTURE_USAGE, most of which are now descriptions of the ways a
295 * particular texture can be bound to the gallium pipeline.  The two flags
296 * below do not fit within that and probably need to be migrated to some
297 * other place.
298 *
299 * It seems like scanout is used by the Xorg state tracker to ask for
300 * a texture suitable for actual scanout (hence the name), which
301 * implies extra layout constraints on some hardware.  It may also
302 * have some special meaning regarding mouse cursor images.
303 *
304 * The shared flag is quite underspecified, but certainly isn't a
305 * binding flag - it seems more like a message to the winsys to create
306 * a shareable allocation.
307 */
308#define PIPE_BIND_SCANOUT     (1 << 14) /*  */
309#define PIPE_BIND_SHARED      (1 << 15) /* get_texture_handle ??? */
310
311
312/* Flags for the driver about resource behaviour:
313 */
314#define PIPE_RESOURCE_FLAG_GEN_MIPS    (1 << 0)  /* Driver performs autogen mips */
315#define PIPE_RESOURCE_FLAG_DRV_PRIV    (1 << 16) /* driver/winsys private */
316#define PIPE_RESOURCE_FLAG_ST_PRIV     (1 << 24) /* state-tracker/winsys private */
317
318/* Hint about the expected lifecycle of a resource.
319 */
320#define PIPE_USAGE_DEFAULT        0 /* many uploads, draws intermixed */
321#define PIPE_USAGE_DYNAMIC        1 /* many uploads, draws intermixed */
322#define PIPE_USAGE_STATIC         2 /* same as immutable?? */
323#define PIPE_USAGE_IMMUTABLE      3 /* no change after first upload */
324#define PIPE_USAGE_STREAM         4 /* upload, draw, upload, draw */
325
326
327/* These are intended to be used in calls to is_format_supported, but
328 * no driver actually uses these flags, and only the glx/xlib state
329 * tracker issues them.
330 *
331 * Deprecate?
332 */
333#define PIPE_TEXTURE_GEOM_NON_SQUARE       0x1
334#define PIPE_TEXTURE_GEOM_NON_POWER_OF_TWO 0x2
335
336
337/**
338 * Flush types:
339 */
340#define PIPE_FLUSH_RENDER_CACHE   0x1
341#define PIPE_FLUSH_TEXTURE_CACHE  0x2
342#define PIPE_FLUSH_SWAPBUFFERS    0x4
343#define PIPE_FLUSH_FRAME          0x8 /**< Mark the end of a frame */
344
345
346/**
347 * Shaders
348 */
349#define PIPE_SHADER_VERTEX   0
350#define PIPE_SHADER_FRAGMENT 1
351#define PIPE_SHADER_GEOMETRY 2
352#define PIPE_SHADER_TYPES    3
353
354
355/**
356 * Primitive types:
357 */
358#define PIPE_PRIM_POINTS               0
359#define PIPE_PRIM_LINES                1
360#define PIPE_PRIM_LINE_LOOP            2
361#define PIPE_PRIM_LINE_STRIP           3
362#define PIPE_PRIM_TRIANGLES            4
363#define PIPE_PRIM_TRIANGLE_STRIP       5
364#define PIPE_PRIM_TRIANGLE_FAN         6
365#define PIPE_PRIM_QUADS                7
366#define PIPE_PRIM_QUAD_STRIP           8
367#define PIPE_PRIM_POLYGON              9
368#define PIPE_PRIM_LINES_ADJACENCY          10
369#define PIPE_PRIM_LINE_STRIP_ADJACENCY    11
370#define PIPE_PRIM_TRIANGLES_ADJACENCY      12
371#define PIPE_PRIM_TRIANGLE_STRIP_ADJACENCY 13
372#define PIPE_PRIM_MAX                      14
373
374
375/**
376 * Query object types
377 */
378#define PIPE_QUERY_OCCLUSION_COUNTER     0
379#define PIPE_QUERY_PRIMITIVES_GENERATED  1
380#define PIPE_QUERY_PRIMITIVES_EMITTED    2
381#define PIPE_QUERY_TIME_ELAPSED          3
382#define PIPE_QUERY_TYPES                 4
383
384
385/**
386 * Conditional rendering modes
387 */
388#define PIPE_RENDER_COND_WAIT              0
389#define PIPE_RENDER_COND_NO_WAIT           1
390#define PIPE_RENDER_COND_BY_REGION_WAIT    2
391#define PIPE_RENDER_COND_BY_REGION_NO_WAIT 3
392
393
394/**
395 * Point sprite coord modes
396 */
397#define PIPE_SPRITE_COORD_UPPER_LEFT 0
398#define PIPE_SPRITE_COORD_LOWER_LEFT 1
399
400
401/**
402 * Texture swizzles
403 */
404#define PIPE_SWIZZLE_RED   0
405#define PIPE_SWIZZLE_GREEN 1
406#define PIPE_SWIZZLE_BLUE  2
407#define PIPE_SWIZZLE_ALPHA 3
408#define PIPE_SWIZZLE_ZERO  4
409#define PIPE_SWIZZLE_ONE   5
410
411
412/**
413 * Implementation capabilities/limits which are queried through
414 * pipe_screen::get_param() and pipe_screen::get_paramf().
415 */
416enum pipe_cap {
417   PIPE_CAP_MAX_TEXTURE_IMAGE_UNITS,
418   PIPE_CAP_NPOT_TEXTURES,
419   PIPE_CAP_TWO_SIDED_STENCIL,
420   PIPE_CAP_GLSL,  /* XXX need something better */
421   PIPE_CAP_DUAL_SOURCE_BLEND,
422   PIPE_CAP_ANISOTROPIC_FILTER,
423   PIPE_CAP_POINT_SPRITE,
424   PIPE_CAP_MAX_RENDER_TARGETS,
425   PIPE_CAP_OCCLUSION_QUERY,
426   PIPE_CAP_TIMER_QUERY,
427   PIPE_CAP_TEXTURE_SHADOW_MAP,
428   PIPE_CAP_TEXTURE_SWIZZLE,
429   PIPE_CAP_MAX_TEXTURE_2D_LEVELS,
430   PIPE_CAP_MAX_TEXTURE_3D_LEVELS,
431   PIPE_CAP_MAX_TEXTURE_CUBE_LEVELS,
432   PIPE_CAP_MAX_LINE_WIDTH,
433   PIPE_CAP_MAX_LINE_WIDTH_AA,
434   PIPE_CAP_MAX_POINT_WIDTH,
435   PIPE_CAP_MAX_POINT_WIDTH_AA,
436   PIPE_CAP_MAX_TEXTURE_ANISOTROPY,
437   PIPE_CAP_MAX_TEXTURE_LOD_BIAS,
438   PIPE_CAP_GUARD_BAND_LEFT,  /*< float */
439   PIPE_CAP_GUARD_BAND_TOP,  /*< float */
440   PIPE_CAP_GUARD_BAND_RIGHT,  /*< float */
441   PIPE_CAP_GUARD_BAND_BOTTOM,  /*< float */
442   PIPE_CAP_TEXTURE_MIRROR_CLAMP,
443   PIPE_CAP_TEXTURE_MIRROR_REPEAT,
444   PIPE_CAP_MAX_VERTEX_TEXTURE_UNITS,
445   PIPE_CAP_TGSI_CONT_SUPPORTED,
446   PIPE_CAP_BLEND_EQUATION_SEPARATE,
447   PIPE_CAP_SM3,  /*< Shader Model, supported */
448   PIPE_CAP_MAX_PREDICATE_REGISTERS,
449   /** Maximum texture image units accessible from vertex and fragment shaders
450    * combined */
451   PIPE_CAP_MAX_COMBINED_SAMPLERS,
452   PIPE_CAP_MAX_CONST_BUFFERS,
453   PIPE_CAP_MAX_CONST_BUFFER_SIZE,  /*< In bytes */
454   /** blend enables and write masks per rendertarget */
455   PIPE_CAP_INDEP_BLEND_ENABLE,
456   /** different blend funcs per rendertarget */
457   PIPE_CAP_INDEP_BLEND_FUNC,
458   PIPE_CAP_DEPTHSTENCIL_CLEAR_SEPARATE,
459   PIPE_CAP_TGSI_FS_COORD_ORIGIN_UPPER_LEFT,
460   PIPE_CAP_TGSI_FS_COORD_ORIGIN_LOWER_LEFT,
461   PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_HALF_INTEGER,
462   PIPE_CAP_TGSI_FS_COORD_PIXEL_CENTER_INTEGER,
463
464   /*
465    * Shader limits.
466    */
467   PIPE_CAP_MAX_FS_INSTRUCTIONS,
468   PIPE_CAP_MAX_FS_ALU_INSTRUCTIONS,
469   PIPE_CAP_MAX_FS_TEX_INSTRUCTIONS,
470   PIPE_CAP_MAX_FS_TEX_INDIRECTIONS,
471   PIPE_CAP_MAX_FS_CONTROL_FLOW_DEPTH,
472   PIPE_CAP_MAX_FS_INPUTS,
473   PIPE_CAP_MAX_FS_CONSTS,
474   PIPE_CAP_MAX_FS_TEMPS,
475   PIPE_CAP_MAX_FS_ADDRS,
476   PIPE_CAP_MAX_FS_PREDS,
477   PIPE_CAP_MAX_VS_INSTRUCTIONS,
478   PIPE_CAP_MAX_VS_ALU_INSTRUCTIONS,
479   PIPE_CAP_MAX_VS_TEX_INSTRUCTIONS,
480   PIPE_CAP_MAX_VS_TEX_INDIRECTIONS,
481   PIPE_CAP_MAX_VS_CONTROL_FLOW_DEPTH,
482   PIPE_CAP_MAX_VS_INPUTS,
483   PIPE_CAP_MAX_VS_CONSTS,
484   PIPE_CAP_MAX_VS_TEMPS,
485   PIPE_CAP_MAX_VS_ADDRS,
486   PIPE_CAP_MAX_VS_PREDS
487};
488
489
490/**
491 * Referenced query flags.
492 */
493
494#define PIPE_UNREFERENCED         0
495#define PIPE_REFERENCED_FOR_READ  (1 << 0)
496#define PIPE_REFERENCED_FOR_WRITE (1 << 1)
497
498
499#ifdef __cplusplus
500}
501#endif
502
503#endif
504