summaryrefslogtreecommitdiff
path: root/src/mesa/pipe/p_state.h
blob: da62aa1b274e4123b4c06463e217fa46c302fd31 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
/**************************************************************************
 * 
 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
 * All Rights Reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 **************************************************************************/


/**
 * Abstract graphics pipe state objects.
 *
 * Basic notes:
 *   1. Want compact representations, so we use bitfields.
 *   2. Put bitfields before other (GLfloat) fields.
 */


#ifndef PIPE_STATE_H
#define PIPE_STATE_H

#include "p_compiler.h"

#include "x86/rtasm/x86sse.h"

/**
 * Implementation limits
 */
#define PIPE_MAX_SAMPLERS     8
#define PIPE_MAX_CLIP_PLANES  6
#define PIPE_MAX_CONSTANT    32
#define PIPE_ATTRIB_MAX      32
#define PIPE_MAX_COLOR_BUFS   8
#define PIPE_MAX_TEXTURE_LEVELS  16
#define PIPE_MAX_FEEDBACK_ATTRIBS 16
#define PIPE_MAX_SHADER_INPUTS 16
#define PIPE_MAX_SHADER_OUTPUTS 16


/* fwd decl */
struct pipe_surface;

/* opaque type */
struct pipe_buffer_handle;


/***
 *** State objects
 ***/


/**
 * Primitive (point/line/tri) rasterization info
 */
struct pipe_rasterizer_state
{
   unsigned flatshade:1;
   unsigned light_twoside:1;
   unsigned front_winding:2;  /**< PIPE_WINDING_x */
   unsigned cull_mode:2;      /**< PIPE_WINDING_x */
   unsigned fill_cw:2;        /**< PIPE_POLYGON_MODE_x */
   unsigned fill_ccw:2;       /**< PIPE_POLYGON_MODE_x */
   unsigned offset_cw:1;
   unsigned offset_ccw:1;
   unsigned scissor:1;
   unsigned poly_smooth:1;
   unsigned poly_stipple_enable:1;
   unsigned point_smooth:1;
   unsigned multisample:1;         /* XXX maybe more ms state in future */
   unsigned line_smooth:1;
   unsigned line_stipple_enable:1;
   unsigned line_stipple_factor:8;  /**< [1..256] actually */
   unsigned line_stipple_pattern:16;

   float line_width;
   float point_size;           /**< used when no per-vertex size */
   float offset_units;
   float offset_scale;
};


/**
 * Post-transform vertex feeback
 */
struct pipe_feedback_state {
   uint enabled:1;        /**< enable feedback? */
   uint discard:1;        /**< discard primitives? */
   uint interleaved:1;    /**< interleaved output? */
   uint num_attribs;
   uint attrib[PIPE_MAX_FEEDBACK_ATTRIBS];
   uint size[PIPE_MAX_FEEDBACK_ATTRIBS];
};


struct pipe_poly_stipple {
   unsigned stipple[32];
};


struct pipe_viewport_state {
   float scale[4];
   float translate[4];
};

struct pipe_scissor_state {
   unsigned minx:16;
   unsigned miny:16;
   unsigned maxx:16;
   unsigned maxy:16;
};

struct pipe_clip_state {
   float ucp[PIPE_MAX_CLIP_PLANES][4];
   unsigned nr;
};


/**
 * Constants for vertex/fragment shaders
 */
struct pipe_constant_buffer {
   struct pipe_buffer_handle *buffer;
   unsigned size;    /** in bytes */
};


struct pipe_shader_state {
   const struct tgsi_token *tokens;
#if defined(__i386__) || defined(__386__)
   struct x86_function sse2_program;
#endif
   void *executable;

   ubyte num_inputs;
   ubyte num_outputs;
   ubyte input_semantic_name[PIPE_MAX_SHADER_INPUTS]; /**< TGSI_SEMANTIC_x */
   ubyte input_semantic_index[PIPE_MAX_SHADER_INPUTS];
   ubyte output_semantic_name[PIPE_MAX_SHADER_OUTPUTS]; /**< TGSI_SEMANTIC_x */
   ubyte output_semantic_index[PIPE_MAX_SHADER_OUTPUTS];
};

