Gawain: name struct's
[blender.git] / intern / gawain / gawain / gwn_vertex_format.h
1
2 // Gawain vertex format
3 //
4 // This code is part of the Gawain library, with modifications
5 // specific to integration with Blender.
6 //
7 // Copyright 2016 Mike Erwin
8 //
9 // This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of
10 // the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
11
12 #pragma once
13
14 #include "gwn_common.h"
15
16 #define GWN_VERT_ATTR_MAX_LEN 16
17 #define MAX_ATTRIB_NAMES 3
18 #define GWN_VERT_ATTR_NAME_AVERAGE_LEN 11
19 #define GWN_VERT_ATTR_NAMES_BUF_LEN ((GWN_VERT_ATTR_NAME_AVERAGE_LEN + 1) * GWN_VERT_ATTR_MAX_LEN)
20
21 typedef enum {
22         GWN_COMP_I8,
23         GWN_COMP_U8,
24         GWN_COMP_I16,
25         GWN_COMP_U16,
26         GWN_COMP_I32,
27         GWN_COMP_U32,
28
29         GWN_COMP_F32,
30
31         GWN_COMP_I10
32 } Gwn_VertCompType;
33
34 typedef enum {
35         GWN_FETCH_FLOAT,
36         GWN_FETCH_INT,
37         GWN_FETCH_INT_TO_FLOAT_UNIT, // 127 (ubyte) -> 0.5 (and so on for other int types)
38         GWN_FETCH_INT_TO_FLOAT // 127 (any int type) -> 127.0
39 } Gwn_VertFetchMode;
40
41 typedef struct Gwn_VertAttr {
42         Gwn_VertCompType comp_type;
43         unsigned gl_comp_type;
44         unsigned comp_ct; // 1 to 4
45         unsigned sz; // size in bytes, 1 to 16
46         unsigned offset; // from beginning of vertex, in bytes
47         Gwn_VertFetchMode fetch_mode;
48         const char* name[MAX_ATTRIB_NAMES];
49         unsigned name_ct;
50 } Gwn_VertAttr;
51
52 typedef struct Gwn_VertFormat {
53         unsigned attrib_ct; // 0 to 16 (GWN_VERT_ATTR_MAX_LEN)
54         unsigned name_ct; // total count of active vertex attrib
55         unsigned stride; // stride in bytes, 1 to 256
56         bool packed;
57         Gwn_VertAttr attribs[GWN_VERT_ATTR_MAX_LEN]; // TODO: variable-size attribs array
58         char names[GWN_VERT_ATTR_NAMES_BUF_LEN];
59         unsigned name_offset;
60 } Gwn_VertFormat;
61
62 void GWN_vertformat_clear(Gwn_VertFormat*);
63 void GWN_vertformat_copy(Gwn_VertFormat* dest, const Gwn_VertFormat* src);
64
65 unsigned GWN_vertformat_attr_add(Gwn_VertFormat*, const char* name, Gwn_VertCompType, unsigned comp_ct, Gwn_VertFetchMode);
66 void GWN_vertformat_alias_add(Gwn_VertFormat*, const char* alias);
67
68 // format conversion
69
70 typedef struct Gwn_PackedNormal {
71         int x : 10;
72         int y : 10;
73         int z : 10;
74         int w : 2;      // 0 by default, can manually set to { -2, -1, 0, 1 }
75 } Gwn_PackedNormal;
76
77 Gwn_PackedNormal GWN_normal_convert_i10_v3(const float data[3]);
78 Gwn_PackedNormal GWN_normal_convert_i10_s3(const short data[3]);