Cleanup: comments (long lines) in gpu
[blender.git] / source / blender / gpu / GPU_matrix.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) 2012 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup gpu
22  */
23
24 #ifndef __GPU_MATRIX_H__
25 #define __GPU_MATRIX_H__
26
27 #include "BLI_sys_types.h"
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 struct GPUShaderInterface;
34
35 void GPU_matrix_reset(void); /* to Identity transform & empty stack */
36
37 /* ModelView Matrix (2D or 3D) */
38
39 void GPU_matrix_push(void); /* TODO: PushCopy vs PushIdentity? */
40 void GPU_matrix_pop(void);
41
42 void GPU_matrix_identity_set(void);
43
44 void GPU_matrix_scale_1f(float factor);
45
46 /* 3D ModelView Matrix */
47
48 void GPU_matrix_set(const float m[4][4]);
49 void GPU_matrix_mul(const float m[4][4]);
50
51 void GPU_matrix_translate_3f(float x, float y, float z);
52 void GPU_matrix_translate_3fv(const float vec[3]);
53 void GPU_matrix_scale_3f(float x, float y, float z);
54 void GPU_matrix_scale_3fv(const float vec[3]);
55 void GPU_matrix_rotate_3f(float deg,
56                           float x,
57                           float y,
58                           float z); /* axis of rotation should be a unit vector */
59 void GPU_matrix_rotate_3fv(float deg,
60                            const float axis[3]);   /* axis of rotation should be a unit vector */
61 void GPU_matrix_rotate_axis(float deg, char axis); /* TODO: enum for axis? */
62
63 void GPU_matrix_look_at(float eyeX,
64                         float eyeY,
65                         float eyeZ,
66                         float centerX,
67                         float centerY,
68                         float centerZ,
69                         float upX,
70                         float upY,
71                         float upZ);
72 /* TODO: variant that takes eye[3], center[3], up[3] */
73
74 /* 2D ModelView Matrix */
75
76 void GPU_matrix_translate_2f(float x, float y);
77 void GPU_matrix_translate_2fv(const float vec[2]);
78 void GPU_matrix_scale_2f(float x, float y);
79 void GPU_matrix_scale_2fv(const float vec[2]);
80 void GPU_matrix_rotate_2d(float deg);
81
82 /* Projection Matrix (2D or 3D) */
83
84 void GPU_matrix_push_projection(void);
85 void GPU_matrix_pop_projection(void);
86
87 /* 3D Projection Matrix */
88
89 void GPU_matrix_identity_projection_set(void);
90 void GPU_matrix_projection_set(const float m[4][4]);
91
92 void GPU_matrix_ortho_set(float left, float right, float bottom, float top, float near, float far);
93 void GPU_matrix_frustum_set(
94     float left, float right, float bottom, float top, float near, float far);
95 void GPU_matrix_perspective_set(float fovy, float aspect, float near, float far);
96
97 /* 3D Projection between Window and World Space */
98
99 void GPU_matrix_project(const float world[3],
100                         const float model[4][4],
101                         const float proj[4][4],
102                         const int view[4],
103                         float win[3]);
104 bool GPU_matrix_unproject(const float win[3],
105                           const float model[4][4],
106                           const float proj[4][4],
107                           const int view[4],
108                           float world[3]);
109
110 /* 2D Projection Matrix */
111
112 void GPU_matrix_ortho_2d_set(float left, float right, float bottom, float top);
113
114 /* functions to get matrix values */
115 const float (*GPU_matrix_model_view_get(float m[4][4]))[4];
116 const float (*GPU_matrix_projection_get(float m[4][4]))[4];
117 const float (*GPU_matrix_model_view_projection_get(float m[4][4]))[4];
118
119 const float (*GPU_matrix_normal_get(float m[3][3]))[3];
120 const float (*GPU_matrix_normal_inverse_get(float m[3][3]))[3];
121
122 /* set uniform values for currently bound shader */
123 void GPU_matrix_bind(const struct GPUShaderInterface *);
124 bool GPU_matrix_dirty_get(void); /* since last bind */
125
126 /* Python API needs to be able to inspect the stack so errors raise exceptions
127  * instead of crashing. */
128 #ifdef USE_GPU_PY_MATRIX_API
129 int GPU_matrix_stack_level_get_model_view(void);
130 int GPU_matrix_stack_level_get_projection(void);
131 /* static assert ensures this doesn't change! */
132 #  define GPU_PY_MATRIX_STACK_LEN 31
133 #endif /* USE_GPU_PY_MATRIX_API */
134
135 #ifdef __cplusplus
136 }
137 #endif
138
139 #ifndef SUPPRESS_GENERIC_MATRIX_API
140
141 #  if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
142 #    define _GPU_MAT3_CONST_CAST(x) \
143       (_Generic((x), \
144   void *:       (const float (*)[3])(x), \
145   float *:      (const float (*)[3])(x), \
146   float [9]:    (const float (*)[3])(x), \
147   float (*)[4]: (const float (*)[3])(x), \
148   float [4][4]: (const float (*)[3])(x), \
149   const void *:       (const float (*)[3])(x), \
150   const float *:      (const float (*)[3])(x), \
151   const float [9]:    (const float (*)[3])(x), \
152   const float (*)[3]: (const float (*)[3])(x), \
153   const float [3][3]: (const float (*)[3])(x)) \
154 )
155 #    define _GPU_MAT3_CAST(x) \
156       (_Generic((x), \
157   void *:       (float (*)[3])(x), \
158   float *:      (float (*)[3])(x), \
159   float [9]:    (float (*)[3])(x), \
160   float (*)[3]: (float (*)[3])(x), \
161   float [3][3]: (float (*)[3])(x)) \
162 )
163 #    define _GPU_MAT4_CONST_CAST(x) \
164       (_Generic((x), \
165   void *:       (const float (*)[4])(x), \
166   float *:      (const float (*)[4])(x), \
167   float [16]:   (const float (*)[4])(x), \
168   float (*)[4]: (const float (*)[4])(x), \
169   float [4][4]: (const float (*)[4])(x), \
170   const void *:       (const float (*)[4])(x), \
171   const float *:      (const float (*)[4])(x), \
172   const float [16]:   (const float (*)[4])(x), \
173   const float (*)[4]: (const float (*)[4])(x), \
174   const float [4][4]: (const float (*)[4])(x)) \
175 )
176 #    define _GPU_MAT4_CAST(x) \
177       (_Generic((x), \
178   void *:       (float (*)[4])(x), \
179   float *:      (float (*)[4])(x), \
180   float [16]:   (float (*)[4])(x), \
181   float (*)[4]: (float (*)[4])(x), \
182   float [4][4]: (float (*)[4])(x)) \
183 )
184 #  else
185 #    define _GPU_MAT3_CONST_CAST(x) (const float(*)[3])(x)
186 #    define _GPU_MAT3_CAST(x) (float(*)[3])(x)
187 #    define _GPU_MAT4_CONST_CAST(x) (const float(*)[4])(x)
188 #    define _GPU_MAT4_CAST(x) (float(*)[4])(x)
189 #  endif /* C11 */
190
191 /* make matrix inputs generic, to avoid warnings */
192 #  define GPU_matrix_mul(x) GPU_matrix_mul(_GPU_MAT4_CONST_CAST(x))
193 #  define GPU_matrix_set(x) GPU_matrix_set(_GPU_MAT4_CONST_CAST(x))
194 #  define GPU_matrix_projection_set(x) GPU_matrix_projection_set(_GPU_MAT4_CONST_CAST(x))
195 #  define GPU_matrix_model_view_get(x) GPU_matrix_model_view_get(_GPU_MAT4_CAST(x))
196 #  define GPU_matrix_projection_get(x) GPU_matrix_projection_get(_GPU_MAT4_CAST(x))
197 #  define GPU_matrix_model_view_projection_get(x) \
198     GPU_matrix_model_view_projection_get(_GPU_MAT4_CAST(x))
199 #  define GPU_matrix_normal_get(x) GPU_matrix_normal_get(_GPU_MAT3_CAST(x))
200 #  define GPU_matrix_normal_inverse_get(x) GPU_matrix_normal_inverse_get(_GPU_MAT3_CAST(x))
201 #endif /* SUPPRESS_GENERIC_MATRIX_API */
202
203 #endif /* __GPU_MATRIX_H__ */