93f1bc649228e7bb4b12c7bfd4cb7b1291ec67d5
[blender.git] / source / blender / gpu / GPU_compositing.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): Antony Riakiotakis.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file GPU_compositing.h
29  *  \ingroup gpu
30  */
31
32 #ifndef __GPU_COMPOSITING_H__
33 #define __GPU_COMPOSITING_H__
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /* opaque handle for framebuffer compositing effects (defined in gpu_compositing.c )*/
40 typedef struct GPUFX GPUFX;
41 struct GPUDOFSettings;
42 struct GPUSSAOSettings;
43 struct GPUOffScreen;
44 struct GPUFXSettings;
45 struct RegionView3D;
46 struct rcti;
47 struct Scene;
48 struct View3D;
49 enum eGPUFXFlags;
50
51 /**** Public API *****/
52
53 typedef enum GPUFXShaderEffect {
54         /* Screen space ambient occlusion shader */
55         GPU_SHADER_FX_SSAO           = 1,
56
57         /* depth of field passes. Yep, quite a complex effect */
58         GPU_SHADER_FX_DEPTH_OF_FIELD_PASS_ONE = 2,
59         GPU_SHADER_FX_DEPTH_OF_FIELD_PASS_TWO = 3,
60         GPU_SHADER_FX_DEPTH_OF_FIELD_PASS_THREE = 4,
61         GPU_SHADER_FX_DEPTH_OF_FIELD_PASS_FOUR = 5,
62         GPU_SHADER_FX_DEPTH_OF_FIELD_PASS_FIVE = 6,
63
64         GPU_SHADER_FX_DEPTH_RESOLVE = 7,
65 } GPUFXShaderEffect;
66
67 /* keep in synch with enum above! */
68 #define MAX_FX_SHADERS 8
69
70 /* generate a new FX compositor */
71 GPUFX *GPU_fx_compositor_create(void);
72
73 /* destroy a text compositor */
74 void GPU_fx_compositor_destroy(GPUFX *fx);
75
76 /* initialize a framebuffer with size taken from the viewport */
77 bool GPU_fx_compositor_initialize_passes(
78         GPUFX *fx, const struct rcti *rect, const struct rcti *scissor_rect,
79         const struct GPUFXSettings *fx_settings);
80
81 /* do compositing on the fx passes that have been initialized */
82 bool GPU_fx_do_composite_pass(GPUFX *fx, float projmat[4][4], bool is_persp, struct Scene *scene, struct GPUOffScreen *ofs);
83
84 /* bind new depth buffer for XRay pass */
85 void GPU_fx_compositor_setup_XRay_pass(GPUFX *fx, bool do_xray);
86
87 /* resolve a final depth buffer by compositing the XRay and normal depth buffers */
88 void GPU_fx_compositor_XRay_resolve(GPUFX *fx);
89
90 void GPU_fx_compositor_init_dof_settings(struct GPUDOFSettings *dof);
91 void GPU_fx_compositor_init_ssao_settings(struct GPUSSAOSettings *ssao);
92 #ifdef __cplusplus
93 }
94 #endif
95
96 #endif // __GPU_COMPOSITING_H__