Fix T62178 Eevee: Texture Box mapping not matching Cycles if object is scaled
[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
47 /* 3D ModelView Matrix */
48
49 void GPU_matrix_set(const float m[4][4]);
50 void GPU_matrix_mul(const float m[4][4]);
51
52 void GPU_matrix_translate_3f(float x, float y, float z);
53 void GPU_matrix_translate_3fv(const float vec[3]);
54 void GPU_matrix_scale_3f(float x, float y, float z);
55 void GPU_matrix_scale_3fv(const float vec[3]);
56 void GPU_matrix_rotate_3f(float deg, float x, float y, float z); /* axis of rotation should be a unit vector */
57 void GPU_matrix_rotate_3fv(float deg, const float axis[3]); /* axis of rotation should be a unit vector */
58 void GPU_matrix_rotate_axis(float deg, char axis); /* TODO: enum for axis? */
59
60 void GPU_matrix_look_at(float eyeX, float eyeY, float eyeZ, float centerX, float centerY, float centerZ, float upX, float upY, float upZ);
61 /* TODO: variant that takes eye[3], center[3], up[3] */
62
63
64 /* 2D ModelView Matrix */
65
66 void GPU_matrix_translate_2f(float x, float y);
67 void GPU_matrix_translate_2fv(const float vec[2]);
68 void GPU_matrix_scale_2f(float x, float y);
69 void GPU_matrix_scale_2fv(const float vec[2]);
70 void GPU_matrix_rotate_2d(float deg);
71
72 /* Projection Matrix (2D or 3D) */
73
74 void GPU_matrix_push_projection(void);
75 void GPU_matrix_pop_projection(void);
76
77 /* 3D Projection Matrix */
78
79 void GPU_matrix_identity_projection_set(void);
80 void GPU_matrix_projection_set(const float m[4][4]);
81
82 void GPU_matrix_ortho_set(float left, float right, float bottom, float top, float near, float far);
83 void GPU_matrix_frustum_set(float left, float right, float bottom, float top, float near, float far);
84 void GPU_matrix_perspective_set(float fovy, float aspect, float near, float far);
85
86 /* 3D Projection between Window and World Space */
87
88 void GPU_matrix_project(const float world[3], const float model[4][4], const float proj[4][4], const int view[4], float win[3]);
89 bool GPU_matrix_unproject(const float win[3], const float model[4][4], const float proj[4][4], const int view[4], float world[3]);
90
91 /* 2D Projection Matrix */
92
93 void GPU_matrix_ortho_2d_set(float left, float right, float bottom, float top);
94
95
96 /* functions to get matrix values */
97 const float (*GPU_matrix_model_view_get(float m[4][4]))[4];
98 const float (*GPU_matrix_projection_get(float m[4][4]))[4];
99 const float (*GPU_matrix_model_view_projection_get(float m[4][4]))[4];
100
101 const float (*GPU_matrix_normal_get(float m[3][3]))[3];
102 const float (*GPU_matrix_normal_inverse_get(float m[3][3]))[3];
103
104
105 /* set uniform values for currently bound shader */
106 void GPU_matrix_bind(const struct GPUShaderInterface *);
107 bool GPU_matrix_dirty_get(void); /* since last bind */
108
109
110 /* Python API needs to be able to inspect the stack so errors raise exceptions instead of crashing. */
111 #ifdef USE_GPU_PY_MATRIX_API
112 int GPU_matrix_stack_level_get_model_view(void);
113 int GPU_matrix_stack_level_get_projection(void);
114 /* static assert ensures this doesn't change! */
115 #define GPU_PY_MATRIX_STACK_LEN 31
116 #endif  /* USE_GPU_PY_MATRIX_API */
117
118
119 #ifdef __cplusplus
120 }
121 #endif
122
123 #ifndef SUPPRESS_GENERIC_MATRIX_API
124
125 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
126 #define _GPU_MAT3_CONST_CAST(x) (_Generic((x), \
127         void *:       (const float (*)[3])(x), \
128         float *:      (const float (*)[3])(x), \
129         float [9]:    (const float (*)[3])(x), \
130         float (*)[4]: (const float (*)[3])(x), \
131         float [4][4]: (const float (*)[3])(x), \
132         const void *:       (const float (*)[3])(x), \
133         const float *:      (const float (*)[3])(x), \
134         const float [9]:    (const float (*)[3])(x), \
135         const float (*)[3]: (const float (*)[3])(x), \
136         const float [3][3]: (const float (*)[3])(x)) \
137 )
138 #define _GPU_MAT3_CAST(x) (_Generic((x), \
139         void *:       (float (*)[3])(x), \
140         float *:      (float (*)[3])(x), \
141         float [9]:    (float (*)[3])(x), \
142         float (*)[3]: (float (*)[3])(x), \
143         float [3][3]: (float (*)[3])(x)) \
144 )
145 #define _GPU_MAT4_CONST_CAST(x) (_Generic((x), \
146         void *:       (const float (*)[4])(x), \
147         float *:      (const float (*)[4])(x), \
148         float [16]:   (const float (*)[4])(x), \
149         float (*)[4]: (const float (*)[4])(x), \
150         float [4][4]: (const float (*)[4])(x), \
151         const void *:       (const float (*)[4])(x), \
152         const float *:      (const float (*)[4])(x), \
153         const float [16]:   (const float (*)[4])(x), \
154         const float (*)[4]: (const float (*)[4])(x), \
155         const float [4][4]: (const float (*)[4])(x)) \
156 )
157 #define _GPU_MAT4_CAST(x) (_Generic((x), \
158         void *:       (float (*)[4])(x), \
159         float *:      (float (*)[4])(x), \
160         float [16]:   (float (*)[4])(x), \
161         float (*)[4]: (float (*)[4])(x), \
162         float [4][4]: (float (*)[4])(x)) \
163 )
164 #else
165 #  define _GPU_MAT3_CONST_CAST(x) (const float (*)[3])(x)
166 #  define _GPU_MAT3_CAST(x)             (float (*)[3])(x)
167 #  define _GPU_MAT4_CONST_CAST(x) (const float (*)[4])(x)
168 #  define _GPU_MAT4_CAST(x)             (float (*)[4])(x)
169 #endif  /* C11 */
170
171 /* make matrix inputs generic, to avoid warnings */
172 #  define GPU_matrix_mul(x)  GPU_matrix_mul(_GPU_MAT4_CONST_CAST(x))
173 #  define GPU_matrix_set(x)  GPU_matrix_set(_GPU_MAT4_CONST_CAST(x))
174 #  define GPU_matrix_projection_set(x)  GPU_matrix_projection_set(_GPU_MAT4_CONST_CAST(x))
175 #  define GPU_matrix_model_view_get(x)  GPU_matrix_model_view_get(_GPU_MAT4_CAST(x))
176 #  define GPU_matrix_projection_get(x)  GPU_matrix_projection_get(_GPU_MAT4_CAST(x))
177 #  define GPU_matrix_model_view_projection_get(x)  GPU_matrix_model_view_projection_get(_GPU_MAT4_CAST(x))
178 #  define GPU_matrix_normal_get(x)  GPU_matrix_normal_get(_GPU_MAT3_CAST(x))
179 #  define GPU_matrix_normal_inverse_get(x)  GPU_matrix_normal_inverse_get(_GPU_MAT3_CAST(x))
180 #endif /* SUPPRESS_GENERIC_MATRIX_API */
181
182 #endif /* __GPU_MATRIX_H__ */