Fix paint curve not drawing selection colors properly
[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) \
67   do { \
68     if (fb != NULL) { \
69       GPU_framebuffer_free(fb); \
70       fb = NULL; \
71     } \
72   } while (0)
73
74 /* Framebuffer setup : You need to call GPU_framebuffer_bind for theses
75  * to be effective. */
76
77 void GPU_framebuffer_texture_attach(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(GPUFrameBuffer *fb, struct GPUTexture *tex, int type);
84
85 /**
86  * How to use #GPU_framebuffer_ensure_config().
87  *
88  * Example:
89  * \code{.c}
90  * GPU_framebuffer_ensure_config(&fb, {
91  *         GPU_ATTACHMENT_TEXTURE(depth), // must be depth buffer
92  *         GPU_ATTACHMENT_TEXTURE(tex1),
93  *         GPU_ATTACHMENT_TEXTURE_CUBEFACE(tex2, 0),
94  *         GPU_ATTACHMENT_TEXTURE_LAYER_MIP(tex2, 0, 0)
95  * })
96  * \encode
97  *
98  * \note Unspecified attachments (i.e: those beyond the last
99  * GPU_ATTACHMENT_* in GPU_framebuffer_ensure_config list) are left unchanged.
100  *
101  * \note Make sure that the dimensions of your textures matches
102  * otherwise you will have an invalid framebuffer error.
103  */
104 #define GPU_framebuffer_ensure_config(_fb, ...) \
105   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   { \
117     .tex = NULL, .layer = -1, .mip = 0, \
118   }
119 #define GPU_ATTACHMENT_LEAVE \
120   { \
121     .tex = NULL, .layer = -1, .mip = -1, \
122   }
123 #define GPU_ATTACHMENT_TEXTURE(_tex) \
124   { \
125     .tex = _tex, .layer = -1, .mip = 0, \
126   }
127 #define GPU_ATTACHMENT_TEXTURE_MIP(_tex, _mip) \
128   { \
129     .tex = _tex, .layer = -1, .mip = _mip, \
130   }
131 #define GPU_ATTACHMENT_TEXTURE_LAYER(_tex, _layer) \
132   { \
133     .tex = _tex, .layer = _layer, .mip = 0, \
134   }
135 #define GPU_ATTACHMENT_TEXTURE_LAYER_MIP(_tex, _layer, _mip) \
136   { \
137     .tex = _tex, .layer = _layer, .mip = _mip, \
138   }
139 #define GPU_ATTACHMENT_TEXTURE_CUBEFACE(_tex, _face) \
140   { \
141     .tex = _tex, .layer = _face, .mip = 0, \
142   }
143 #define GPU_ATTACHMENT_TEXTURE_CUBEFACE_MIP(_tex, _face, _mip) \
144   { \
145     .tex = _tex, .layer = _face, .mip = _mip, \
146   }
147
148 /* Framebuffer operations */
149
150 void GPU_framebuffer_viewport_set(GPUFrameBuffer *fb, int x, int y, int w, int h);
151
152 void GPU_framebuffer_clear(GPUFrameBuffer *fb,
153                            eGPUFrameBufferBits buffers,
154                            const float clear_col[4],
155                            float clear_depth,
156                            unsigned int clear_stencil);
157
158 #define GPU_framebuffer_clear_color(fb, col) \
159   GPU_framebuffer_clear(fb, GPU_COLOR_BIT, col, 0.0f, 0x00)
160
161 #define GPU_framebuffer_clear_depth(fb, depth) \
162   GPU_framebuffer_clear(fb, GPU_DEPTH_BIT, NULL, depth, 0x00)
163
164 #define GPU_framebuffer_clear_color_depth(fb, col, depth) \
165   GPU_framebuffer_clear(fb, GPU_COLOR_BIT | GPU_DEPTH_BIT, col, depth, 0x00)
166
167 #define GPU_framebuffer_clear_stencil(fb, stencil) \
168   GPU_framebuffer_clear(fb, GPU_STENCIL_BIT, NULL, 0.0f, stencil)
169
170 #define GPU_framebuffer_clear_depth_stencil(fb, depth, stencil) \
171   GPU_framebuffer_clear(fb, GPU_DEPTH_BIT | GPU_STENCIL_BIT, NULL, depth, stencil)
172
173 #define GPU_framebuffer_clear_color_depth_stencil(fb, col, depth, stencil) \
174   GPU_framebuffer_clear(fb, GPU_COLOR_BIT | GPU_DEPTH_BIT | GPU_STENCIL_BIT, col, depth, stencil)
175
176 void GPU_framebuffer_read_depth(GPUFrameBuffer *fb, int x, int y, int w, int h, float *data);
177 void GPU_framebuffer_read_color(
178     GPUFrameBuffer *fb, int x, int y, int w, int h, int channels, int slot, float *data);
179
180 void GPU_framebuffer_blit(GPUFrameBuffer *fb_read,
181                           int read_slot,
182                           GPUFrameBuffer *fb_write,
183                           int write_slot,
184                           eGPUFrameBufferBits blit_buffers);
185
186 void GPU_framebuffer_recursive_downsample(GPUFrameBuffer *fb,
187                                           int max_lvl,
188                                           void (*callback)(void *userData, int level),
189                                           void *userData);
190
191 /* GPU OffScreen
192  * - wrapper around framebuffer and texture for simple offscreen drawing
193  */
194
195 GPUOffScreen *GPU_offscreen_create(
196     int width, int height, int samples, bool depth, bool high_bitdepth, char err_out[256]);
197 void GPU_offscreen_free(GPUOffScreen *ofs);
198 void GPU_offscreen_bind(GPUOffScreen *ofs, bool save);
199 void GPU_offscreen_unbind(GPUOffScreen *ofs, bool restore);
200 void GPU_offscreen_read_pixels(GPUOffScreen *ofs, int type, void *pixels);
201 void GPU_offscreen_draw_to_screen(GPUOffScreen *ofs, int x, int y);
202 int GPU_offscreen_width(const GPUOffScreen *ofs);
203 int GPU_offscreen_height(const GPUOffScreen *ofs);
204 struct GPUTexture *GPU_offscreen_color_texture(const GPUOffScreen *ofs);
205
206 void GPU_offscreen_viewport_data_get(GPUOffScreen *ofs,
207                                      GPUFrameBuffer **r_fb,
208                                      struct GPUTexture **r_color,
209                                      struct GPUTexture **r_depth);
210
211 void GPU_clear_color(float red, float green, float blue, float alpha);
212 void GPU_clear_depth(float depth);
213 void GPU_clear(eGPUFrameBufferBits flags);
214
215 #ifdef __cplusplus
216 }
217 #endif
218
219 #endif /* __GPU_FRAMEBUFFER_H__ */