Merge branch 'master' into blender2.8
[blender.git] / source / blender / gpu / GPU_framebuffer.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Brecht Van Lommel.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file GPU_framebuffer.h
29  *  \ingroup gpu
30  */
31
32 #ifndef __GPU_FRAMEBUFFER_H__
33 #define __GPU_FRAMEBUFFER_H__
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct GPUTexture;
40
41 typedef struct GPUAttachment {
42         struct GPUTexture *tex;
43         int mip, layer;
44 } GPUAttachment;
45
46 typedef enum GPUFrameBufferBits {
47         GPU_COLOR_BIT    = (1 << 0),
48         GPU_DEPTH_BIT    = (1 << 1),
49         GPU_STENCIL_BIT  = (1 << 2),
50 } GPUFrameBufferBits;
51
52 typedef struct GPUFrameBuffer GPUFrameBuffer;
53 typedef struct GPUOffScreen GPUOffScreen;
54
55 /* GPU Framebuffer
56  * - this is a wrapper for an OpenGL framebuffer object (FBO). in practice
57  *   multiple FBO's may be created, to get around limitations on the number
58  *   of attached textures and the dimension requirements.
59  * - actual FBO creation & config is deferred until GPU_framebuffer_bind or
60  *   GPU_framebuffer_check_valid to allow creation & config while another
61  *   opengl context is bound (since FBOs are not shared between ogl contexts).
62  */
63
64 GPUFrameBuffer *GPU_framebuffer_create(void);
65 void GPU_framebuffer_free(GPUFrameBuffer *fb);
66 void GPU_framebuffer_bind(GPUFrameBuffer *fb);
67 void GPU_framebuffer_restore(void);
68
69 bool GPU_framebuffer_bound(GPUFrameBuffer *fb);
70 bool GPU_framebuffer_check_valid(GPUFrameBuffer *fb, char err_out[256]);
71
72 /* internal use only */
73 unsigned int GPU_framebuffer_current_get(void);
74
75 #define GPU_FRAMEBUFFER_FREE_SAFE(fb) do { \
76         if (fb != NULL) { \
77                 GPU_framebuffer_free(fb); \
78                 fb = NULL; \
79         } \
80 } while (0)
81
82 /* Framebuffer setup : You need to call GPU_framebuffer_bind for theses
83  * to be effective. */
84
85 void GPU_framebuffer_texture_attach(
86         GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int mip);
87 void GPU_framebuffer_texture_layer_attach(
88         GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int layer, int mip);
89 void GPU_framebuffer_texture_cubeface_attach(
90         GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int face, int mip);
91 void GPU_framebuffer_texture_detach(GPUFrameBuffer *fb, struct GPUTexture *tex);
92 void GPU_framebuffer_texture_detach_slot(
93         GPUFrameBuffer *fb, struct GPUTexture *tex, int type);
94
95 /**
96  * How to use GPU_framebuffer_ensure_config().
97  *
98  * Example :
99  * GPU_framebuffer_ensure_config(&fb, {
100  *         GPU_ATTACHMENT_TEXTURE(depth), // must be depth buffer
101  *         GPU_ATTACHMENT_TEXTURE(tex1),
102  *         GPU_ATTACHMENT_TEXTURE_CUBEFACE(tex2, 0),
103  *         GPU_ATTACHMENT_TEXTURE_LAYER_MIP(tex2, 0, 0)
104  * })
105  *
106  * Note : Unspecified attachements (i.e: those beyond the last
107  *        GPU_ATTACHMENT_* in GPU_framebuffer_ensure_config list)
108  *        are left unchanged.
109  * Note : Make sure that the dimensions of your textures matches
110  *        otherwise you will have an invalid framebuffer error.
111  **/
112 #define GPU_framebuffer_ensure_config(_fb, ...) do { \
113         if (*(_fb) == NULL) { \
114                 *(_fb) = GPU_framebuffer_create(); \
115         } \
116         GPUAttachment config[] = __VA_ARGS__; \
117         GPU_framebuffer_config_array(*(_fb), config, (sizeof(config) / sizeof(GPUAttachment))); \
118 } while (0)
119
120 void GPU_framebuffer_config_array(GPUFrameBuffer *fb, const GPUAttachment *config, int config_ct);
121
122 #define GPU_ATTACHMENT_NONE \
123         {.tex = NULL, .layer = -1, .mip = 0}
124 #define GPU_ATTACHMENT_LEAVE \
125         {.tex = NULL, .layer = -1, .mip = -1}
126 #define GPU_ATTACHMENT_TEXTURE(_tex) \
127         {.tex = _tex, .layer = -1, .mip = 0}
128 #define GPU_ATTACHMENT_TEXTURE_MIP(_tex, _mip) \
129         {.tex = _tex, .layer = -1, .mip = _mip}
130 #define GPU_ATTACHMENT_TEXTURE_LAYER(_tex, _layer) \
131         {.tex = _tex, .layer = _layer, .mip = 0}
132 #define GPU_ATTACHMENT_TEXTURE_LAYER_MIP(_tex, _layer, _mip) \
133         {.tex = _tex, .layer = _layer, .mip = _mip}
134 #define GPU_ATTACHMENT_TEXTURE_CUBEFACE(_tex, _face) \
135         {.tex = _tex, .layer = _face, .mip = 0}
136 #define GPU_ATTACHMENT_TEXTURE_CUBEFACE_MIP(_tex, _face, _mip) \
137         {.tex = _tex, .layer = _face, .mip = _mip}
138
139 /* Framebuffer operations */
140
141 void GPU_framebuffer_viewport_set(GPUFrameBuffer *fb, int x, int y, int w, int h);
142
143 void GPU_framebuffer_clear(
144         GPUFrameBuffer *fb, GPUFrameBufferBits buffers,
145         const float clear_col[4], float clear_depth, unsigned int clear_stencil);
146
147 #define GPU_framebuffer_clear_color(fb, col) \
148         GPU_framebuffer_clear(fb, GPU_COLOR_BIT, col, 0.0f, 0x00)
149
150 #define GPU_framebuffer_clear_depth(fb, depth) \
151         GPU_framebuffer_clear(fb, GPU_DEPTH_BIT, NULL, depth, 0x00)
152
153 #define GPU_framebuffer_clear_color_depth(fb, col, depth) \
154         GPU_framebuffer_clear(fb, GPU_COLOR_BIT | GPU_DEPTH_BIT, col, depth, 0x00)
155
156 #define GPU_framebuffer_clear_stencil(fb, stencil) \
157         GPU_framebuffer_clear(fb, GPU_STENCIL_BIT, NULL, 0.0f, stencil)
158
159 #define GPU_framebuffer_clear_depth_stencil(fb, depth, stencil) \
160         GPU_framebuffer_clear(fb, GPU_DEPTH_BIT | GPU_STENCIL_BIT, NULL, depth, stencil)
161
162 #define GPU_framebuffer_clear_color_depth_stencil(fb, col, depth, stencil) \
163         GPU_framebuffer_clear(fb, GPU_COLOR_BIT | GPU_DEPTH_BIT | GPU_STENCIL_BIT, col, depth, stencil)
164
165 void GPU_framebuffer_read_depth(GPUFrameBuffer *fb, int x, int y, int w, int h, float *data);
166 void GPU_framebuffer_read_color(
167         GPUFrameBuffer *fb, int x, int y, int w, int h, int channels, int slot, float *data);
168
169 void GPU_framebuffer_blit(
170         GPUFrameBuffer *fb_read, int read_slot,
171         GPUFrameBuffer *fb_write, int write_slot,
172         GPUFrameBufferBits blit_buffers);
173
174 void GPU_framebuffer_recursive_downsample(
175         GPUFrameBuffer *fb, int max_lvl,
176         void (*callback)(void *userData, int level), void *userData);
177
178 /* GPU OffScreen
179  * - wrapper around framebuffer and texture for simple offscreen drawing
180  */
181
182 GPUOffScreen *GPU_offscreen_create(int width, int height, int samples,
183         bool depth, bool high_bitdepth, char err_out[256]);
184 void GPU_offscreen_free(GPUOffScreen *ofs);
185 void GPU_offscreen_bind(GPUOffScreen *ofs, bool save);
186 void GPU_offscreen_unbind(GPUOffScreen *ofs, bool restore);
187 void GPU_offscreen_read_pixels(GPUOffScreen *ofs, int type, void *pixels);
188 void GPU_offscreen_draw_to_screen(GPUOffScreen *ofs, int x, int y);
189 int GPU_offscreen_width(const GPUOffScreen *ofs);
190 int GPU_offscreen_height(const GPUOffScreen *ofs);
191 struct GPUTexture *GPU_offscreen_color_texture(const GPUOffScreen *ofs);
192
193 void GPU_offscreen_viewport_data_get(
194         GPUOffScreen *ofs,
195         GPUFrameBuffer **r_fb, struct GPUTexture **r_color, struct GPUTexture **r_depth);
196
197 #ifdef __cplusplus
198 }
199 #endif
200
201 #endif  /* __GPU_FRAMEBUFFER_H__ */