struct pipe_depth_stencil_state
{
   struct {
      unsigned enabled:1;   /**< depth test enabled? */
      unsigned writemask:1; /**< allow depth buffer writes? */
      unsigned func:3;      /**< depth test func (PIPE_FUNC_x) */
      unsigned occlusion_count:1; /**< XXX move this elsewhere? */
      float clear;      /**< Clear value in [0,1] (XXX correct place?) */
   } depth;
   struct {
      unsigned front_enabled:1;
      unsigned front_func:3;     /**< PIPE_FUNC_x */
      unsigned front_fail_op:3;  /**< PIPE_STENCIL_OP_x */
      unsigned front_zpass_op:3; /**< PIPE_STENCIL_OP_x */
      unsigned front_zfail_op:3; /**< PIPE_STENCIL_OP_x */
      unsigned back_enabled:1;
      unsigned back_func:3;      /**< PIPE_FUNC_x */
      unsigned back_fail_op:3;   /**< PIPE_STENCIL_OP_x */
      unsigned back_zpass_op:3;  /**< PIPE_STENCIL_OP_x */
      unsigned back_zfail_op:3;  /**< PIPE_STENCIL_OP_x */
      ubyte ref_value[2];    /**< [0] = front, [1] = back */
      ubyte value_mask[2];
      ubyte write_mask[2];
      ubyte clear_value;
   } stencil;
};

struct pipe_alpha_test_state {
   unsigned enabled:1;
   unsigned func:3;    /**< PIPE_FUNC_x */
   float ref;      /**< reference value */
};

struct pipe_blend_state {
   unsigned blend_enable:1;

   unsigned rgb_func:3;          /**< PIPE_BLEND_x */
   unsigned rgb_src_factor:5;    /**< PIPE_BLENDFACTOR_x */
   unsigned rgb_dst_factor:5;    /**< PIPE_BLENDFACTOR_x */

   unsigned alpha_func:3;        /**< PIPE_BLEND_x */
   unsigned alpha_src_factor:5;  /**< PIPE_BLENDFACTOR_x */
   unsigned alpha_dst_factor:5;  /**< PIPE_BLENDFACTOR_x */

   unsigned logicop_enable:1;
   unsigned logicop_func:4;      /**< PIPE_LOGICOP_x */

   unsigned colormask:4;         /**< bitmask of PIPE_MASK_R/G/B/A */
   unsigned dither:1;
};

struct pipe_blend_color {
   float color[4];
};

struct pipe_clear_color_state
{
   float color[4];
};

struct pipe_framebuffer_state
{
   /** multiple colorbuffers for multiple render targets */
   unsigned num_cbufs;
   struct pipe_surface *cbufs[PIPE_MAX_COLOR_BUFS];

   struct pipe_surface *zbuf;      /**< Z buffer */
   struct pipe_surface *sbuf;      /**< Stencil buffer */
};


/**
 * Texture sampler state.
 */
struct pipe_sampler_state
{
   unsigned wrap_s:3;        /**< PIPE_TEX_WRAP_x */
   unsigned wrap_t:3;        /**< PIPE_TEX_WRAP_x */
   unsigned wrap_r:3;        /**< PIPE_TEX_WRAP_x */
   unsigned min_img_filter:2;    /**< PIPE_TEX_FILTER_x */
   unsigned min_mip_filter:2;    /**< PIPE_TEX_MIPFILTER_x */
   unsigned mag_img_filter:2;    /**< PIPE_TEX_FILTER_x */
   unsigned compare:1;       /**< shadow/depth compare enabled? */
   unsigned compare_mode:1;  /**< PIPE_TEX_COMPARE_x */
   unsigned compare_func:3;  /**< PIPE_FUNC_x */
   unsigned normalized_coords:1;  /**< Are coords normalized to [0,1]? */
   float shadow_ambient; /**< shadow test fail color/intensity */
   float min_lod;
   float max_lod;
   float lod_bias;
#if 0 /* need these? */
   int BaseLevel;     /**< min mipmap level, OpenGL 1.2 */
   int MaxLevel;      /**< max mipmap level, OpenGL 1.2 */
#endif
   float border_color[4];
   float max_anisotropy;
};


