From a930be6adc8d5fefe1277493605a7d5a081f0de4 Mon Sep 17 00:00:00 2001 From: tomas7770 Date: Fri, 29 Nov 2024 15:53:03 +0000 Subject: [PATCH] deploy: 99302b329af31909342995695816d0180126dee6 --- annotated.html | 11 +- atlas__rasterizer_8hpp.html | 132 +++++++++++++ caster_8hpp.html | 4 +- classcubos_1_1engine_1_1PointShadowAtlas.html | 187 ++++++++++++++++++ classcubos_1_1engine_1_1SpotShadowAtlas.html | 187 ++++++++++++++++++ dir_13f5e2b140054f355a8f8a8c95923a6a.html | 10 +- dir_1e4f387a18d75f95344107dd9ab1cedd.html | 122 ++++++++++++ dir_5f7c03bcbcec03d7c8f45b1f4929e6f9.html | 120 +++++++++++ dir_96b8420751841f17c2165eb8cc4bd5c8.html | 120 +++++++++++ dir_96e3f5c002ab7bd394a15a8f0db98b8f.html | 126 ++++++++++++ dir_c78f5443f5dc3ad749dea386b88bb233.html | 128 ++++++++++++ dir_d56b3b460aaf5e63a90e3ed12bfd34f7.html | 28 +-- directional__caster_8hpp.html | 4 +- ..._2render_2shadows_2atlas_2plugin_8hpp.html | 150 ++++++++++++++ ...adows_2atlas__rasterizer_2plugin_8hpp.html | 132 +++++++++++++ ...ender_2shadows_2cascaded_2plugin_8hpp.html | 146 ++++++++++++++ ...ws_2cascaded__rasterizer_2plugin_8hpp.html | 132 +++++++++++++ ...render_2shadows_2casters_2plugin_8hpp.html | 132 +++++++++++++ files.html | 71 ++++--- geom_2utils_8hpp.html | 5 + ...p__render-cascaded-shadow-maps-plugin.html | 15 +- ...ascaded-shadow-maps-rasterizer-plugin.html | 11 +- group__render-deferred-shading-plugin.html | 4 +- group__render-depth-plugin.html | 6 +- group__render-g-buffer-plugin.html | 4 +- group__render-g-buffer-rasterizer-plugin.html | 4 +- group__render-hdr-plugin.html | 4 +- group__render-mesh-plugin.html | 6 +- group__render-picker-plugin.html | 4 +- group__render-plugins.html | 12 +- group__render-shader-plugin.html | 6 +- group__render-shadow-atlas-plugin.html | 43 ++-- ...render-shadow-atlas-rasterizer-plugin.html | 17 +- group__render-shadow-casters-plugin.html | 183 +++++++++++++++++ group__render-shadows-plugins.html | 129 ++++++++++++ modules.html | 15 +- namespacecubos_1_1core_1_1geom.html | 28 +++ namespacecubos_1_1engine.html | 52 ++--- point__atlas_8hpp.html | 132 +++++++++++++ point__caster_8hpp.html | 4 +- searchdata-v2.js | 2 +- slot_8hpp.html | 132 +++++++++++++ spot__atlas_8hpp.html | 132 +++++++++++++ spot__caster_8hpp.html | 4 +- ..._1_1engine_1_1DirectionalShadowCaster.html | 2 +- ...tcubos_1_1engine_1_1PointShadowCaster.html | 2 +- ...os_1_1engine_1_1ShadowAtlasRasterizer.html | 24 ++- structcubos_1_1engine_1_1ShadowCaster.html | 2 +- structcubos_1_1engine_1_1ShadowMapSlot.html | 173 ++++++++++++++++ ...ctcubos_1_1engine_1_1SpotShadowCaster.html | 2 +- 50 files changed, 2925 insertions(+), 176 deletions(-) create mode 100644 atlas__rasterizer_8hpp.html create mode 100644 classcubos_1_1engine_1_1PointShadowAtlas.html create mode 100644 classcubos_1_1engine_1_1SpotShadowAtlas.html create mode 100644 dir_1e4f387a18d75f95344107dd9ab1cedd.html create mode 100644 dir_5f7c03bcbcec03d7c8f45b1f4929e6f9.html create mode 100644 dir_96b8420751841f17c2165eb8cc4bd5c8.html create mode 100644 dir_96e3f5c002ab7bd394a15a8f0db98b8f.html create mode 100644 dir_c78f5443f5dc3ad749dea386b88bb233.html create mode 100644 engine_2include_2cubos_2engine_2render_2shadows_2atlas_2plugin_8hpp.html create mode 100644 engine_2include_2cubos_2engine_2render_2shadows_2atlas__rasterizer_2plugin_8hpp.html create mode 100644 engine_2include_2cubos_2engine_2render_2shadows_2cascaded_2plugin_8hpp.html create mode 100644 engine_2include_2cubos_2engine_2render_2shadows_2cascaded__rasterizer_2plugin_8hpp.html create mode 100644 engine_2include_2cubos_2engine_2render_2shadows_2casters_2plugin_8hpp.html create mode 100644 group__render-shadow-casters-plugin.html create mode 100644 group__render-shadows-plugins.html create mode 100644 point__atlas_8hpp.html create mode 100644 slot_8hpp.html create mode 100644 spot__atlas_8hpp.html create mode 100644 structcubos_1_1engine_1_1ShadowMapSlot.html diff --git a/annotated.html b/annotated.html index cd82867883..68a254de97 100644 --- a/annotated.html +++ b/annotated.html @@ -524,6 +524,7 @@

