godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/scene/resources/sky_material.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

231 lines
7.1 KiB
C++
Raw Normal View History

One Copyright Update to rule them all 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".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* sky_material.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. */
/**************************************************************************/
Add shader based background mode
2019-09-15 09:58:38 +00:00
#ifndef SKY_MATERIAL_H
#define SKY_MATERIAL_H
Style: Cleanup header guards for consistency Fix file names for {Static,Lightmap}RaycasterEmbree.
2022-09-26 11:03:44 +00:00
#include "core/templates/rid.h"
#include "scene/resources/material.h"
Working sky shader implementation
2020-03-20 00:32:19 +00:00
class ProceduralSkyMaterial : public Material {
GDCLASS(ProceduralSkyMaterial, Material);
private:
Color sky_top_color;
Color sky_horizon_color;
Style: Partially apply clang-tidy's `cppcoreguidelines-pro-type-member-init` Didn't commit all the changes where it wants to initialize a struct with `{}`. Should be reviewed in a separate PR. Option `IgnoreArrays` enabled for now to be conservative, can be disabled to see if it proposes more useful changes. Also fixed manually a handful of other missing initializations / moved some from constructors.
2022-05-02 14:28:25 +00:00
float sky_curve = 0.0f;
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
float sky_energy_multiplier = 0.0f;
Add sky cover texture for ProceduralSkyMaterial This brings PhysicalSkyMaterial's Night Sky functionality to ProceduralSkyMaterial, but in a more powerful and general fashion. This can be used to display stars at night, or clouds at day and night. For clouds, it won't be physically accurate, but it can look good still. The Sky Cover Modulate property can be used to adjust the sky cover's colors and opacity in real-time, which is useful for day/night or weather transitions.
2022-02-12 17:38:05 +00:00
Ref<Texture2D> sky_cover;
Color sky_cover_modulate;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Color ground_bottom_color;
Color ground_horizon_color;
Style: Partially apply clang-tidy's `cppcoreguidelines-pro-type-member-init` Didn't commit all the changes where it wants to initialize a struct with `{}`. Should be reviewed in a separate PR. Option `IgnoreArrays` enabled for now to be conservative, can be disabled to see if it proposes more useful changes. Also fixed manually a handful of other missing initializations / moved some from constructors.
2022-05-02 14:28:25 +00:00
float ground_curve = 0.0f;
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
float ground_energy_multiplier = 0.0f;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Style: Partially apply clang-tidy's `cppcoreguidelines-pro-type-member-init` Didn't commit all the changes where it wants to initialize a struct with `{}`. Should be reviewed in a separate PR. Option `IgnoreArrays` enabled for now to be conservative, can be disabled to see if it proposes more useful changes. Also fixed manually a handful of other missing initializations / moved some from constructors.
2022-05-02 14:28:25 +00:00
float sun_angle_max = 0.0f;
float sun_curve = 0.0f;
Use IGN instead of white noise for sky dithering
2022-04-29 19:46:29 +00:00
bool use_debanding = true;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Make Sky initialize shaders only once * Create the shader on demand. * Makes sure compilation happens only once, then shader is cached. * Speeds up scene loading times. * Speeds up editor initialization.
2021-07-21 11:47:49 +00:00
static Mutex shader_mutex;
Move debanding into internal sky shader code so that it is applied after everything else. This ensures that the debanding does not scale with exposure or any other effect.
2022-09-13 17:39:04 +00:00
static RID shader_cache[2];
Make Sky initialize shaders only once * Create the shader on demand. * Makes sure compilation happens only once, then shader is cached. * Speeds up scene loading times. * Speeds up editor initialization.
2021-07-21 11:47:49 +00:00
static void _update_shader();
mutable bool shader_set = false;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
protected:
static void _bind_methods();
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
void _validate_property(PropertyInfo &property) const;
Add shader based background mode
2019-09-15 09:58:38 +00:00
public:
Working sky shader implementation
2020-03-20 00:32:19 +00:00
void set_sky_top_color(const Color &p_sky_top);
Color get_sky_top_color() const;
void set_sky_horizon_color(const Color &p_sky_horizon);
Color get_sky_horizon_color() const;
void set_sky_curve(float p_curve);
float get_sky_curve() const;
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
void set_sky_energy_multiplier(float p_multiplier);
float get_sky_energy_multiplier() const;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Add sky cover texture for ProceduralSkyMaterial This brings PhysicalSkyMaterial's Night Sky functionality to ProceduralSkyMaterial, but in a more powerful and general fashion. This can be used to display stars at night, or clouds at day and night. For clouds, it won't be physically accurate, but it can look good still. The Sky Cover Modulate property can be used to adjust the sky cover's colors and opacity in real-time, which is useful for day/night or weather transitions.
2022-02-12 17:38:05 +00:00
void set_sky_cover(const Ref<Texture2D> &p_sky_cover);
Ref<Texture2D> get_sky_cover() const;
void set_sky_cover_modulate(const Color &p_sky_cover_modulate);
Color get_sky_cover_modulate() const;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
void set_ground_bottom_color(const Color &p_ground_bottom);
Color get_ground_bottom_color() const;
void set_ground_horizon_color(const Color &p_ground_horizon);
Color get_ground_horizon_color() const;
void set_ground_curve(float p_curve);
float get_ground_curve() const;
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
void set_ground_energy_multiplier(float p_energy);
float get_ground_energy_multiplier() const;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
void set_sun_angle_max(float p_angle);
float get_sun_angle_max() const;
void set_sun_curve(float p_curve);
float get_sun_curve() const;
Use IGN instead of white noise for sky dithering
2022-04-29 19:46:29 +00:00
void set_use_debanding(bool p_use_debanding);
bool get_use_debanding() const;
Add dithering to ProceduralSkyMaterial to combat banding Dithering was already present in PhysicalSkyMaterial. This brings it to ProceduralSkyMaterial as well, with the same algorithm and default intensity.
2022-04-09 16:23:20 +00:00
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual Shader::Mode get_shader_mode() const override;
Added ability to visualize native shaders
2021-01-05 23:01:50 +00:00
virtual RID get_shader_rid() const override;
Make Sky initialize shaders only once * Create the shader on demand. * Makes sure compilation happens only once, then shader is cached. * Speeds up scene loading times. * Speeds up editor initialization.
2021-07-21 11:47:49 +00:00
virtual RID get_rid() const override;
static void cleanup_shader();
Working sky shader implementation
2020-03-20 00:32:19 +00:00
ProceduralSkyMaterial();
~ProceduralSkyMaterial();
};
//////////////////////////////////////////////////////
/* PanoramaSkyMaterial */
class PanoramaSkyMaterial : public Material {
GDCLASS(PanoramaSkyMaterial, Material);
Add shader based background mode
2019-09-15 09:58:38 +00:00
private:
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Ref<Texture2D> panorama;
Make Sky initialize shaders only once * Create the shader on demand. * Makes sure compilation happens only once, then shader is cached. * Speeds up scene loading times. * Speeds up editor initialization.
2021-07-21 11:47:49 +00:00
static Mutex shader_mutex;
Add shader cache and filter variable to PanoramaSkyMaterial
2022-01-15 01:42:25 +00:00
static RID shader_cache[2];
Make Sky initialize shaders only once * Create the shader on demand. * Makes sure compilation happens only once, then shader is cached. * Speeds up scene loading times. * Speeds up editor initialization.
2021-07-21 11:47:49 +00:00
static void _update_shader();
mutable bool shader_set = false;
Add shader based background mode
2019-09-15 09:58:38 +00:00
Add shader cache and filter variable to PanoramaSkyMaterial
2022-01-15 01:42:25 +00:00
bool filter = true;
Add shader based background mode
2019-09-15 09:58:38 +00:00
protected:
static void _bind_methods();
public:
Working sky shader implementation
2020-03-20 00:32:19 +00:00
void set_panorama(const Ref<Texture2D> &p_panorama);
Ref<Texture2D> get_panorama() const;
Add shader based background mode
2019-09-15 09:58:38 +00:00
Add shader cache and filter variable to PanoramaSkyMaterial
2022-01-15 01:42:25 +00:00
void set_filtering_enabled(bool p_enabled);
bool is_filtering_enabled() const;
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
void set_energy_multiplier(float p_multiplier);
float get_energy_multiplier() const;
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual Shader::Mode get_shader_mode() const override;
Added ability to visualize native shaders
2021-01-05 23:01:50 +00:00
virtual RID get_shader_rid() const override;
Make Sky initialize shaders only once * Create the shader on demand. * Makes sure compilation happens only once, then shader is cached. * Speeds up scene loading times. * Speeds up editor initialization.
2021-07-21 11:47:49 +00:00
virtual RID get_rid() const override;
static void cleanup_shader();
Add shader based background mode
2019-09-15 09:58:38 +00:00
Working sky shader implementation
2020-03-20 00:32:19 +00:00
PanoramaSkyMaterial();
~PanoramaSkyMaterial();
};
//////////////////////////////////////////////////////
/* PanoramaSkyMaterial */
class PhysicalSkyMaterial : public Material {
GDCLASS(PhysicalSkyMaterial, Material);
private:
Make Sky initialize shaders only once * Create the shader on demand. * Makes sure compilation happens only once, then shader is cached. * Speeds up scene loading times. * Speeds up editor initialization.
2021-07-21 11:47:49 +00:00
static Mutex shader_mutex;
Move debanding into internal sky shader code so that it is applied after everything else. This ensures that the debanding does not scale with exposure or any other effect.
2022-09-13 17:39:04 +00:00
static RID shader_cache[2];
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Style: Partially apply clang-tidy's `cppcoreguidelines-pro-type-member-init` Didn't commit all the changes where it wants to initialize a struct with `{}`. Should be reviewed in a separate PR. Option `IgnoreArrays` enabled for now to be conservative, can be disabled to see if it proposes more useful changes. Also fixed manually a handful of other missing initializations / moved some from constructors.
2022-05-02 14:28:25 +00:00
float rayleigh = 0.0f;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Color rayleigh_color;
Style: Partially apply clang-tidy's `cppcoreguidelines-pro-type-member-init` Didn't commit all the changes where it wants to initialize a struct with `{}`. Should be reviewed in a separate PR. Option `IgnoreArrays` enabled for now to be conservative, can be disabled to see if it proposes more useful changes. Also fixed manually a handful of other missing initializations / moved some from constructors.
2022-05-02 14:28:25 +00:00
float mie = 0.0f;
float mie_eccentricity = 0.0f;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Color mie_color;
Style: Partially apply clang-tidy's `cppcoreguidelines-pro-type-member-init` Didn't commit all the changes where it wants to initialize a struct with `{}`. Should be reviewed in a separate PR. Option `IgnoreArrays` enabled for now to be conservative, can be disabled to see if it proposes more useful changes. Also fixed manually a handful of other missing initializations / moved some from constructors.
2022-05-02 14:28:25 +00:00
float turbidity = 0.0f;
float sun_disk_scale = 0.0f;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Color ground_color;
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
float energy_multiplier = 1.0f;
Use IGN instead of white noise for sky dithering
2022-04-29 19:46:29 +00:00
bool use_debanding = true;
Add night sky to PhysicalSkyMaterial
2020-05-16 19:55:25 +00:00
Ref<Texture2D> night_sky;
Make Sky initialize shaders only once * Create the shader on demand. * Makes sure compilation happens only once, then shader is cached. * Speeds up scene loading times. * Speeds up editor initialization.
2021-07-21 11:47:49 +00:00
static void _update_shader();
mutable bool shader_set = false;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
protected:
static void _bind_methods();
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
void _validate_property(PropertyInfo &property) const;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
public:
void set_rayleigh_coefficient(float p_rayleigh);
float get_rayleigh_coefficient() const;
void set_rayleigh_color(Color p_rayleigh_color);
Color get_rayleigh_color() const;
void set_turbidity(float p_turbidity);
float get_turbidity() const;
void set_mie_coefficient(float p_mie);
float get_mie_coefficient() const;
void set_mie_eccentricity(float p_eccentricity);
float get_mie_eccentricity() const;
void set_mie_color(Color p_mie_color);
Color get_mie_color() const;
void set_sun_disk_scale(float p_sun_disk_scale);
float get_sun_disk_scale() const;
void set_ground_color(Color p_ground_color);
Color get_ground_color() const;
Implement Physical Light Units as an optional setting. This allows light sources to be specified in physical light units in addition to the regular energy multiplier. In order to avoid loss of precision at high values, brightness values are premultiplied by an exposure normalization value. In support of Physical Light Units this PR also renames CameraEffects to CameraAttributes.
2022-07-31 23:20:24 +00:00
void set_energy_multiplier(float p_multiplier);
float get_energy_multiplier() const;
void set_exposure_value(float p_exposure);
float get_exposure_value() const;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Use IGN instead of white noise for sky dithering
2022-04-29 19:46:29 +00:00
void set_use_debanding(bool p_use_debanding);
bool get_use_debanding() const;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
Add night sky to PhysicalSkyMaterial
2020-05-16 19:55:25 +00:00
void set_night_sky(const Ref<Texture2D> &p_night_sky);
Ref<Texture2D> get_night_sky() const;
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual Shader::Mode get_shader_mode() const override;
Added ability to visualize native shaders
2021-01-05 23:01:50 +00:00
virtual RID get_shader_rid() const override;
Add shader based background mode
2019-09-15 09:58:38 +00:00
Make Sky initialize shaders only once * Create the shader on demand. * Makes sure compilation happens only once, then shader is cached. * Speeds up scene loading times. * Speeds up editor initialization.
2021-07-21 11:47:49 +00:00
static void cleanup_shader();
virtual RID get_rid() const override;
Working sky shader implementation
2020-03-20 00:32:19 +00:00
PhysicalSkyMaterial();
~PhysicalSkyMaterial();
Add shader based background mode
2019-09-15 09:58:38 +00:00
};
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#endif // SKY_MATERIAL_H