Cleanup: add trailing commas to structs
[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 GPUFrameBuffer *GPU_framebuffer_active_get(void);
73
74 #define GPU_FRAMEBUFFER_FREE_SAFE(fb) do { \
75         if (fb != NULL) { \
76                 GPU_framebuffer_free(fb); \
77                 fb = NULL; \
78         } \
79 } while (0)
80
81 /* Framebuffer setup : You need to call GPU_framebuffer_bind for theses
82  * to be effective. */
83
84 void GPU_framebuffer_texture_attach(
85         GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int mip);
86 void GPU_framebuffer_texture_layer_attach(
87         GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int layer, int mip);
88 void GPU_framebuffer_texture_cubeface_attach(
89         GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, int face, int mip);
90 void GPU_framebuffer_texture_detach(GPUFrameBuffer *fb, struct GPUTexture *tex);
91 void GPU_framebuffer_texture_detach_slot(
92         GPUFrameBuffer *fb, struct GPUTexture *tex, int type);
93
94 /**
95  * How to use GPU_framebuffer_ensure_config().
96  *
97  * Example :
98  * GPU_framebuffer_ensure_config(&fb, {
99  *         GPU_ATTACHMENT_TEXTURE(depth), // must be depth buffer
100  *         GPU_ATTACHMENT_TEXTURE(tex1),
101  *         GPU_ATTACHMENT_TEXTURE_CUBEFACE(tex2, 0),
102  *         GPU_ATTACHMENT_TEXTURE_LAYER_MIP(tex2, 0, 0)
103  * })
104  *
105  * Note : Unspecified attachements (i.e: those beyond the last
106  *        GPU_ATTACHMENT_* in GPU_framebuffer_ensure_config list)
107  *        are left unchanged.
108  * Note : Make sure that the dimensions of your textures matches
109  *        otherwise you will have an invalid framebuffer error.
110  **/
111 #define GPU_framebuffer_ensure_config(_fb, ...) do { \
112         if (*(_fb) == NULL) { \
113                 *(_fb) = GPU_framebuffer_create(); \
114         } \
115         GPUAttachment config[] = __VA_ARGS__; \
116         GPU_framebuffer_config_array(*(_fb), config, (sizeof(config) / sizeof(GPUAttachment))); \
117 } while (0)
118
119 void GPU_framebuffer_config_array(GPUFrameBuffer *fb, const GPUAttachment *config, int config_len);
120
121 #define GPU_ATTACHMENT_NONE \
122         { .tex = NULL, .layer = -1, .mip = 0, }
123 #define GPU_ATTACHMENT_LEAVE \
124         { .tex = NULL, .layer = -1, .mip = -1, }
125 #define GPU_ATTACHMENT_TEXTURE(_tex) \
126         { .tex = _tex, .layer = -1, .mip = 0, }
127 #define GPU_ATTACHMENT_TEXTURE_MIP(_tex, _mip) \
128         { .tex = _tex, .layer = -1, .mip = _mip, }
129 #define GPU_ATTACHMENT_TEXTURE_LAYER(_tex, _layer) \
130         { .tex = _tex, .layer = _layer, .mip = 0, }
131 #define GPU_ATTACHMENT_TEXTURE_LAYER_MIP(_tex, _layer, _mip) \
132         { .tex = _tex, .layer = _layer, .mip = _mip, }
133 #define GPU_ATTACHMENT_TEXTURE_CUBEFACE(_tex, _face) \
134         { .tex = _tex, .layer = _face, .mip = 0, }
135 #define GPU_ATTACHMENT_TEXTURE_CUBEFACE_MIP(_tex, _face, _mip) \
136         { .tex = _tex, .layer = _face, .mip = _mip, }
137
138 /* Framebuffer operations */
139
140 void GPU_framebuffer_viewport_set(GPUFrameBuffer *fb, int x, int y, int w, int h);
141
142 void GPU_framebuffer_clear(
143         GPUFrameBuffer *fb, GPUFrameBufferBits buffers,
144         const float clear_col[4], float clear_depth, unsigned int clear_stencil);
145
146 #define GPU_framebuffer_clear_color(fb, col) \
147         GPU_framebuffer_clear(fb, GPU_COLOR_BIT, col, 0.0f, 0x00)
148
149 #define GPU_framebuffer_clear_depth(fb, depth) \
150         GPU_framebuffer_clear(fb, GPU_DEPTH_BIT, NULL, depth, 0x00)
151
152 #define GPU_framebuffer_clear_color_depth(fb, col, depth) \
153         GPU_framebuffer_clear(fb, GPU_COLOR_BIT | GPU_DEPTH_BIT, col, depth, 0x00)
154
155 #define GPU_framebuffer_clear_stencil(fb, stencil) \
156         GPU_framebuffer_clear(fb, GPU_STENCIL_BIT, NULL, 0.0f, stencil)
157
158 #define GPU_framebuffer_clear_depth_stencil(fb, depth, stencil) \
159         GPU_framebuffer_clear(fb, GPU_DEPTH_BIT | GPU_STENCIL_BIT, NULL, depth, stencil)
160
161 #define GPU_framebuffer_clear_color_depth_stencil(fb, col, depth, stencil) \
162         GPU_framebuffer_clear(fb, GPU_COLOR_BIT | GPU_DEPTH_BIT | GPU_STENCIL_BIT, col, depth, stencil)
163
164 void GPU_framebuffer_read_depth(GPUFrameBuffer *fb, int x, int y, int w, int h, float *data);
165 void GPU_framebuffer_read_color(
166         GPUFrameBuffer *fb, int x, int y, int w, int h, int channels, int slot, float *data);
167
168 void GPU_framebuffer_blit(
169         GPUFrameBuffer *fb_read, int read_slot,
170         GPUFrameBuffer *fb_write, int write_slot,
171         GPUFrameBufferBits blit_buffers);
172
173 void GPU_framebuffer_recursive_downsample(
174         GPUFrameBuffer *fb, int max_lvl,
175         void (*callback)(void *userData, int level), void *userData);
176
177 /* GPU OffScreen
178  * - wrapper around framebuffer and texture for simple offscreen drawing
179  */
180
181 GPUOffScreen *GPU_offscreen_create(
182         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 void GPU_clear_color(float red, float green, float blue, float alpha);
198 void GPU_clear(GPUFrameBufferBits flags);
199
200 #ifdef __cplusplus
201 }
202 #endif
203
204 #endif  /* __GPU_FRAMEBUFFER_H__ */