1/**************************************************************************/
2/* renderer_gi.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef RENDERER_GI_H
32#define RENDERER_GI_H
33
34#include "servers/rendering_server.h"
35
36class RendererGI {
37public:
38 virtual ~RendererGI() {}
39
40 /* VOXEL GI API */
41
42 virtual RID voxel_gi_allocate() = 0;
43 virtual void voxel_gi_free(RID p_rid) = 0;
44 virtual void voxel_gi_initialize(RID p_rid) = 0;
45
46 virtual void voxel_gi_allocate_data(RID p_voxel_gi, const Transform3D &p_to_cell_xform, const AABB &p_aabb, const Vector3i &p_octree_size, const Vector<uint8_t> &p_octree_cells, const Vector<uint8_t> &p_data_cells, const Vector<uint8_t> &p_distance_field, const Vector<int> &p_level_counts) = 0;
47
48 virtual AABB voxel_gi_get_bounds(RID p_voxel_gi) const = 0;
49 virtual Vector3i voxel_gi_get_octree_size(RID p_voxel_gi) const = 0;
50 virtual Vector<uint8_t> voxel_gi_get_octree_cells(RID p_voxel_gi) const = 0;
51 virtual Vector<uint8_t> voxel_gi_get_data_cells(RID p_voxel_gi) const = 0;
52 virtual Vector<uint8_t> voxel_gi_get_distance_field(RID p_voxel_gi) const = 0;
53
54 virtual Vector<int> voxel_gi_get_level_counts(RID p_voxel_gi) const = 0;
55 virtual Transform3D voxel_gi_get_to_cell_xform(RID p_voxel_gi) const = 0;
56
57 virtual void voxel_gi_set_dynamic_range(RID p_voxel_gi, float p_range) = 0;
58 virtual float voxel_gi_get_dynamic_range(RID p_voxel_gi) const = 0;
59
60 virtual void voxel_gi_set_propagation(RID p_voxel_gi, float p_range) = 0;
61 virtual float voxel_gi_get_propagation(RID p_voxel_gi) const = 0;
62
63 virtual void voxel_gi_set_energy(RID p_voxel_gi, float p_energy) = 0;
64 virtual float voxel_gi_get_energy(RID p_voxel_gi) const = 0;
65
66 virtual void voxel_gi_set_baked_exposure_normalization(RID p_voxel_gi, float p_baked_exposure) = 0;
67 virtual float voxel_gi_get_baked_exposure_normalization(RID p_voxel_gi) const = 0;
68
69 virtual void voxel_gi_set_bias(RID p_voxel_gi, float p_bias) = 0;
70 virtual float voxel_gi_get_bias(RID p_voxel_gi) const = 0;
71
72 virtual void voxel_gi_set_normal_bias(RID p_voxel_gi, float p_range) = 0;
73 virtual float voxel_gi_get_normal_bias(RID p_voxel_gi) const = 0;
74
75 virtual void voxel_gi_set_interior(RID p_voxel_gi, bool p_enable) = 0;
76 virtual bool voxel_gi_is_interior(RID p_voxel_gi) const = 0;
77
78 virtual void voxel_gi_set_use_two_bounces(RID p_voxel_gi, bool p_enable) = 0;
79 virtual bool voxel_gi_is_using_two_bounces(RID p_voxel_gi) const = 0;
80
81 virtual uint32_t voxel_gi_get_version(RID p_probe) const = 0;
82};
83
84#endif // RENDERER_GI_H
85