Classes

  • struct PhysicsBundle Component which encapsulates the creation all components required for physics.
  • struct PhysicsMaterial Component which defines the friction and bounciness of a body.
  • struct PointLight Component which makes an entity behave like a point light.
    • +
  • class PointShadowAtlas Resource which stores the shadow map atlas for point lights, a large texture that holds the shadow maps for each shadow caster in a quadtree structure, reducing texture switching.
  • struct PointShadowCaster Component which enables shadow casting on a point light.
  • struct Position Component which assigns a position to an entity.
  • class Settings final Stores settings as key-value pairs and provides methods to retrieve them.
  • class Shader final Contains a shader stage created from GLSL code.
  • class ShaderBridge Bridge for loading shader assets.
    • - -
  • struct ShadowAtlasRasterizer Resource which stores the ShadowAtlas rasterizer state.
    • +
  • struct ShadowAtlasRasterizer Resource which stores the ShadowAtlas rasterizer state.
  • struct ShadowCaster Struct which contains the settings common to all shadow casters.
    • +
  • struct ShadowMapSlot Slot for a shadow map in the shadow atlas.
  • struct SplitScreen Component which enables splitscreen in a render target.
  • struct SpotLight Component which makes an entity emit a spot light in the direction of its local forward vector.
    • +
  • class SpotShadowAtlas Resource which stores the shadow map atlas for spot lights, a large texture that holds the shadow maps for each shadow caster in a quadtree structure, reducing texture switching.
  • struct SpotShadowCaster Component which enables shadow casting on a spot light.
  • struct SSAO Component which stores the SSAO textures for a render target.
  • struct ToneMapping Component which stores Tone Mapping configuration for a render target.
    • diff --git a/atlas__rasterizer_8hpp.html b/atlas__rasterizer_8hpp.html new file mode 100644 index 0000000000..e71f92141e --- /dev/null +++ b/atlas__rasterizer_8hpp.html @@ -0,0 +1,132 @@ + + + + + engine/render/shadows/atlas_rasterizer/atlas_rasterizer.hpp file | Cubos Docs + + + + + + + +
    +
    + + + + + + diff --git a/caster_8hpp.html b/caster_8hpp.html index c25fa80413..3103460a6a 100644 --- a/caster_8hpp.html +++ b/caster_8hpp.html @@ -2,7 +2,7 @@ - engine/render/shadows/caster.hpp file | Cubos Docs + engine/render/shadows/casters/caster.hpp file | Cubos Docs @@ -46,7 +46,7 @@

    - engine/render/shadows/caster.hpp file + engine/render/shadows/casters/caster.hpp file

    Struct cubos::engine::ShadowCaster.

    diff --git a/directional__caster_8hpp.html b/directional__caster_8hpp.html index 3abd0423c3..29cfedd7bd 100644 --- a/directional__caster_8hpp.html +++ b/directional__caster_8hpp.html @@ -2,7 +2,7 @@ - engine/render/shadows/directional_caster.hpp file | Cubos Docs + engine/render/shadows/casters/directional_caster.hpp file | Cubos Docs @@ -46,7 +46,7 @@

    - engine/render/shadows/directional_caster.hpp file + engine/render/shadows/casters/directional_caster.hpp file

    Component cubos::engine::DirectionalShadowCaster.

    diff --git a/group__render-cascaded-shadow-maps-plugin.html b/group__render-cascaded-shadow-maps-plugin.html index 5723f618c2..8d212501e9 100644 --- a/group__render-cascaded-shadow-maps-plugin.html +++ b/group__render-cascaded-shadow-maps-plugin.html @@ -2,7 +2,7 @@ - Engine » Render » Cascaded shadow maps module | Cubos Docs + Engine » Render » Shadows » Cascaded shadow maps module | Cubos Docs @@ -48,12 +48,13 @@

    Engine » Render » + Shadows » Cascaded shadow maps module

    Creates and manages shadow maps for directional shadow casters.

    -

    Dependencies

    +

    Dependencies

    Files

    -
    file plugin.hpp
    +
    file plugin.hpp
    Plugin entry point.
    @@ -99,7 +100,7 @@

    Function documentation

    CUBOS_ENGINE_API void cascadedShadowMapsPlugin(Cubos& cubos) -
    #include <engine/render/cascaded_shadow_maps/plugin.hpp>
    +
    #include <engine/render/shadows/cascaded/plugin.hpp>

    Plugin entry function.

    @@ -120,14 +121,14 @@

    Variable documentation

    CUBOS_ENGINE_API Tag drawToCascadedShadowMapsTag -
    #include <engine/render/cascaded_shadow_maps/plugin.hpp>
    +
    #include <engine/render/shadows/cascaded/plugin.hpp>

    Systems which draw to the cascaded shadow maps should be tagged with this.

    diff --git a/group__render-cascaded-shadow-maps-rasterizer-plugin.html b/group__render-cascaded-shadow-maps-rasterizer-plugin.html index fc68aa1d43..b99174d5d6 100644 --- a/group__render-cascaded-shadow-maps-rasterizer-plugin.html +++ b/group__render-cascaded-shadow-maps-rasterizer-plugin.html @@ -2,7 +2,7 @@ - Engine » Render » Cascaded shadow maps rasterizer module | Cubos Docs + Engine » Render » Shadows » Cascaded shadow maps rasterizer module | Cubos Docs @@ -48,12 +48,13 @@

    Engine » Render » + Shadows » Cascaded shadow maps rasterizer module

    Draws all render meshes for each directional light to its shadow map.

    -

    Dependencies

    +

    Dependencies

    Files

    -
    file plugin.hpp
    +
    file plugin.hpp
    Plugin entry point.
    @@ -85,7 +86,7 @@

    Function documentation

    diff --git a/group__render-deferred-shading-plugin.html b/group__render-deferred-shading-plugin.html index 66a0a68cb3..70c53a2d4c 100644 --- a/group__render-deferred-shading-plugin.html +++ b/group__render-deferred-shading-plugin.html @@ -53,7 +53,7 @@

    -

    Dependencies

    +

    Dependencies

    Files

    diff --git a/group__render-depth-plugin.html b/group__render-depth-plugin.html index 8af74a6319..5468e67e5e 100644 --- a/group__render-depth-plugin.html +++ b/group__render-depth-plugin.html @@ -53,8 +53,8 @@

    -

    Components

    Dependencies

    +

    Components

    Dependencies

    Files

    diff --git a/group__render-g-buffer-plugin.html b/group__render-g-buffer-plugin.html index ee426d8007..afd8bbd5c1 100644 --- a/group__render-g-buffer-plugin.html +++ b/group__render-g-buffer-plugin.html @@ -53,7 +53,7 @@

    -

    Dependencies

    +

    Dependencies

    Files

    diff --git a/group__render-g-buffer-rasterizer-plugin.html b/group__render-g-buffer-rasterizer-plugin.html index 7ea6418800..e367e75a84 100644 --- a/group__render-g-buffer-rasterizer-plugin.html +++ b/group__render-g-buffer-rasterizer-plugin.html @@ -53,7 +53,7 @@

    -

    Dependencies

    +

    Dependencies

    Files

    diff --git a/group__render-hdr-plugin.html b/group__render-hdr-plugin.html index e28ca8e367..792bf34885 100644 --- a/group__render-hdr-plugin.html +++ b/group__render-hdr-plugin.html @@ -53,7 +53,7 @@

    -

    Dependencies

    +

    Dependencies

    Files

    diff --git a/group__render-mesh-plugin.html b/group__render-mesh-plugin.html index ccbffcc5da..aca1e78f13 100644 --- a/group__render-mesh-plugin.html +++ b/group__render-mesh-plugin.html @@ -53,8 +53,8 @@

    -

    Settings

    • renderMeshPool.bucketCount - number of buckets in the mesh pool (default: 1024).
    • renderMeshPool.bucketSize - maximum face count per bucket (default: 1024).

    Dependencies

    +

    Settings

    • renderMeshPool.bucketCount - number of buckets in the mesh pool (default: 1024).
    • renderMeshPool.bucketSize - maximum face count per bucket (default: 1024).

    Dependencies

    Files

    diff --git a/group__render-picker-plugin.html b/group__render-picker-plugin.html index d5f4045783..e526ea2b40 100644 --- a/group__render-picker-plugin.html +++ b/group__render-picker-plugin.html @@ -53,7 +53,7 @@

    -

    Dependencies

    +

    Dependencies

    Files

    diff --git a/group__render-plugins.html b/group__render-plugins.html index cc50a06e3a..ada3410726 100644 --- a/group__render-plugins.html +++ b/group__render-plugins.html @@ -67,10 +67,6 @@

    Modules

    Applies the Bloom effect on the HDR texture.
    module Camera
    Adds PerspectiveCamera components and the DrawsTo relation.
    -
    module Cascaded shadow maps
    -
    Creates and manages shadow maps for directional shadow casters.
    -
    module Cascaded shadow maps rasterizer
    -
    Draws all render meshes for each directional light to its shadow map.
    module Deferred Shading
    Applies the Deferred Shading technique on the GBuffer and outputs the result to the HDR texture.
    module Depth
    @@ -89,12 +85,8 @@

    Modules

    Adds and manages RenderPicker components.
    module Shader
    Adds shader assets to Cubos.
    -
    module Shadow atlas
    -
    Creates and manages a shadow map atlas.
    -
    module Shadow atlas rasterizer
    -
    Draws all render meshes for each light to the shadow map atlas.
    -
    module Shadows
    -
    Base interface plugin for shadows.
    +
    module Shadows
    +
    Provides plugins for rendering shadows.
    module Splitscreen
    Adjusts the viewport in DrawsTo relations to achieve a splitscreen layout.
    module Screen Space Ambient Occlusion
    diff --git a/group__render-shader-plugin.html b/group__render-shader-plugin.html index 98cf08eeef..0aa7ab541f 100644 --- a/group__render-shader-plugin.html +++ b/group__render-shader-plugin.html @@ -53,8 +53,8 @@

    -

    Bridges

    Dependencies

    +

    Bridges

    Dependencies

    Files

    diff --git a/group__render-shadow-atlas-plugin.html b/group__render-shadow-atlas-plugin.html index 40bc620a3d..dceaf2a115 100644 --- a/group__render-shadow-atlas-plugin.html +++ b/group__render-shadow-atlas-plugin.html @@ -2,7 +2,7 @@ - Engine » Render » Shadow atlas module | Cubos Docs + Engine » Render » Shadows » Shadow atlas module | Cubos Docs @@ -48,12 +48,13 @@

    Engine » Render » + Shadows » Shadow atlas module

    -

    Creates and manages a shadow map atlas.

    +

    Creates and manages shadow map atlases.

    -

    Dependencies

    +

    Dependencies

    Files

    -
    file plugin.hpp
    +
    file plugin.hpp
    Plugin entry point.
    -
    file shadow_atlas.hpp
    -
    Resource cubos::engine::ShadowAtlas.
    +
    file point_atlas.hpp
    +
    Resource cubos::engine::PointShadowAtlas.
    +
    file slot.hpp
    +
    Resource cubos::engine::ShadowMapSlot.
    +
    file spot_atlas.hpp
    +
    Resource cubos::engine::SpotShadowAtlas.

    Classes

    - class cubos::engine::ShadowAtlas + class cubos::engine::PointShadowAtlas
    -
    Resource which stores the shadow map atlas, a large texture that holds the shadow maps for each shadow caster in a quadtree structure, reducing texture switching.
    +
    Resource which stores the shadow map atlas for point lights, a large texture that holds the shadow maps for each shadow caster in a quadtree structure, reducing texture switching.
    +
    + class cubos::engine::SpotShadowAtlas +
    +
    Resource which stores the shadow map atlas for spot lights, a large texture that holds the shadow maps for each shadow caster in a quadtree structure, reducing texture switching.
    @@ -99,7 +108,7 @@

    Variables

    CUBOS_ENGINE_API Tag createShadowAtlasTag
    -
    Creates the shadow atlas.
    +
    Creates the shadow atlases.
    CUBOS_ENGINE_API Tag reserveShadowCastersTag
    @@ -107,7 +116,7 @@

    Variables

    CUBOS_ENGINE_API Tag drawToShadowAtlasTag
    -
    Systems which draw to the shadow atlas texture should be tagged with this.
    +
    Systems which draw to the shadow atlas textures should be tagged with this.
    @@ -115,7 +124,7 @@

    Function documentation

    @@ -136,23 +145,23 @@

    Variable documentation

    CUBOS_ENGINE_API Tag createShadowAtlasTag -
    #include <engine/render/shadow_atlas/plugin.hpp>
    +
    #include <engine/render/shadows/atlas/plugin.hpp>

    -

    Creates the shadow atlas.

    +

    Creates the shadow atlases.

    CUBOS_ENGINE_API Tag drawToShadowAtlasTag -
    #include <engine/render/shadow_atlas/plugin.hpp>
    +
    #include <engine/render/shadows/atlas/plugin.hpp>

    -

    Systems which draw to the shadow atlas texture should be tagged with this.

    +

    Systems which draw to the shadow atlas textures should be tagged with this.

    diff --git a/group__render-shadow-atlas-rasterizer-plugin.html b/group__render-shadow-atlas-rasterizer-plugin.html index 3ab00f2a22..20e7a2e9a2 100644 --- a/group__render-shadow-atlas-rasterizer-plugin.html +++ b/group__render-shadow-atlas-rasterizer-plugin.html @@ -2,7 +2,7 @@ - Engine » Render » Shadow atlas rasterizer module | Cubos Docs + Engine » Render » Shadows » Shadow atlas rasterizer module | Cubos Docs @@ -48,12 +48,13 @@

    Engine » Render » + Shadows » Shadow atlas rasterizer module

    Draws all render meshes for each light to the shadow map atlas.

    -

    Dependencies

    +

    Dependencies

    Files

    -
    file plugin.hpp
    -
    Plugin entry point.
    -
    file shadow_atlas_rasterizer.hpp
    +
    file atlas_rasterizer.hpp
    Resource cubos::engine::ShadowAtlasRasterizer.
    +
    file plugin.hpp
    +
    Plugin entry point.
    @@ -80,7 +81,7 @@

    Classes

    struct cubos::engine::ShadowAtlasRasterizer
    -
    Resource which stores the ShadowAtlas rasterizer state.
    +
    Resource which stores the ShadowAtlas rasterizer state.
    @@ -97,7 +98,7 @@

    Function documentation

    diff --git a/group__render-shadow-casters-plugin.html b/group__render-shadow-casters-plugin.html new file mode 100644 index 0000000000..803f7f8c41 --- /dev/null +++ b/group__render-shadow-casters-plugin.html @@ -0,0 +1,183 @@ + + + + + Engine » Render » Shadows » Shadow casters module | Cubos Docs + + + + + + + +
    +
    +
    +
    +
    +

    + Engine » + Render » + Shadows » + Shadow casters module

    +

    Base interface plugin for shadows.

    + +
    +

    Files

    +
    +
    file caster.hpp
    +
    Struct cubos::engine::ShadowCaster.
    +
    file directional_caster.hpp
    +
    Component cubos::engine::DirectionalShadowCaster.
    +
    file plugin.hpp
    +
    Plugin entry point.
    +
    file point_caster.hpp
    +
    Component cubos::engine::PointShadowCaster.
    +
    file spot_caster.hpp
    +
    Component cubos::engine::SpotShadowCaster.
    +
    +
    +
    +

    Classes

    +
    +
    + struct cubos::engine::ShadowCaster +
    +
    Struct which contains the settings common to all shadow casters.
    +
    + struct cubos::engine::DirectionalShadowCaster +
    +
    Component which enables shadow casting on a directional light.
    +
    + struct cubos::engine::PointShadowCaster +
    +
    Component which enables shadow casting on a point light.
    +
    + struct cubos::engine::SpotShadowCaster +
    +
    Component which enables shadow casting on a spot light.
    +
    +
    +
    +

    Functions

    +
    +
    + auto shadowCastersPlugin(Cubos& cubos) -> CUBOS_ENGINE_API void +
    +
    Plugin entry function.
    +
    +
    +
    +

    Function documentation

    +
    +

    + CUBOS_ENGINE_API void shadowCastersPlugin(Cubos& cubos) +
    #include <engine/render/shadows/casters/plugin.hpp>
    +

    +

    Plugin entry function.

    +
    + + + + + + + + + +
    Parameters
    cubosCubos main class.
    +
    + +
    +
    + + + + + + + + diff --git a/group__render-shadows-plugins.html b/group__render-shadows-plugins.html new file mode 100644 index 0000000000..d22c24aac9 --- /dev/null +++ b/group__render-shadows-plugins.html @@ -0,0 +1,129 @@ + + + + + Engine » Render » Shadows module | Cubos Docs + + + + + + + +
    +
    +
    +
    +
    +

    + Engine » + Render » + Shadows module

    +

    Provides plugins for rendering shadows.

    + +
    +

    Modules

    +
    +
    module Shadow atlas
    +
    Creates and manages shadow map atlases.
    +
    module Shadow atlas rasterizer
    +
    Draws all render meshes for each light to the shadow map atlas.
    +
    module Cascaded shadow maps
    +
    Creates and manages shadow maps for directional shadow casters.
    +
    module Cascaded shadow maps rasterizer
    +
    Draws all render meshes for each directional light to its shadow map.
    +
    module Shadow casters
    +
    Base interface plugin for shadows.
    +
    +
    +
    +
    +
    +
    + + + + + + diff --git a/modules.html b/modules.html index f19a0b4650..725be82067 100644 --- a/modules.html +++ b/modules.html @@ -109,8 +109,6 @@

    Modules