d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
192 lines
11 KiB
C++
192 lines
11 KiB
C++
/**************************************************************************/
|
|
/* light_storage.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef LIGHT_STORAGE_H
|
|
#define LIGHT_STORAGE_H
|
|
|
|
#include "render_scene_buffers.h"
|
|
#include "servers/rendering_server.h"
|
|
|
|
class RendererLightStorage {
|
|
public:
|
|
virtual ~RendererLightStorage() {}
|
|
|
|
/* Light API */
|
|
|
|
virtual RID directional_light_allocate() = 0;
|
|
virtual void directional_light_initialize(RID p_rid) = 0;
|
|
|
|
virtual RID omni_light_allocate() = 0;
|
|
virtual void omni_light_initialize(RID p_rid) = 0;
|
|
|
|
virtual RID spot_light_allocate() = 0;
|
|
virtual void spot_light_initialize(RID p_rid) = 0;
|
|
|
|
virtual void light_free(RID p_rid) = 0;
|
|
|
|
virtual void light_set_color(RID p_light, const Color &p_color) = 0;
|
|
virtual void light_set_param(RID p_light, RS::LightParam p_param, float p_value) = 0;
|
|
virtual void light_set_shadow(RID p_light, bool p_enabled) = 0;
|
|
virtual void light_set_projector(RID p_light, RID p_texture) = 0;
|
|
virtual void light_set_negative(RID p_light, bool p_enable) = 0;
|
|
virtual void light_set_cull_mask(RID p_light, uint32_t p_mask) = 0;
|
|
virtual void light_set_distance_fade(RID p_light, bool p_enabled, float p_begin, float p_shadow, float p_length) = 0;
|
|
virtual void light_set_reverse_cull_face_mode(RID p_light, bool p_enabled) = 0;
|
|
virtual void light_set_bake_mode(RID p_light, RS::LightBakeMode p_bake_mode) = 0;
|
|
virtual void light_set_max_sdfgi_cascade(RID p_light, uint32_t p_cascade) = 0;
|
|
|
|
virtual void light_omni_set_shadow_mode(RID p_light, RS::LightOmniShadowMode p_mode) = 0;
|
|
|
|
virtual void light_directional_set_shadow_mode(RID p_light, RS::LightDirectionalShadowMode p_mode) = 0;
|
|
virtual void light_directional_set_blend_splits(RID p_light, bool p_enable) = 0;
|
|
virtual bool light_directional_get_blend_splits(RID p_light) const = 0;
|
|
virtual void light_directional_set_sky_mode(RID p_light, RS::LightDirectionalSkyMode p_mode) = 0;
|
|
virtual RS::LightDirectionalSkyMode light_directional_get_sky_mode(RID p_light) const = 0;
|
|
|
|
virtual RS::LightDirectionalShadowMode light_directional_get_shadow_mode(RID p_light) = 0;
|
|
virtual RS::LightOmniShadowMode light_omni_get_shadow_mode(RID p_light) = 0;
|
|
|
|
virtual bool light_has_shadow(RID p_light) const = 0;
|
|
|
|
virtual bool light_has_projector(RID p_light) const = 0;
|
|
|
|
virtual RS::LightType light_get_type(RID p_light) const = 0;
|
|
virtual AABB light_get_aabb(RID p_light) const = 0;
|
|
virtual float light_get_param(RID p_light, RS::LightParam p_param) = 0;
|
|
virtual Color light_get_color(RID p_light) = 0;
|
|
virtual RS::LightBakeMode light_get_bake_mode(RID p_light) = 0;
|
|
virtual uint32_t light_get_max_sdfgi_cascade(RID p_light) = 0;
|
|
virtual uint64_t light_get_version(RID p_light) const = 0;
|
|
|
|
/* LIGHT INSTANCE API */
|
|
|
|
virtual RID light_instance_create(RID p_light) = 0;
|
|
virtual void light_instance_free(RID p_light_instance) = 0;
|
|
virtual void light_instance_set_transform(RID p_light_instance, const Transform3D &p_transform) = 0;
|
|
virtual void light_instance_set_aabb(RID p_light_instance, const AABB &p_aabb) = 0;
|
|
virtual void light_instance_set_shadow_transform(RID p_light_instance, const Projection &p_projection, const Transform3D &p_transform, float p_far, float p_split, int p_pass, float p_shadow_texel_size, float p_bias_scale = 1.0, float p_range_begin = 0, const Vector2 &p_uv_scale = Vector2()) = 0;
|
|
virtual void light_instance_mark_visible(RID p_light_instance) = 0;
|
|
virtual bool light_instances_can_render_shadow_cube() const {
|
|
return true;
|
|
}
|
|
|
|
/* PROBE API */
|
|
|
|
virtual RID reflection_probe_allocate() = 0;
|
|
virtual void reflection_probe_initialize(RID p_rid) = 0;
|
|
virtual void reflection_probe_free(RID p_rid) = 0;
|
|
|
|
virtual void reflection_probe_set_update_mode(RID p_probe, RS::ReflectionProbeUpdateMode p_mode) = 0;
|
|
virtual void reflection_probe_set_resolution(RID p_probe, int p_resolution) = 0;
|
|
virtual void reflection_probe_set_intensity(RID p_probe, float p_intensity) = 0;
|
|
virtual void reflection_probe_set_ambient_mode(RID p_probe, RS::ReflectionProbeAmbientMode p_mode) = 0;
|
|
virtual void reflection_probe_set_ambient_color(RID p_probe, const Color &p_color) = 0;
|
|
virtual void reflection_probe_set_ambient_energy(RID p_probe, float p_energy) = 0;
|
|
virtual void reflection_probe_set_max_distance(RID p_probe, float p_distance) = 0;
|
|
virtual void reflection_probe_set_extents(RID p_probe, const Vector3 &p_extents) = 0;
|
|
virtual void reflection_probe_set_origin_offset(RID p_probe, const Vector3 &p_offset) = 0;
|
|
virtual void reflection_probe_set_as_interior(RID p_probe, bool p_enable) = 0;
|
|
virtual void reflection_probe_set_enable_box_projection(RID p_probe, bool p_enable) = 0;
|
|
virtual void reflection_probe_set_enable_shadows(RID p_probe, bool p_enable) = 0;
|
|
virtual void reflection_probe_set_cull_mask(RID p_probe, uint32_t p_layers) = 0;
|
|
virtual void reflection_probe_set_mesh_lod_threshold(RID p_probe, float p_ratio) = 0;
|
|
|
|
virtual AABB reflection_probe_get_aabb(RID p_probe) const = 0;
|
|
virtual RS::ReflectionProbeUpdateMode reflection_probe_get_update_mode(RID p_probe) const = 0;
|
|
virtual uint32_t reflection_probe_get_cull_mask(RID p_probe) const = 0;
|
|
virtual Vector3 reflection_probe_get_extents(RID p_probe) const = 0;
|
|
virtual Vector3 reflection_probe_get_origin_offset(RID p_probe) const = 0;
|
|
virtual float reflection_probe_get_origin_max_distance(RID p_probe) const = 0;
|
|
virtual bool reflection_probe_renders_shadows(RID p_probe) const = 0;
|
|
virtual float reflection_probe_get_mesh_lod_threshold(RID p_probe) const = 0;
|
|
|
|
/* REFLECTION ATLAS */
|
|
|
|
virtual RID reflection_atlas_create() = 0;
|
|
virtual void reflection_atlas_free(RID p_ref_atlas) = 0;
|
|
virtual void reflection_atlas_set_size(RID p_ref_atlas, int p_reflection_size, int p_reflection_count) = 0;
|
|
virtual int reflection_atlas_get_size(RID p_ref_atlas) const = 0;
|
|
|
|
/* REFLECTION PROBE INSTANCE */
|
|
|
|
virtual RID reflection_probe_instance_create(RID p_probe) = 0;
|
|
virtual void reflection_probe_instance_free(RID p_instance) = 0;
|
|
virtual void reflection_probe_instance_set_transform(RID p_instance, const Transform3D &p_transform) = 0;
|
|
virtual void reflection_probe_release_atlas_index(RID p_instance) = 0;
|
|
virtual bool reflection_probe_instance_needs_redraw(RID p_instance) = 0;
|
|
virtual bool reflection_probe_instance_has_reflection(RID p_instance) = 0;
|
|
virtual bool reflection_probe_instance_begin_render(RID p_instance, RID p_reflection_atlas) = 0;
|
|
virtual Ref<RenderSceneBuffers> reflection_probe_atlas_get_render_buffers(RID p_reflection_atlas) = 0;
|
|
virtual bool reflection_probe_instance_postprocess_step(RID p_instance) = 0;
|
|
|
|
/* LIGHTMAP */
|
|
|
|
virtual RID lightmap_allocate() = 0;
|
|
virtual void lightmap_initialize(RID p_rid) = 0;
|
|
virtual void lightmap_free(RID p_rid) = 0;
|
|
|
|
virtual void lightmap_set_textures(RID p_lightmap, RID p_light, bool p_uses_spherical_haromics) = 0;
|
|
virtual void lightmap_set_probe_bounds(RID p_lightmap, const AABB &p_bounds) = 0;
|
|
virtual void lightmap_set_probe_interior(RID p_lightmap, bool p_interior) = 0;
|
|
virtual void lightmap_set_probe_capture_data(RID p_lightmap, const PackedVector3Array &p_points, const PackedColorArray &p_point_sh, const PackedInt32Array &p_tetrahedra, const PackedInt32Array &p_bsp_tree) = 0;
|
|
virtual void lightmap_set_baked_exposure_normalization(RID p_lightmap, float p_exposure) = 0;
|
|
virtual PackedVector3Array lightmap_get_probe_capture_points(RID p_lightmap) const = 0;
|
|
virtual PackedColorArray lightmap_get_probe_capture_sh(RID p_lightmap) const = 0;
|
|
virtual PackedInt32Array lightmap_get_probe_capture_tetrahedra(RID p_lightmap) const = 0;
|
|
virtual PackedInt32Array lightmap_get_probe_capture_bsp_tree(RID p_lightmap) const = 0;
|
|
virtual AABB lightmap_get_aabb(RID p_lightmap) const = 0;
|
|
virtual void lightmap_tap_sh_light(RID p_lightmap, const Vector3 &p_point, Color *r_sh) = 0;
|
|
virtual bool lightmap_is_interior(RID p_lightmap) const = 0;
|
|
virtual void lightmap_set_probe_capture_update_speed(float p_speed) = 0;
|
|
virtual float lightmap_get_probe_capture_update_speed() const = 0;
|
|
|
|
/* LIGHTMAP INSTANCE */
|
|
|
|
virtual RID lightmap_instance_create(RID p_lightmap) = 0;
|
|
virtual void lightmap_instance_free(RID p_lightmap) = 0;
|
|
virtual void lightmap_instance_set_transform(RID p_lightmap, const Transform3D &p_transform) = 0;
|
|
|
|
/* SHADOW ATLAS */
|
|
|
|
virtual RID shadow_atlas_create() = 0;
|
|
virtual void shadow_atlas_free(RID p_atlas) = 0;
|
|
|
|
virtual void shadow_atlas_set_size(RID p_atlas, int p_size, bool p_use_16_bits = true) = 0;
|
|
virtual void shadow_atlas_set_quadrant_subdivision(RID p_atlas, int p_quadrant, int p_subdivision) = 0;
|
|
virtual bool shadow_atlas_update_light(RID p_atlas, RID p_light_intance, float p_coverage, uint64_t p_light_version) = 0;
|
|
|
|
virtual void shadow_atlas_update(RID p_atlas) = 0;
|
|
|
|
virtual void directional_shadow_atlas_set_size(int p_size, bool p_16_bits = true) = 0;
|
|
virtual int get_directional_light_shadow_size(RID p_light_intance) = 0;
|
|
virtual void set_directional_shadow_count(int p_count) = 0;
|
|
};
|
|
|
|
#endif // LIGHT_STORAGE_H
|