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 typedef struct GPUFrameBuffer GPUFrameBuffer;
40 typedef struct GPUOffScreen GPUOffScreen;
41 struct GPUTexture;
42
43 /* GPU Framebuffer
44  * - this is a wrapper for an OpenGL framebuffer object (FBO). in practice
45  *   multiple FBO's may be created, to get around limitations on the number
46  *   of attached textures and the dimension requirements.
47  * - after any of the GPU_framebuffer_* functions, GPU_framebuffer_restore must
48  *   be called before rendering to the window framebuffer again */
49
50 void GPU_texture_bind_as_framebuffer(struct GPUTexture *tex);
51
52 GPUFrameBuffer *GPU_framebuffer_create(void);
53 int GPU_framebuffer_texture_attach(GPUFrameBuffer *fb, struct GPUTexture *tex, int slot, char err_out[256]);
54 void GPU_framebuffer_texture_detach(struct GPUTexture *tex);
55 void GPU_framebuffer_slots_bind(GPUFrameBuffer *fb, int slot);
56 void GPU_framebuffer_texture_unbind(GPUFrameBuffer *fb, struct GPUTexture *tex);
57 void GPU_framebuffer_free(GPUFrameBuffer *fb);
58 bool GPU_framebuffer_check_valid(GPUFrameBuffer *fb, char err_out[256]);
59
60 void GPU_framebuffer_bind_no_save(GPUFrameBuffer *fb, int slot);
61
62 bool GPU_framebuffer_bound(GPUFrameBuffer *fb);
63
64 void GPU_framebuffer_restore(void);
65 void GPU_framebuffer_blur(
66         GPUFrameBuffer *fb, struct GPUTexture *tex,
67         GPUFrameBuffer *blurfb, struct GPUTexture *blurtex);
68
69 /* GPU OffScreen
70  * - wrapper around framebuffer and texture for simple offscreen drawing
71  * - changes size if graphics card can't support it */
72
73 GPUOffScreen *GPU_offscreen_create(int width, int height, int samples, char err_out[256]);
74 void GPU_offscreen_free(GPUOffScreen *ofs);
75 void GPU_offscreen_bind(GPUOffScreen *ofs, bool save);
76 void GPU_offscreen_unbind(GPUOffScreen *ofs, bool restore);
77 void GPU_offscreen_read_pixels(GPUOffScreen *ofs, int type, void *pixels);
78 int GPU_offscreen_width(const GPUOffScreen *ofs);
79 int GPU_offscreen_height(const GPUOffScreen *ofs);
80 int GPU_offscreen_color_texture(const GPUOffScreen *ofs);
81
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif  /* __GPU_FRAMEBUFFER_H__ */