gallium: rename pipe_buffer_handle to pipe_buffer, rework pipebuffer/ code
[mesa.git] / src / mesa / 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 #define PIPE_BLENDFACTOR_ONE 0x1
34 #define PIPE_BLENDFACTOR_SRC_COLOR 0x2
35 #define PIPE_BLENDFACTOR_SRC_ALPHA 0x3
36 #define PIPE_BLENDFACTOR_DST_ALPHA 0x4
37 #define PIPE_BLENDFACTOR_DST_COLOR 0x5
38 #define PIPE_BLENDFACTOR_SRC_ALPHA_SATURATE 0x6
39 #define PIPE_BLENDFACTOR_CONST_COLOR 0x7
40 #define PIPE_BLENDFACTOR_CONST_ALPHA 0x8
41 #define PIPE_BLENDFACTOR_SRC1_COLOR 0x9
42 #define PIPE_BLENDFACTOR_SRC1_ALPHA 0x0A
43 #define PIPE_BLENDFACTOR_ZERO 0x11
44 #define PIPE_BLENDFACTOR_INV_SRC_COLOR 0x12
45 #define PIPE_BLENDFACTOR_INV_SRC_ALPHA 0x13
46 #define PIPE_BLENDFACTOR_INV_DST_ALPHA 0x14
47 #define PIPE_BLENDFACTOR_INV_DST_COLOR 0x15
48 #define PIPE_BLENDFACTOR_INV_CONST_COLOR 0x17
49 #define PIPE_BLENDFACTOR_INV_CONST_ALPHA 0x18
50 #define PIPE_BLENDFACTOR_INV_SRC1_COLOR 0x19
51 #define PIPE_BLENDFACTOR_INV_SRC1_ALPHA 0x1A
52
53 #define PIPE_BLEND_ADD 0
54 #define PIPE_BLEND_SUBTRACT 1
55 #define PIPE_BLEND_REVERSE_SUBTRACT 2
56 #define PIPE_BLEND_MIN 3
57 #define PIPE_BLEND_MAX 4
58
59 #define PIPE_LOGICOP_CLEAR 0
60 #define PIPE_LOGICOP_NOR 1
61 #define PIPE_LOGICOP_AND_INVERTED 2
62 #define PIPE_LOGICOP_COPY_INVERTED 3
63 #define PIPE_LOGICOP_AND_REVERSE 4
64 #define PIPE_LOGICOP_INVERT 5
65 #define PIPE_LOGICOP_XOR 6
66 #define PIPE_LOGICOP_NAND 7
67 #define PIPE_LOGICOP_AND 8
68 #define PIPE_LOGICOP_EQUIV 9
69 #define PIPE_LOGICOP_NOOP 10
70 #define PIPE_LOGICOP_OR_INVERTED 11
71 #define PIPE_LOGICOP_COPY 12
72 #define PIPE_LOGICOP_OR_REVERSE 13
73 #define PIPE_LOGICOP_OR 14
74 #define PIPE_LOGICOP_SET 15
75
76 #define PIPE_MASK_R 0x1
77 #define PIPE_MASK_G 0x2
78 #define PIPE_MASK_B 0x4
79 #define PIPE_MASK_A 0x8
80 #define PIPE_MASK_RGBA 0xf
81
82
83 /**
84 * Inequality functions. Used for depth test, stencil compare, alpha
85 * test, shadow compare, etc.
86 */
87 #define PIPE_FUNC_NEVER 0
88 #define PIPE_FUNC_LESS 1
89 #define PIPE_FUNC_EQUAL 2
90 #define PIPE_FUNC_LEQUAL 3
91 #define PIPE_FUNC_GREATER 4
92 #define PIPE_FUNC_NOTEQUAL 5
93 #define PIPE_FUNC_GEQUAL 6
94 #define PIPE_FUNC_ALWAYS 7
95
96 /** Polygon fill mode */
97 #define PIPE_POLYGON_MODE_FILL 0
98 #define PIPE_POLYGON_MODE_LINE 1
99 #define PIPE_POLYGON_MODE_POINT 2
100
101 /** Polygon front/back window, also for culling */
102 #define PIPE_WINDING_NONE 0
103 #define PIPE_WINDING_CW 1
104 #define PIPE_WINDING_CCW 2
105 #define PIPE_WINDING_BOTH (PIPE_WINDING_CW | PIPE_WINDING_CCW)
106
107 /** Stencil ops */
108 #define PIPE_STENCIL_OP_KEEP 0
109 #define PIPE_STENCIL_OP_ZERO 1
110 #define PIPE_STENCIL_OP_REPLACE 2
111 #define PIPE_STENCIL_OP_INCR 3
112 #define PIPE_STENCIL_OP_DECR 4
113 #define PIPE_STENCIL_OP_INCR_WRAP 5
114 #define PIPE_STENCIL_OP_DECR_WRAP 6
115 #define PIPE_STENCIL_OP_INVERT 7
116
117 /** Texture types */
118 enum pipe_texture_target {
119 PIPE_TEXTURE_1D = 0,
120 PIPE_TEXTURE_2D = 1,
121 PIPE_TEXTURE_3D = 2,
122 PIPE_TEXTURE_CUBE = 3
123 };
124
125 #define PIPE_TEX_FACE_POS_X 0
126 #define PIPE_TEX_FACE_NEG_X 1
127 #define PIPE_TEX_FACE_POS_Y 2
128 #define PIPE_TEX_FACE_NEG_Y 3
129 #define PIPE_TEX_FACE_POS_Z 4
130 #define PIPE_TEX_FACE_NEG_Z 5
131
132 #define PIPE_TEX_WRAP_REPEAT 0
133 #define PIPE_TEX_WRAP_CLAMP 1
134 #define PIPE_TEX_WRAP_CLAMP_TO_EDGE 2
135 #define PIPE_TEX_WRAP_CLAMP_TO_BORDER 3
136 #define PIPE_TEX_WRAP_MIRROR_REPEAT 4
137 #define PIPE_TEX_WRAP_MIRROR_CLAMP 5
138 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_EDGE 6
139 #define PIPE_TEX_WRAP_MIRROR_CLAMP_TO_BORDER 7
140
141 /* Between mipmaps, ie mipfilter
142 */
143 #define PIPE_TEX_MIPFILTER_NEAREST 0
144 #define PIPE_TEX_MIPFILTER_LINEAR 1
145 #define PIPE_TEX_MIPFILTER_NONE 2
146
147 /* Within a mipmap, ie min/mag filter
148 */
149 #define PIPE_TEX_FILTER_NEAREST 0
150 #define PIPE_TEX_FILTER_LINEAR 1
151 //#define PIPE_TEX_FILTER_ANISO 2
152
153
154 #define PIPE_TEX_COMPARE_NONE 0
155 #define PIPE_TEX_COMPARE_R_TO_TEXTURE 1
156
157 #define PIPE_TEX_FACE_POS_X 0
158 #define PIPE_TEX_FACE_NEG_X 1
159 #define PIPE_TEX_FACE_POS_Y 2
160 #define PIPE_TEX_FACE_NEG_Y 3
161 #define PIPE_TEX_FACE_POS_Z 4
162 #define PIPE_TEX_FACE_NEG_Z 5
163 #define PIPE_TEX_FACE_MAX 6
164
165 /**
166 * Surfaces, textures, etc. (others may be added)
167 */
168 #define PIPE_TEXTURE 1
169 #define PIPE_SURFACE 2 /**< user-created surfaces */
170
171
172 /**
173 * Surface status
174 */
175 #define PIPE_SURFACE_STATUS_UNDEFINED 0
176 #define PIPE_SURFACE_STATUS_DEFINED 1
177 #define PIPE_SURFACE_STATUS_CLEAR 2
178
179
180 /**
181 * Buffer usage flags
182 */
183 #define PIPE_BUFFER_USAGE_CPU_READ (1 << 0)
184 #define PIPE_BUFFER_USAGE_CPU_WRITE (1 << 1)
185 #define PIPE_BUFFER_USAGE_GPU_READ (1 << 2)
186 #define PIPE_BUFFER_USAGE_GPU_WRITE (1 << 3)
187 #define PIPE_BUFFER_USAGE_PIXEL (1 << 4)
188 #define PIPE_BUFFER_USAGE_VERTEX (1 << 5)
189 #define PIPE_BUFFER_USAGE_INDEX (1 << 6)
190 #define PIPE_BUFFER_USAGE_CONSTANT (1 << 7)
191 /** Pipe driver custam usage flags should be greater or equal to this value */
192 #define PIPE_BUFFER_USAGE_CUSTOM (1 << 16)
193
194
195 /**
196 * Flush types:
197 */
198 #define PIPE_FLUSH_RENDER_CACHE 0x1
199 #define PIPE_FLUSH_TEXTURE_CACHE 0x2
200 #define PIPE_FLUSH_WAIT 0x4
201
202
203 /**
204 * Shaders
205 */
206 #define PIPE_SHADER_VERTEX 0
207 #define PIPE_SHADER_FRAGMENT 1
208 #define PIPE_SHADER_TYPES 2
209
210
211 /**
212 * Primitive types:
213 */
214 #define PIPE_PRIM_POINTS 0
215 #define PIPE_PRIM_LINES 1
216 #define PIPE_PRIM_LINE_LOOP 2
217 #define PIPE_PRIM_LINE_STRIP 3
218 #define PIPE_PRIM_TRIANGLES 4
219 #define PIPE_PRIM_TRIANGLE_STRIP 5
220 #define PIPE_PRIM_TRIANGLE_FAN 6
221 #define PIPE_PRIM_QUADS 7
222 #define PIPE_PRIM_QUAD_STRIP 8
223 #define PIPE_PRIM_POLYGON 9
224
225
226 /**
227 * Query object types
228 */
229 #define PIPE_QUERY_OCCLUSION_COUNTER 0
230 #define PIPE_QUERY_PRIMITIVES_GENERATED 1
231 #define PIPE_QUERY_PRIMITIVES_EMITTED 2
232 #define PIPE_QUERY_TYPES 3
233
234
235 /**
236 * Point sprite coord modes
237 */
238 #define PIPE_SPRITE_COORD_NONE 0
239 #define PIPE_SPRITE_COORD_UPPER_LEFT 1
240 #define PIPE_SPRITE_COORD_LOWER_LEFT 2
241
242
243 /**
244 * Implementation capabilities/limits
245 * Passed to pipe->get_param()
246 * XXX this will need some fine tuning...
247 */
248 #define PIPE_CAP_MAX_TEXTURE_IMAGE_UNITS 1
249 #define PIPE_CAP_NPOT_TEXTURES 2
250 #define PIPE_CAP_TWO_SIDED_STENCIL 3
251 #define PIPE_CAP_GLSL 4 /* XXX need something better */
252 #define PIPE_CAP_S3TC 5
253 #define PIPE_CAP_ANISOTROPIC_FILTER 6
254 #define PIPE_CAP_POINT_SPRITE 7
255 #define PIPE_CAP_MAX_RENDER_TARGETS 8
256 #define PIPE_CAP_OCCLUSION_QUERY 9
257 #define PIPE_CAP_TEXTURE_SHADOW_MAP 10
258 #define PIPE_CAP_MAX_TEXTURE_2D_LEVELS 11
259 #define PIPE_CAP_MAX_TEXTURE_3D_LEVELS 12
260 #define PIPE_CAP_MAX_TEXTURE_CUBE_LEVELS 13
261 #define PIPE_CAP_MAX_LINE_WIDTH 14
262 #define PIPE_CAP_MAX_LINE_WIDTH_AA 15
263 #define PIPE_CAP_MAX_POINT_WIDTH 16
264 #define PIPE_CAP_MAX_POINT_WIDTH_AA 17
265 #define PIPE_CAP_MAX_TEXTURE_ANISOTROPY 18
266 #define PIPE_CAP_MAX_TEXTURE_LOD_BIAS 19
267
268
269 #endif