]> git.tdb.fi Git - libs/gl.git/blob - source/core/datatype.h
Update and improve documentation
[libs/gl.git] / source / core / datatype.h
1 #ifndef MSP_GL_DATATYPE_H_
2 #define MSP_GL_DATATYPE_H_
3
4 #include <msp/linal/matrix.h>
5 #include <msp/linal/vector.h>
6
7 namespace Msp {
8 namespace GL {
9
10 /**
11 Identifies a data type.
12
13 The values are bitfields laid as follows:
14
15 __hm addd ccrr _bfg ssss ssss
16   ││ │  │  │ │  │││         └╴Size (bytes)
17   ││ │  │  │ │  ││└──────────╴Signed flag
18   ││ │  │  │ │  │└───────────╴Floating-point flag
19   ││ │  │  │ │  └────────────╴Boolean flag
20   ││ │  │  │ └───────────────╴Vector or matrix rows minus one
21   ││ │  │  └─────────────────╴Matrix columns minus one
22   ││ │  └────────────────────╴Image dimensions (4 = cube)
23   ││ └───────────────────────╴Image array flag
24   │└─────────────────────────╴Sampled image flag
25   └──────────────────────────╴Shadow sampler flag
26
27 This information is presented for internal documentation purposes only; it is
28 inadvisable for applications to rely on it.
29 */
30 enum DataType
31 {
32         VOID = 0,
33         BOOL = 0x401,
34         BYTE = 0x101,
35         UNSIGNED_BYTE = 0x001,
36         SHORT = 0x102,
37         UNSIGNED_SHORT = 0x002,
38         INT = 0x104,
39         UNSIGNED_INT = 0x004,
40         FLOAT = 0x304,
41         HALF_FLOAT = 0x302,
42         DOUBLE = 0x308,
43
44         FLOAT_VEC2 = 0x1308,
45         FLOAT_VEC3 = 0x230C,
46         FLOAT_VEC4 = 0x3310,
47         INT_VEC2 = 0x1108,
48         INT_VEC3 = 0x210C,
49         INT_VEC4 = 0x3110,
50         BOOL_VEC2 = 0x1402,
51         BOOL_VEC3 = 0x2403,
52         BOOL_VEC4 = 0x3404,
53
54         FLOAT_MAT2 = 0x5310,
55         FLOAT_MAT3 = 0xA324,
56         FLOAT_MAT4 = 0xF340,
57         FLOAT_MAT2x3 = 0x6318,
58         FLOAT_MAT3x2 = 0x9318,
59         FLOAT_MAT2x4 = 0x7320,
60         FLOAT_MAT4x2 = 0xD320,
61         FLOAT_MAT3x4 = 0xB330,
62         FLOAT_MAT4x3 = 0xE330,
63
64         DOUBLE_MAT2 = 0x5320,
65         DOUBLE_MAT3 = 0xA348,
66         DOUBLE_MAT4 = 0xF380,
67         DOUBLE_MAT2x3 = 0x6330,
68         DOUBLE_MAT3x2 = 0x7330,
69         DOUBLE_MAT2x4 = 0x7340,
70         DOUBLE_MAT4x2 = 0xD340,
71         DOUBLE_MAT3x4 = 0xB360,
72         DOUBLE_MAT4x3 = 0xE360,
73
74         IMAGE_1D = 0x10304,
75         IMAGE_2D = 0x20304,
76         IMAGE_3D = 0x30304,
77         IMAGE_CUBE = 0x40304,
78         IMAGE_1D_ARRAY = 0x90304,
79         IMAGE_2D_ARRAY = 0xA0304,
80         IMAGE_CUBE_ARRAY = 0xC0304,
81         SAMPLER_1D = 0x110304,
82         SAMPLER_2D = 0x120304,
83         SAMPLER_3D = 0x130304,
84         SAMPLER_CUBE = 0x140304,
85         SAMPLER_1D_ARRAY = 0x190304,
86         SAMPLER_2D_ARRAY = 0x1A0304,
87         SAMPLER_CUBE_ARRAY = 0x1C0304,
88         SAMPLER_1D_SHADOW = 0x310304,
89         SAMPLER_2D_SHADOW = 0x320304,
90         SAMPLER_CUBE_SHADOW = 0x340304,
91         SAMPLER_1D_ARRAY_SHADOW = 0x390304,
92         SAMPLER_2D_ARRAY_SHADOW = 0x3A0304,
93         SAMPLER_CUBE_ARRAY_SHADOW = 0x3C0304
94 };
95
96 inline std::size_t get_type_size(DataType t) { return t&0xFF; }
97 inline bool is_float(DataType t) { return t&0x200; }
98 inline bool is_matrix(DataType t) { return t&0xC000; }
99 inline bool is_vector(DataType t) { return !is_matrix(t) && (t&0x3000); }
100 inline bool is_image(DataType t) { return t&0x70000; }
101
102 inline DataType get_matrix_column_type(DataType t)
103 {
104         unsigned cols = ((t&0xC000)>>14)+1;
105         return static_cast<DataType>((t&~0xC0FF) | (get_type_size(t)/cols));
106 }
107
108 inline DataType get_element_type(DataType t)
109 {
110         unsigned elems = (((t&0xC000)>>14)+1)*(((t&0x3000)>>12)+1);
111         return static_cast<DataType>((t&~0xC0FF) | (get_type_size(t)/elems));
112 }
113
114 template<typename T> struct TypeTraits;
115 template<> struct TypeTraits<bool> { static const DataType type = BOOL; };
116 template<> struct TypeTraits<char> { static const DataType type = BYTE; };
117 template<> struct TypeTraits<unsigned char> { static const DataType type = UNSIGNED_BYTE; };
118 template<> struct TypeTraits<short> { static const DataType type = SHORT; };
119 template<> struct TypeTraits<unsigned short> { static const DataType type = UNSIGNED_SHORT; };
120 template<> struct TypeTraits<int> { static const DataType type = INT; };
121 template<> struct TypeTraits<unsigned> { static const DataType type = UNSIGNED_INT; };
122 template<> struct TypeTraits<float> { static const DataType type = FLOAT; };
123 template<> struct TypeTraits<double> { static const DataType type = DOUBLE; };
124
125 template<typename T, unsigned N>
126 struct TypeTraits<LinAl::Vector<T, N>>
127 {
128         static const DataType type = static_cast<DataType>((TypeTraits<T>::type&0xF00) | ((TypeTraits<T>::type&0xFF)*N) | ((N-1)<<12));
129 };
130
131 template<typename T, unsigned N, unsigned M>
132 struct TypeTraits<LinAl::Matrix<T, N, M>>
133 {
134         static const DataType type = static_cast<DataType>((TypeTraits<T>::type&0xF00) | ((TypeTraits<T>::type&0xFF)*N*M) | ((N-1)<<12) | ((M-1)<<14));
135 };
136
137 void require_type(DataType);
138
139 } // namespace GL
140 } // namespace Msp
141
142 #include "datatype_backend.h"
143
144 #endif