/***
 *** Resource Objects
 ***/

struct pipe_region
{
   struct pipe_buffer_handle *buffer; /**< driver private buffer handle */

   unsigned refcount; /**< Reference count for region */
   unsigned cpp;      /**< bytes per pixel */
   unsigned pitch;    /**< in pixels */
   unsigned height;   /**< in pixels */
   ubyte *map;    /**< only non-NULL when region is actually mapped */
   unsigned map_refcount;  /**< Reference count for mapping */
};


/**
 * 2D surface.  This is basically a view into a pipe_region (memory buffer).
 * May be a renderbuffer, texture mipmap level, etc.
 */
struct pipe_surface
{
   struct pipe_region *region;
   unsigned format;              /**< PIPE_FORMAT_x */
   unsigned width, height;
   unsigned offset;              /**< offset from start of region, in bytes */
   unsigned refcount;

   /** get block/tile of pixels from surface */
   void (*get_tile)(struct pipe_surface *ps,
                    unsigned x, unsigned y, unsigned w, unsigned h, float *p);

   /** put block/tile of pixels into surface */
   void (*put_tile)(struct pipe_surface *ps,
                    unsigned x, unsigned y, unsigned w, unsigned h, const float *p);
};


/**
 * Describes the location of each texture image within a texture region.
 */
struct pipe_mipmap_level
{
   unsigned level_offset;
   unsigned width;
   unsigned height;
   unsigned depth;
   unsigned nr_images;

   /* Explicitly store the offset of each image for each cube face or
    * depth value.  Pretty much have to accept that hardware formats
    * are going to be so diverse that there is no unified way to
    * compute the offsets of depth/cube images within a mipmap level,
    * so have to store them as a lookup table:
    */
   unsigned *image_offset;   /**< array [depth] of offsets */
};

struct pipe_mipmap_tree
{
   /* Effectively the key:
    */
   unsigned target;            /* XXX convert to PIPE_TEXTURE_x */
   unsigned internal_format;   /* XXX convert to PIPE_FORMAT_x */

   unsigned format;            /**< PIPE_FORMAT_x */
   unsigned first_level;
   unsigned last_level;

   unsigned width0, height0, depth0; /**< Level zero image dimensions */
   unsigned cpp;

   unsigned compressed:1;

   /* Derived from the above:
    */
   unsigned pitch;
   unsigned depth_pitch;          /* per-image on i945? */
   unsigned total_height;

   /* Includes image offset tables:
    */
   struct pipe_mipmap_level level[PIPE_MAX_TEXTURE_LEVELS];

   /* The data is held here:
    */
   struct pipe_region *region;

   /* These are also refcounted:
    */
   unsigned refcount;
};


/**
 * A vertex buffer.  Typically, all the vertex data/attributes for
 * drawing something will be in one buffer.  But it's also possible, for
 * example, to put colors in one buffer and texcoords in another.
 */
struct pipe_vertex_buffer
{
   unsigned pitch:11;    /**< stride to same attrib in next vertex, in bytes */
   unsigned max_index;   /**< number of vertices in this buffer */
   unsigned buffer_offset;  /**< offset to start of data in buffer, in bytes */
   struct pipe_buffer_handle *buffer;  /**< the actual buffer */
};


/**
 * Information to describe a vertex attribute (position, color, etc)
 */
struct pipe_vertex_element
{
   /** Offset of this attribute, in bytes, from the start of the vertex */
   unsigned src_offset:11;

   /** Which vertex_buffer (as given to pipe->set_vertex_buffer()) does
    * this attribute live in?
    */
   unsigned vertex_buffer_index:5;

   unsigned dst_offset:8; 
   unsigned src_format:8; 	   /**< PIPE_FORMAT_* */
};


/**
 * Vertex feedback buffer
 */
struct pipe_feedback_buffer {
   struct pipe_buffer_handle *buffer;
   unsigned size;
   unsigned start_offset;
};


/**
 * Hardware queries (occlusion, transform feedback, timing, etc)
 */
struct pipe_query_object {
   uint type:3;   /**< PIPE_QUERY_x */
   uint ready:1;  /**< is result ready? */
   uint64 count;
};


#endif