Fix assert in some cases when using DataTransfer modifier for custom normals.
[blender.git] / source / blender / gpu / GPU_vertex_format.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2016 by Mike Erwin.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup gpu
22  *
23  * GPU vertex format
24  */
25
26 #ifndef __GPU_VERTEX_FORMAT_H__
27 #define __GPU_VERTEX_FORMAT_H__
28
29 #include "GPU_common.h"
30 #include "BLI_compiler_compat.h"
31 #include "BLI_assert.h"
32
33 #define GPU_VERT_ATTR_MAX_LEN 16
34 #define GPU_VERT_ATTR_MAX_NAMES 5
35 #define GPU_VERT_ATTR_NAME_AVERAGE_LEN 11
36 #define GPU_VERT_ATTR_NAMES_BUF_LEN ((GPU_VERT_ATTR_NAME_AVERAGE_LEN + 1) * GPU_VERT_ATTR_MAX_LEN)
37
38 typedef enum {
39   GPU_COMP_I8,
40   GPU_COMP_U8,
41   GPU_COMP_I16,
42   GPU_COMP_U16,
43   GPU_COMP_I32,
44   GPU_COMP_U32,
45
46   GPU_COMP_F32,
47
48   GPU_COMP_I10,
49 } GPUVertCompType;
50
51 typedef enum {
52   GPU_FETCH_FLOAT,
53   GPU_FETCH_INT,
54   GPU_FETCH_INT_TO_FLOAT_UNIT, /* 127 (ubyte) -> 0.5 (and so on for other int types) */
55   GPU_FETCH_INT_TO_FLOAT,      /* 127 (any int type) -> 127.0 */
56 } GPUVertFetchMode;
57
58 typedef struct GPUVertAttr {
59   uint fetch_mode : 2;
60   uint comp_type : 3;
61   /* 1 to 4 or 8 or 12 or 16 */
62   uint comp_len : 5;
63   /* size in bytes, 1 to 64 */
64   uint sz : 7;
65   /* from beginning of vertex, in bytes */
66   uint offset : 11;
67   /* up to GPU_VERT_ATTR_MAX_NAMES */
68   uint name_len : 3;
69   uint gl_comp_type;
70   /* -- 8 Bytes -- */
71   uchar names[GPU_VERT_ATTR_MAX_NAMES];
72 } GPUVertAttr;
73
74 BLI_STATIC_ASSERT(GPU_VERT_ATTR_NAMES_BUF_LEN <= 256,
75                   "We use uchar as index inside the name buffer "
76                   "so GPU_VERT_ATTR_NAMES_BUF_LEN needs to be be "
77                   "smaller than GPUVertFormat->name_offset and "
78                   "GPUVertAttr->names maximum value");
79
80 typedef struct GPUVertFormat {
81   /** 0 to 16 (GPU_VERT_ATTR_MAX_LEN). */
82   uint attr_len : 5;
83   /** Total count of active vertex attribute. */
84   uint name_len : 5;
85   /** Stride in bytes, 1 to 1024. */
86   uint stride : 11;
87   /** Has the format been packed. */
88   uint packed : 1;
89   /** Current offset in names[]. */
90   uint name_offset : 8;
91
92   GPUVertAttr attrs[GPU_VERT_ATTR_MAX_LEN];
93   char names[GPU_VERT_ATTR_NAMES_BUF_LEN];
94 } GPUVertFormat;
95
96 struct GPUShaderInterface;
97
98 void GPU_vertformat_clear(GPUVertFormat *);
99 void GPU_vertformat_copy(GPUVertFormat *dest, const GPUVertFormat *src);
100 void GPU_vertformat_from_interface(GPUVertFormat *format,
101                                    const struct GPUShaderInterface *shaderface);
102
103 uint GPU_vertformat_attr_add(
104     GPUVertFormat *, const char *name, GPUVertCompType, uint comp_len, GPUVertFetchMode);
105 void GPU_vertformat_alias_add(GPUVertFormat *, const char *alias);
106
107 int GPU_vertformat_attr_id_get(const GPUVertFormat *, const char *name);
108
109 BLI_INLINE const char *GPU_vertformat_attr_name_get(const GPUVertFormat *format,
110                                                     const GPUVertAttr *attr,
111                                                     uint n_idx)
112 {
113   return format->names + attr->names[n_idx];
114 }
115
116 /* format conversion */
117
118 typedef struct GPUPackedNormal {
119   int x : 10;
120   int y : 10;
121   int z : 10;
122   int w : 2; /* 0 by default, can manually set to { -2, -1, 0, 1 } */
123 } GPUPackedNormal;
124
125 GPUPackedNormal GPU_normal_convert_i10_v3(const float data[3]);
126 GPUPackedNormal GPU_normal_convert_i10_s3(const short data[3]);
127
128 #endif /* __GPU_VERTEX_FORMAT_H__ */