Fix T62178 Eevee: Texture Box mapping not matching Cycles if object is scaled
[blender.git] / source / blender / gpu / GPU_framebuffer.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) 2005 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup gpu
22  */
23
24 #ifndef __GPU_FRAMEBUFFER_H__
25 #define __GPU_FRAMEBUFFER_H__
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 struct GPUTexture;
32
33 typedef struct GPUAttachment {
34         struct GPUTexture *tex;
35         int mip, layer;
36 } GPUAttachment;
37
38 typedef enum eGPUFrameBufferBits {
39         GPU_COLOR_BIT    = (1 << 0),
40         GPU_DEPTH_BIT    = (1 << 1),
41         GPU_STENCIL_BIT  = (1 << 2),
42 } eGPUFrameBufferBits;
43
44 typedef struct GPUFrameBuffer GPUFrameBuffer;
45 typedef struct GPUOffScreen GPUOffScreen;
46
47 /* GPU Framebuffer
48  * - this is a wrapper for an OpenGL framebuffer object (FBO). in practice
49  *   multiple FBO's may be created, to get around limitations on the number
50  *   of attached textures and the dimension requirements.
51  * - actual FBO creation & config is deferred until GPU_framebuffer_bind or
52  *   GPU_framebuffer_check_valid to allow creation & config while another
53  *   opengl context is bound (since FBOs are not shared between ogl contexts).
54  */
55
56 GPUFrameBuffer *GPU_framebuffer_create(void);
57 void GPU_framebuffer_free(GPUFrameBuffer *fb);
58 void GPU_framebuffer_bind(GPUFrameBuffer *fb);
59 void GPU_framebuffer_restore(void);
60
61 bool GPU_framebuffer_bound(GPUFrameBuffer *fb);
62 bool GPU_framebuffer_check_valid(GPUFrameBuffer *fb, char err_out[256]);
63
64 GPUFrameBuffer *GPU_framebuffer_active_get(void);
65
66 #define GPU_FRAMEBUFFER_FREE_SAFE(fb) do { \
67         if (fb != NULL) { \
68                 GPU_framebuffer_free(fb); \
69                 fb = NULL; \
70         } \
71 } while (0)
72
73 /* Framebuffer setup : You need to call GPU_framebuffer_bind for theses
74  * to be effective. */
75
76 void GPU_framebuffer_texture_attach(
77         GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int mip);
78 void GPU_framebuffer_texture_layer_attach(
79         GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int layer, int mip);
80 void GPU_framebuffer_texture_cubeface_attach(
81         GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int face, int mip);
82 void GPU_framebuffer_texture_detach(GPUFrameBuffer *fb, struct GPUTexture *tex);
83 void GPU_framebuffer_texture_detach_slot(
84         GPUFrameBuffer *fb, struct GPUTexture *tex, int type);
85
86 /**
87  * How to use #GPU_framebuffer_ensure_config().
88  *
89  * Example:
90  * \code{.c}
91  * GPU_framebuffer_ensure_config(&fb, {
92  *         GPU_ATTACHMENT_TEXTURE(depth), // must be depth buffer
93  *         GPU_ATTACHMENT_TEXTURE(tex1),
94  *         GPU_ATTACHMENT_TEXTURE_CUBEFACE(tex2, 0),
95  *         GPU_ATTACHMENT_TEXTURE_LAYER_MIP(tex2, 0, 0)
96  * })
97  * \encode
98  *
99  * \note Unspecified attachements (i.e: those beyond the last
100  * GPU_ATTACHMENT_* in GPU_framebuffer_ensure_config list) are left unchanged.
101  *
102  * \note Make sure that the dimensions of your textures matches
103  * otherwise you will have an invalid framebuffer error.
104  */
105 #define GPU_framebuffer_ensure_config(_fb, ...) do { \
106         if (*(_fb) == NULL) { \
107                 *(_fb) = GPU_framebuffer_create(); \
108         } \
109         GPUAttachment config[] = __VA_ARGS__; \
110         GPU_framebuffer_config_array(*(_fb), config, (sizeof(config) / sizeof(GPUAttachment))); \
111 } while (0)
112
113 void GPU_framebuffer_config_array(GPUFrameBuffer *fb, const GPUAttachment *config, int config_len);
114
115 #define GPU_ATTACHMENT_NONE \
116         { .tex = NULL, .layer = -1, .mip = 0, }
117 #define GPU_ATTACHMENT_LEAVE \
118         { .tex = NULL, .layer = -1, .mip = -1, }
119 #define GPU_ATTACHMENT_TEXTURE(_tex) \
120         { .tex = _tex, .layer = -1, .mip = 0, }
121 #define GPU_ATTACHMENT_TEXTURE_MIP(_tex, _mip) \
122         { .tex = _tex, .layer = -1, .mip = _mip, }
123 #define GPU_ATTACHMENT_TEXTURE_LAYER(_tex, _layer) \
124         { .tex = _tex, .layer = _layer, .mip = 0, }
125 #define GPU_ATTACHMENT_TEXTURE_LAYER_MIP(_tex, _layer, _mip) \
126         { .tex = _tex, .layer = _layer, .mip = _mip, }
127 #define GPU_ATTACHMENT_TEXTURE_CUBEFACE(_tex, _face) \
128         { .tex = _tex, .layer = _face, .mip = 0, }
129 #define GPU_ATTACHMENT_TEXTURE_CUBEFACE_MIP(_tex, _face, _mip) \
130         { .tex = _tex, .layer = _face, .mip = _mip, }
131
132 /* Framebuffer operations */
133
134 void GPU_framebuffer_viewport_set(GPUFrameBuffer *fb, int x, int y, int w, int h);
135
136 void GPU_framebuffer_clear(
137         GPUFrameBuffer *fb, eGPUFrameBufferBits buffers,
138         const float clear_col[4], float clear_depth, unsigned int clear_stencil);
139
140 #define GPU_framebuffer_clear_color(fb, col) \
141         GPU_framebuffer_clear(fb, GPU_COLOR_BIT, col, 0.0f, 0x00)
142
143 #define GPU_framebuffer_clear_depth(fb, depth) \
144         GPU_framebuffer_clear(fb, GPU_DEPTH_BIT, NULL, depth, 0x00)
145
146 #define GPU_framebuffer_clear_color_depth(fb, col, depth) \
147         GPU_framebuffer_clear(fb, GPU_COLOR_BIT | GPU_DEPTH_BIT, col, depth, 0x00)
148
149 #define GPU_framebuffer_clear_stencil(fb, stencil) \
150         GPU_framebuffer_clear(fb, GPU_STENCIL_BIT, NULL, 0.0f, stencil)
151
152 #define GPU_framebuffer_clear_depth_stencil(fb, depth, stencil) \
153         GPU_framebuffer_clear(fb, GPU_DEPTH_BIT | GPU_STENCIL_BIT, NULL, depth, stencil)
154
155 #define GPU_framebuffer_clear_color_depth_stencil(fb, col, depth, stencil) \
156         GPU_framebuffer_clear(fb, GPU_COLOR_BIT | GPU_DEPTH_BIT | GPU_STENCIL_BIT, col, depth, stencil)
157
158 void GPU_framebuffer_read_depth(GPUFrameBuffer *fb, int x, int y, int w, int h, float *data);
159 void GPU_framebuffer_read_color(
160         GPUFrameBuffer *fb, int x, int y, int w, int h, int channels, int slot, float *data);
161
162 void GPU_framebuffer_blit(
163         GPUFrameBuffer *fb_read, int read_slot,
164         GPUFrameBuffer *fb_write, int write_slot,
165         eGPUFrameBufferBits blit_buffers);
166
167 void GPU_framebuffer_recursive_downsample(
168         GPUFrameBuffer *fb, int max_lvl,
169         void (*callback)(void *userData, int level), void *userData);
170
171 /* GPU OffScreen
172  * - wrapper around framebuffer and texture for simple offscreen drawing
173  */
174
175 GPUOffScreen *GPU_offscreen_create(
176         int width, int height, int samples,
177         bool depth, bool high_bitdepth, char err_out[256]);
178 void GPU_offscreen_free(GPUOffScreen *ofs);
179 void GPU_offscreen_bind(GPUOffScreen *ofs, bool save);
180 void GPU_offscreen_unbind(GPUOffScreen *ofs, bool restore);
181 void GPU_offscreen_read_pixels(GPUOffScreen *ofs, int type, void *pixels);
182 void GPU_offscreen_draw_to_screen(GPUOffScreen *ofs, int x, int y);
183 int GPU_offscreen_width(const GPUOffScreen *ofs);
184 int GPU_offscreen_height(const GPUOffScreen *ofs);
185 struct GPUTexture *GPU_offscreen_color_texture(const GPUOffScreen *ofs);
186
187 void GPU_offscreen_viewport_data_get(
188         GPUOffScreen *ofs,
189         GPUFrameBuffer **r_fb, struct GPUTexture **r_color, struct GPUTexture **r_depth);
190
191 void GPU_clear_color(float red, float green, float blue, float alpha);
192 void GPU_clear(eGPUFrameBufferBits flags);
193
194 #ifdef __cplusplus
195 }
196 #endif
197
198 #endif  /* __GPU_FRAMEBUFFER_H__ */