Cleanup: comments (long lines) in gpu
[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
31 #define GPU_VERT_ATTR_MAX_LEN 16
32 #define GPU_VERT_ATTR_MAX_NAMES 4
33 #define GPU_VERT_ATTR_NAME_AVERAGE_LEN 11
34 #define GPU_VERT_ATTR_NAMES_BUF_LEN ((GPU_VERT_ATTR_NAME_AVERAGE_LEN + 1) * GPU_VERT_ATTR_MAX_LEN)
35
36 typedef enum {
37   GPU_COMP_I8,
38   GPU_COMP_U8,
39   GPU_COMP_I16,
40   GPU_COMP_U16,
41   GPU_COMP_I32,
42   GPU_COMP_U32,
43
44   GPU_COMP_F32,
45
46   GPU_COMP_I10,
47 } GPUVertCompType;
48
49 typedef enum {
50   GPU_FETCH_FLOAT,
51   GPU_FETCH_INT,
52   GPU_FETCH_INT_TO_FLOAT_UNIT, /* 127 (ubyte) -> 0.5 (and so on for other int types) */
53   GPU_FETCH_INT_TO_FLOAT,      /* 127 (any int type) -> 127.0 */
54 } GPUVertFetchMode;
55
56 typedef struct GPUVertAttr {
57   GPUVertFetchMode fetch_mode;
58   GPUVertCompType comp_type;
59   uint gl_comp_type;
60   uint comp_len; /* 1 to 4 or 8 or 12 or 16 */
61   uint sz;       /* size in bytes, 1 to 64 */
62   uint offset;   /* from beginning of vertex, in bytes */
63   uint name_len; /* up to GPU_VERT_ATTR_MAX_NAMES */
64   const char *name[GPU_VERT_ATTR_MAX_NAMES];
65 } GPUVertAttr;
66
67 typedef struct GPUVertFormat {
68   /** 0 to 16 (GPU_VERT_ATTR_MAX_LEN). */
69   uint attr_len;
70   /** Total count of active vertex attribute. */
71   uint name_len;
72   /** Stride in bytes, 1 to 256. */
73   uint stride;
74   uint name_offset;
75   bool packed;
76   char names[GPU_VERT_ATTR_NAMES_BUF_LEN];
77   /** TODO: variable-size array */
78   GPUVertAttr attrs[GPU_VERT_ATTR_MAX_LEN];
79 } GPUVertFormat;
80
81 struct GPUShaderInterface;
82
83 void GPU_vertformat_clear(GPUVertFormat *);
84 void GPU_vertformat_copy(GPUVertFormat *dest, const GPUVertFormat *src);
85 void GPU_vertformat_from_interface(GPUVertFormat *format,
86                                    const struct GPUShaderInterface *shaderface);
87
88 uint GPU_vertformat_attr_add(
89     GPUVertFormat *, const char *name, GPUVertCompType, uint comp_len, GPUVertFetchMode);
90 void GPU_vertformat_alias_add(GPUVertFormat *, const char *alias);
91 int GPU_vertformat_attr_id_get(const GPUVertFormat *, const char *name);
92
93 /**
94  * This makes the "virtual" attributes with suffixes "0", "1", "2"
95  * to access triangle data in the vertex shader.
96  *
97  * IMPORTANT:
98  * - Call this before creating the vertex buffer and after creating all attributes
99  * - Only first vertex out of 3 has the correct information.
100  *   Use flat output with #GL_FIRST_VERTEX_CONVENTION.
101  */
102 void GPU_vertformat_triple_load(GPUVertFormat *format);
103
104 /* format conversion */
105
106 typedef struct GPUPackedNormal {
107   int x : 10;
108   int y : 10;
109   int z : 10;
110   int w : 2; /* 0 by default, can manually set to { -2, -1, 0, 1 } */
111 } GPUPackedNormal;
112
113 GPUPackedNormal GPU_normal_convert_i10_v3(const float data[3]);
114 GPUPackedNormal GPU_normal_convert_i10_s3(const short data[3]);
115
116 #endif /* __GPU_VERTEX_FORMAT_H__ */