godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/servers/rendering/renderer_rd/environment/sky.h

325 lines
11 KiB
C++
Raw Normal View History

Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
/*************************************************************************/
Move Sky(RD) into environment Move Fog logic from render scene render to fog
2022-07-19 04:17:58 +00:00
/* sky.h */
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
Update copyright statements to 2022 Happy new year to the wonderful Godot community!
2022-01-03 20:27:34 +00:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
/* */
/* 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. */
/*************************************************************************/
Move Sky(RD) into environment Move Fog logic from render scene render to fog
2022-07-19 04:17:58 +00:00
#ifndef SKY_RD_H
#define SKY_RD_H
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
#include "core/templates/rid_owner.h"
#include "servers/rendering/renderer_compositor.h"
Split dependency logic Split FOG Split visibility notifier Final cleanup of storage classes
2022-06-21 00:08:33 +00:00
#include "servers/rendering/renderer_rd/pipeline_cache_rd.h"
Move Sky(RD) into environment Move Fog logic from render scene render to fog
2022-07-19 04:17:58 +00:00
#include "servers/rendering/renderer_rd/shaders/environment/sky.glsl.gen.h"
Split dependency logic Split FOG Split visibility notifier Final cleanup of storage classes
2022-06-21 00:08:33 +00:00
#include "servers/rendering/renderer_rd/storage_rd/material_storage.h"
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
#include "servers/rendering/renderer_scene_render.h"
#include "servers/rendering/rendering_device.h"
Split dependency logic Split FOG Split visibility notifier Final cleanup of storage classes
2022-06-21 00:08:33 +00:00
#include "servers/rendering/shader_compiler.h"
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
// Forward declare RendererSceneRenderRD so we can pass it into some of our methods, these classes are pretty tightly bound
class RendererSceneRenderRD;
Move Sky(RD) into environment Move Fog logic from render scene render to fog
2022-07-19 04:17:58 +00:00
namespace RendererRD {
class SkyRD {
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
public:
enum SkySet {
SKY_SET_UNIFORMS,
SKY_SET_MATERIAL,
SKY_SET_TEXTURES,
SKY_SET_FOG,
SKY_SET_MAX
};
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
// Skys need less info from Directional Lights than the normal shaders
struct SkyDirectionalLightData {
float direction[3];
float energy;
float color[3];
float size;
uint32_t enabled;
uint32_t pad[3];
};
private:
Porting cubemap compute shaders to raster for the mobile renderer
2021-07-27 13:33:47 +00:00
RD::DataFormat texture_format = RD::DATA_FORMAT_R16G16B16A16_SFLOAT;
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
RID index_buffer;
RID index_array;
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
enum SkyTextureSetVersion {
SKY_TEXTURE_SET_BACKGROUND,
SKY_TEXTURE_SET_HALF_RES,
SKY_TEXTURE_SET_QUARTER_RES,
SKY_TEXTURE_SET_CUBEMAP,
SKY_TEXTURE_SET_CUBEMAP_HALF_RES,
SKY_TEXTURE_SET_CUBEMAP_QUARTER_RES,
SKY_TEXTURE_SET_MAX
};
enum SkyVersion {
SKY_VERSION_BACKGROUND,
SKY_VERSION_HALF_RES,
SKY_VERSION_QUARTER_RES,
SKY_VERSION_CUBEMAP,
SKY_VERSION_CUBEMAP_HALF_RES,
SKY_VERSION_CUBEMAP_QUARTER_RES,
Add stereoscopic rendering through multiview
2021-05-07 13:19:04 +00:00
SKY_VERSION_BACKGROUND_MULTIVIEW,
SKY_VERSION_HALF_RES_MULTIVIEW,
SKY_VERSION_QUARTER_RES_MULTIVIEW,
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
SKY_VERSION_MAX
};
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
struct SkyPushConstant {
float orientation[12]; // 48 - 48
float projections[RendererSceneRender::MAX_RENDER_VIEWS][4]; // 2 x 16 - 80
float position[3]; // 12 - 92
float multiplier; // 4 - 96
float time; // 4 - 100
Scale color output in the mobile renderer to provide HDR support
2021-07-26 11:31:15 +00:00
float luminance_multiplier; // 4 - 104
float pad[2]; // 8 - 112 // Using pad to align on 16 bytes
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
// 128 is the max size of a push constant. We can replace "pad" but we can't add any more.
};
Extract global variable, shader and material storage
2022-03-21 11:25:25 +00:00
struct SkyShaderData : public RendererRD::ShaderData {
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
bool valid = false;
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
RID version;
PipelineCacheRD pipelines[SKY_VERSION_MAX];
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<StringName, ShaderLanguage::ShaderNode::Uniform> uniforms;
New OpenGL batching canvas renderer
2021-11-16 15:25:42 +00:00
Vector<ShaderCompiler::GeneratedCode::Texture> texture_uniforms;
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
Vector<uint32_t> ubo_offsets;
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
uint32_t ubo_size = 0;
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
String path;
String code;
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
HashMap<StringName, HashMap<int, RID>> default_texture_params;
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +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
bool uses_time = false;
bool uses_position = false;
bool uses_half_res = false;
bool uses_quarter_res = false;
bool uses_light = false;
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
virtual void set_code(const String &p_Code);
Clean up Shader Preprocessor * Moved preprocessor to Shader and ShaderInclude * Clean up RenderingServer side * Preprocessor is separate from parser now, but it emits tokens with include location hints. * Improved ShaderEditor validation code * Added include file code completion * Added notification for all files affected by a broken include.
2022-06-29 09:31:18 +00:00
virtual void set_path_hint(const String &p_hint);
Fix default_texture_param in shader pipeline to support uniform arrays
2021-10-17 11:38:26 +00:00
virtual void set_default_texture_param(const StringName &p_name, RID p_texture, int p_index);
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
virtual void get_param_list(List<PropertyInfo> *p_param_list) const;
Extract global variable, shader and material storage
2022-03-21 11:25:25 +00:00
virtual void get_instance_param_list(List<RendererMaterialStorage::InstanceShaderParam> *p_param_list) const;
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
virtual bool is_param_texture(const StringName &p_param) const;
virtual bool is_animated() const;
virtual bool casts_shadows() const;
virtual Variant get_default_parameter(const StringName &p_parameter) const;
virtual RS::ShaderNativeSourceCode get_native_source_code() const;
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
SkyShaderData() {}
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
virtual ~SkyShaderData();
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
};
Implement Vector4, Vector4i, Projection Implement built-in classes Vector4, Vector4i and Projection. * Two versions of Vector4 (float and integer). * A Projection class, which is a 4x4 matrix specialized in projection types. These types have been requested for a long time, but given they were very corner case they were not added before. Because in Godot 4, reimplementing parts of the rendering engine is now possible, access to these types (heavily used by the rendering code) becomes a necessity. **Q**: Why Projection and not Matrix4? **A**: Godot does not use Matrix2, Matrix3, Matrix4x3, etc. naming convention because, within the engine, these types always have a *purpose*. As such, Godot names them: Transform2D, Transform3D or Basis. In this case, this 4x4 matrix is _always_ used as a _Projection_, hence the naming.
2022-07-19 23:11:13 +00:00
void _render_sky(RD::DrawListID p_list, float p_time, RID p_fb, PipelineCacheRD *p_pipeline, RID p_uniform_set, RID p_texture_set, uint32_t p_view_count, const Projection *p_projections, const Basis &p_orientation, float p_multiplier, const Vector3 &p_position, float p_luminance_multiplier);
Move render_sky logic from effects into our sky object, and some minor cleanup
2021-06-22 06:24:09 +00:00
public:
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
struct SkySceneState {
struct UBO {
uint32_t volumetric_fog_enabled;
float volumetric_fog_inv_length;
float volumetric_fog_detail_spread;
float fog_aerial_perspective;
float fog_light_color[3];
float fog_sun_scatter;
uint32_t fog_enabled;
float fog_density;
float z_far;
uint32_t directional_light_count;
};
UBO ubo;
Zero initialize all pointer class and struct members This prevents the pitfall of UB when checking if they have been assigned something valid by comparing to nullptr.
2022-04-04 13:06:57 +00:00
SkyDirectionalLightData *directional_lights = nullptr;
SkyDirectionalLightData *last_frame_directional_lights = nullptr;
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
uint32_t max_directional_lights;
uint32_t last_frame_directional_light_count;
RID directional_light_buffer;
RID uniform_set;
RID uniform_buffer;
RID fog_uniform_set;
RID default_fog_uniform_set;
RID fog_shader;
RID fog_material;
RID fog_only_texture_uniform_set;
} sky_scene_state;
struct ReflectionData {
struct Layer {
struct Mipmap {
RID framebuffers[6];
RID views[6];
Size2i size;
};
Vector<Mipmap> mipmaps; //per-face view
Vector<RID> views; // per-cubemap view
};
struct DownsampleLayer {
struct Mipmap {
RID view;
Size2i size;
Porting cubemap compute shaders to raster for the mobile renderer
2021-07-27 13:33:47 +00:00
// for mobile only
RID views[6];
RID framebuffers[6];
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
};
Vector<Mipmap> mipmaps;
};
RID radiance_base_cubemap; //cubemap for first layer, first cubemap
RID downsampled_radiance_cubemap;
DownsampleLayer downsampled_layer;
RID coefficient_buffer;
bool dirty = true;
Vector<Layer> layers;
void clear_reflection_data();
Split dependency logic Split FOG Split visibility notifier Final cleanup of storage classes
2022-06-21 00:08:33 +00:00
void update_reflection_data(int p_size, int p_mipmaps, bool p_use_array, RID p_base_cube, int p_base_layer, bool p_low_quality, int p_roughness_layers, RD::DataFormat p_texture_format);
void create_reflection_fast_filter(bool p_use_arrays);
void create_reflection_importance_sample(bool p_use_arrays, int p_cube_side, int p_base_layer, uint32_t p_sky_ggx_samples_quality);
void update_reflection_mipmaps(int p_start, int p_end);
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
};
/* Sky shader */
struct SkyShader {
SkyShaderRD shader;
New OpenGL batching canvas renderer
2021-11-16 15:25:42 +00:00
ShaderCompiler compiler;
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
RID default_shader;
RID default_material;
RID default_shader_rd;
} sky_shader;
Extract global variable, shader and material storage
2022-03-21 11:25:25 +00:00
struct SkyMaterialData : public RendererRD::MaterialData {
Zero initialize all pointer class and struct members This prevents the pitfall of UB when checking if they have been assigned something valid by comparing to nullptr.
2022-04-04 13:06:57 +00:00
SkyShaderData *shader_data = nullptr;
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
RID uniform_set;
bool uniform_set_updated;
virtual void set_render_priority(int p_priority) {}
virtual void set_next_pass(RID p_pass) {}
Replace most uses of Map by HashMap * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-05-13 13:04:37 +00:00
virtual bool update_parameters(const HashMap<StringName, Variant> &p_parameters, bool p_uniform_dirty, bool p_textures_dirty);
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
virtual ~SkyMaterialData();
};
struct Sky {
RID radiance;
RID half_res_pass;
RID half_res_framebuffer;
RID quarter_res_pass;
RID quarter_res_framebuffer;
Size2i screen_size;
RID texture_uniform_sets[SKY_TEXTURE_SET_MAX];
RID uniform_set;
RID material;
RID uniform_buffer;
int radiance_size = 256;
Revert "Fix default sky process mode not being Real-Time" This reverts commit aa1cba1d53270cd14339141082d9d5dc9c3857ef.
2022-02-18 07:13:10 +00:00
RS::SkyMode mode = RS::SKY_MODE_AUTOMATIC;
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
ReflectionData reflection;
bool dirty = false;
int processing_layer = 0;
Sky *dirty_list = nullptr;
//State to track when radiance cubemap needs updating
Zero initialize all pointer class and struct members This prevents the pitfall of UB when checking if they have been assigned something valid by comparing to nullptr.
2022-04-04 13:06:57 +00:00
SkyMaterialData *prev_material = nullptr;
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
Vector3 prev_position;
float prev_time;
Split dependency logic Split FOG Split visibility notifier Final cleanup of storage classes
2022-06-21 00:08:33 +00:00
void free();
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
Split dependency logic Split FOG Split visibility notifier Final cleanup of storage classes
2022-06-21 00:08:33 +00:00
RID get_textures(SkyTextureSetVersion p_version, RID p_default_shader_rd);
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
bool set_radiance_size(int p_radiance_size);
bool set_mode(RS::SkyMode p_mode);
bool set_material(RID p_material);
Split out bokeh_dof and copy effects
2022-04-29 07:10:54 +00:00
Ref<Image> bake_panorama(float p_energy, int p_roughness_layers, const Size2i &p_size);
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
};
uint32_t sky_ggx_samples_quality;
bool sky_use_cubemap_array;
Sky *dirty_sky_list = nullptr;
mutable RID_Owner<Sky, true> sky_owner;
int roughness_layers;
Extract global variable, shader and material storage
2022-03-21 11:25:25 +00:00
RendererRD::ShaderData *_create_sky_shader_func();
static RendererRD::ShaderData *_create_sky_shader_funcs();
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
Extract global variable, shader and material storage
2022-03-21 11:25:25 +00:00
RendererRD::MaterialData *_create_sky_material_func(SkyShaderData *p_shader);
static RendererRD::MaterialData *_create_sky_material_funcs(RendererRD::ShaderData *p_shader);
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
Move Sky(RD) into environment Move Fog logic from render scene render to fog
2022-07-19 04:17:58 +00:00
SkyRD();
Split dependency logic Split FOG Split visibility notifier Final cleanup of storage classes
2022-06-21 00:08:33 +00:00
void init();
Porting cubemap compute shaders to raster for the mobile renderer
2021-07-27 13:33:47 +00:00
void set_texture_format(RD::DataFormat p_texture_format);
Move Sky(RD) into environment Move Fog logic from render scene render to fog
2022-07-19 04:17:58 +00:00
~SkyRD();
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
Restructure environment in render implementation
2022-07-27 06:14:23 +00:00
void setup(RID p_env, RID p_render_buffers, const PagedArray<RID> &p_lights, const Projection &p_projection, const Transform3D &p_transform, const Size2i p_screen_size, RendererSceneRenderRD *p_scene_render);
void update(RID p_env, const Projection &p_projection, const Transform3D &p_transform, double p_time, float p_luminance_multiplier = 1.0);
void draw(RID p_env, bool p_can_continue_color, bool p_can_continue_depth, RID p_fb, uint32_t p_view_count, const Projection *p_projections, const Transform3D &p_transform, double p_time); // only called by clustered renderer
void update_res_buffers(RID p_env, uint32_t p_view_count, const Projection *p_projections, const Transform3D &p_transform, double p_time, float p_luminance_multiplier = 1.0);
void draw(RD::DrawListID p_draw_list, RID p_env, RID p_fb, uint32_t p_view_count, const Projection *p_projections, const Transform3D &p_transform, double p_time, float p_luminance_multiplier = 1.0);
Moving GI code into RendererServerGIRD Moving Skyshader code into RendererServerSkyRD
2021-02-13 12:08:08 +00:00
void invalidate_sky(Sky *p_sky);
void update_dirty_skys();
RID sky_get_material(RID p_sky) const;
RID allocate_sky_rid();
void initialize_sky_rid(RID p_rid);
Sky *get_sky(RID p_sky) const;
void free_sky(RID p_sky);
void sky_set_radiance_size(RID p_sky, int p_radiance_size);
void sky_set_mode(RID p_sky, RS::SkyMode p_mode);
void sky_set_material(RID p_sky, RID p_material);
Ref<Image> sky_bake_panorama(RID p_sky, float p_energy, bool p_bake_irradiance, const Size2i &p_size);
RID sky_get_radiance_texture_rd(RID p_sky) const;
};
Move Sky(RD) into environment Move Fog logic from render scene render to fog
2022-07-19 04:17:58 +00:00
} // namespace RendererRD
#endif // SKY_RD_H