draw_vertex.h revision cdc920a0 
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/**
29 * Post-transform vertex format info.  The vertex_info struct is used by
30 * the draw_vbuf code to emit hardware-specific vertex layouts into hw
31 * vertex buffers.
32 *
33 * Author:
34 *    Brian Paul
35 */
36
37
38#ifndef DRAW_VERTEX_H
39#define DRAW_VERTEX_H
40
41
42#include "pipe/p_compiler.h"
43#include "pipe/p_state.h"
44#include "util/u_debug.h"
45
46
47/**
48 * Vertex attribute emit modes
49 */
50enum attrib_emit {
51   EMIT_OMIT,      /**< don't emit the attribute */
52   EMIT_1F,
53   EMIT_1F_PSIZE,  /**< insert constant point size */
54   EMIT_2F,
55   EMIT_3F,
56   EMIT_4F,
57   EMIT_4UB  /**< XXX may need variations for RGBA vs BGRA, etc */
58};
59
60
61/**
62 * Attribute interpolation mode
63 */
64enum interp_mode {
65   INTERP_NONE,      /**< never interpolate vertex header info */
66   INTERP_POS,       /**< special case for frag position */
67   INTERP_CONSTANT,
68   INTERP_LINEAR,
69   INTERP_PERSPECTIVE
70};
71
72
73/**
74 * Information about hardware/rasterization vertex layout.
75 */
76struct vertex_info
77{
78   uint num_attribs;
79   uint hwfmt[4];      /**< hardware format info for this format */
80   uint size;          /**< total vertex size in dwords */
81
82   /* Keep this small and at the end of the struct to allow quick
83    * memcmp() comparisons.
84    */
85   struct {
86      unsigned interp_mode:4;      /**< INTERP_x */
87      unsigned emit:4;             /**< EMIT_x */
88      unsigned src_index:8;          /**< map to post-xform attribs */
89   } attrib[PIPE_MAX_SHADER_INPUTS];
90};
91
92static INLINE size_t
93draw_vinfo_size( const struct vertex_info *a )
94{
95   return offsetof(const struct vertex_info, attrib[a->num_attribs]);
96}
97
98static INLINE int
99draw_vinfo_compare( const struct vertex_info *a,
100                    const struct vertex_info *b )
101{
102   size_t sizea = draw_vinfo_size( a );
103   return memcmp( a, b, sizea );
104}
105
106static INLINE void
107draw_vinfo_copy( struct vertex_info *dst,
108                 const struct vertex_info *src )
109{
110   size_t size = draw_vinfo_size( src );
111   memcpy( dst, src, size );
112}
113
114
115
116/**
117 * Add another attribute to the given vertex_info object.
118 * \param src_index  indicates which post-transformed vertex attrib slot
119 *                   corresponds to this attribute.
120 * \return slot in which the attribute was added
121 */
122static INLINE uint
123draw_emit_vertex_attr(struct vertex_info *vinfo,
124                      enum attrib_emit emit,
125                      enum interp_mode interp, /* only used by softpipe??? */
126                      uint src_index)
127{
128   const uint n = vinfo->num_attribs;
129   assert(n < PIPE_MAX_SHADER_INPUTS);
130   vinfo->attrib[n].emit = emit;
131   vinfo->attrib[n].interp_mode = interp;
132   vinfo->attrib[n].src_index = src_index;
133   vinfo->num_attribs++;
134   return n;
135}
136
137
138extern void draw_compute_vertex_size(struct vertex_info *vinfo);
139
140void draw_dump_emitted_vertex(const struct vertex_info *vinfo,
141                              const uint8_t *data);
142
143
144static INLINE unsigned draw_translate_vinfo_format(unsigned format )
145{
146   switch (format) {
147   case EMIT_1F:
148   case EMIT_1F_PSIZE:
149      return PIPE_FORMAT_R32_FLOAT;
150   case EMIT_2F:
151      return PIPE_FORMAT_R32G32_FLOAT;
152   case EMIT_3F:
153      return PIPE_FORMAT_R32G32B32_FLOAT;
154   case EMIT_4F:
155      return PIPE_FORMAT_R32G32B32A32_FLOAT;
156   case EMIT_4UB:
157      return PIPE_FORMAT_R8G8B8A8_UNORM;
158   default:
159      return PIPE_FORMAT_NONE;
160   }
161}
162
163
164#endif /* DRAW_VERTEX_H */
165