Development

Renderer/Shadows/ShadowSystem.h

Public include <Renderer/Shadows/ShadowSystem.h>. SnBuild module Shadows.

SnAPI::Renderer::EShadowLightType

enum class SnAPI::Renderer::EShadowLightType : std::uint8_t

Directional = 0

Point

Spot

SnAPI::Renderer::EShadowCachePolicy

enum class SnAPI::Renderer::EShadowCachePolicy : std::uint8_t

RenderEveryFrame = 0

CacheUntilInvalidated

CacheStaticWithDynamicOverlay

SnAPI::Renderer::EShadowFilterPolicy

enum class SnAPI::Renderer::EShadowFilterPolicy : std::uint8_t

Hard = 0

Pcf

Pcss

SnAPI::Renderer::EDirectionalShadowDistributionMode

enum class SnAPI::Renderer::EDirectionalShadowDistributionMode : std::uint8_t

Practical = 0

SampleDistribution

SnAPI::Renderer::ShadowSystemSettings

struct SnAPI::Renderer::ShadowSystemSettings

SnAPI::Renderer::ShadowSystemSettings::DirectionalCascadeCount

std::uint32_t SnAPI::Renderer::ShadowSystemSettings::DirectionalCascadeCount = 4u

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystemSettings::DirectionalShadowMapResolution

std::uint32_t SnAPI::Renderer::ShadowSystemSettings::DirectionalShadowMapResolution = 2048u

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystemSettings::DirectionalShadowDistance

double SnAPI::Renderer::ShadowSystemSettings::DirectionalShadowDistance = 200.0

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystemSettings::DirectionalCascadeSplitLambda

double SnAPI::Renderer::ShadowSystemSettings::DirectionalCascadeSplitLambda = 0.75

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystemSettings::DirectionalDistributionMode

EDirectionalShadowDistributionMode SnAPI::Renderer::ShadowSystemSettings::DirectionalDistributionMode = EDirectionalShadowDistributionMode::SampleDistribution

See also SnAPI::Renderer::ShadowSystemSettings, SnAPI::Renderer::EDirectionalShadowDistributionMode.

SnAPI::Renderer::ShadowSystemSettings::DirectionalSdsmDepthPaddingFraction

double SnAPI::Renderer::ShadowSystemSettings::DirectionalSdsmDepthPaddingFraction = 0.10

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystemSettings::DirectionalSdsmMinDepthRange

double SnAPI::Renderer::ShadowSystemSettings::DirectionalSdsmMinDepthRange = 8.0

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystemSettings::DirectionalSdsmDepthSnapFraction

double SnAPI::Renderer::ShadowSystemSettings::DirectionalSdsmDepthSnapFraction = 0.05

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystemSettings::DirectionalSdsmMinDepthSnap

double SnAPI::Renderer::ShadowSystemSettings::DirectionalSdsmMinDepthSnap = 0.5

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystemSettings::DirectionalSdsmIgnoreDynamicCastersForStableRange

bool SnAPI::Renderer::ShadowSystemSettings::DirectionalSdsmIgnoreDynamicCastersForStableRange = true

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystemSettings::StableDirectionalCascades

bool SnAPI::Renderer::ShadowSystemSettings::StableDirectionalCascades = true

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystemSettings::TightDirectionalCascadeDepth

bool SnAPI::Renderer::ShadowSystemSettings::TightDirectionalCascadeDepth = true

See also SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowCasterBounds

struct SnAPI::Renderer::ShadowCasterBounds

SnAPI::Renderer::ShadowCasterBounds::CenterWorld

Point3 SnAPI::Renderer::ShadowCasterBounds::CenterWorld {Point3::Zero()}

See also SnAPI::Renderer::ShadowCasterBounds, SnAPI::Renderer::Point3.

SnAPI::Renderer::ShadowCasterBounds::Radius

double SnAPI::Renderer::ShadowCasterBounds::Radius = 0.0

See also SnAPI::Renderer::ShadowCasterBounds.

SnAPI::Renderer::ShadowCasterBounds::MinWorld

Point3 SnAPI::Renderer::ShadowCasterBounds::MinWorld {Point3::Zero()}

See also SnAPI::Renderer::ShadowCasterBounds, SnAPI::Renderer::Point3.

SnAPI::Renderer::ShadowCasterBounds::MaxWorld

Point3 SnAPI::Renderer::ShadowCasterBounds::MaxWorld {Point3::Zero()}

See also SnAPI::Renderer::ShadowCasterBounds, SnAPI::Renderer::Point3.

SnAPI::Renderer::ShadowCasterBounds::HasBox

bool SnAPI::Renderer::ShadowCasterBounds::HasBox = false

See also SnAPI::Renderer::ShadowCasterBounds.

SnAPI::Renderer::ShadowCasterSummary

struct SnAPI::Renderer::ShadowCasterSummary

SnAPI::Renderer::ShadowCasterSummary::Mobility

ERenderMobility SnAPI::Renderer::ShadowCasterSummary::Mobility {ERenderMobility::Dynamic}

See also SnAPI::Renderer::ShadowCasterSummary, SnAPI::Renderer::ERenderMobility.

SnAPI::Renderer::ShadowCasterSummary::Bounds

std::optional<ShadowCasterBounds> SnAPI::Renderer::ShadowCasterSummary::Bounds {}

See also SnAPI::Renderer::ShadowCasterSummary, SnAPI::Renderer::ShadowCasterBounds.

SnAPI::Renderer::ShadowSceneMobilitySummary

struct SnAPI::Renderer::ShadowSceneMobilitySummary

SnAPI::Renderer::ShadowSceneMobilitySummary::StaticCasterCount

std::uint32_t SnAPI::Renderer::ShadowSceneMobilitySummary::StaticCasterCount = 0u

See also SnAPI::Renderer::ShadowSceneMobilitySummary.

SnAPI::Renderer::ShadowSceneMobilitySummary::StationaryCasterCount

std::uint32_t SnAPI::Renderer::ShadowSceneMobilitySummary::StationaryCasterCount = 0u

See also SnAPI::Renderer::ShadowSceneMobilitySummary.

SnAPI::Renderer::ShadowSceneMobilitySummary::DynamicCasterCount

std::uint32_t SnAPI::Renderer::ShadowSceneMobilitySummary::DynamicCasterCount = 0u

See also SnAPI::Renderer::ShadowSceneMobilitySummary.

SnAPI::Renderer::ShadowSceneMobilitySummary::BoundedCasterCount

std::uint32_t SnAPI::Renderer::ShadowSceneMobilitySummary::BoundedCasterCount = 0u

See also SnAPI::Renderer::ShadowSceneMobilitySummary.

SnAPI::Renderer::DirectionalShadowCascade

struct SnAPI::Renderer::DirectionalShadowCascade

SnAPI::Renderer::DirectionalShadowCascade::CascadeIndex

std::uint32_t SnAPI::Renderer::DirectionalShadowCascade::CascadeIndex = 0u

See also SnAPI::Renderer::DirectionalShadowCascade.

SnAPI::Renderer::DirectionalShadowCascade::NearDistance

double SnAPI::Renderer::DirectionalShadowCascade::NearDistance = 0.0

See also SnAPI::Renderer::DirectionalShadowCascade.

SnAPI::Renderer::DirectionalShadowCascade::FarDistance

double SnAPI::Renderer::DirectionalShadowCascade::FarDistance = 0.0

See also SnAPI::Renderer::DirectionalShadowCascade.

SnAPI::Renderer::DirectionalShadowCascade::TexelWorldSize

double SnAPI::Renderer::DirectionalShadowCascade::TexelWorldSize = 0.0

See also SnAPI::Renderer::DirectionalShadowCascade.

SnAPI::Renderer::DirectionalShadowCascade::BoundingSphereRadius

double SnAPI::Renderer::DirectionalShadowCascade::BoundingSphereRadius = 0.0

See also SnAPI::Renderer::DirectionalShadowCascade.

SnAPI::Renderer::DirectionalShadowCascade::CenterWorld

Point3 SnAPI::Renderer::DirectionalShadowCascade::CenterWorld {Point3::Zero()}

See also SnAPI::Renderer::DirectionalShadowCascade, SnAPI::Renderer::Point3.

SnAPI::Renderer::DirectionalShadowCascade::LightFromWorld

Matrix4 SnAPI::Renderer::DirectionalShadowCascade::LightFromWorld {Matrix4::Identity()}

See also SnAPI::Renderer::DirectionalShadowCascade, SnAPI::Renderer::Matrix4.

SnAPI::Renderer::DirectionalShadowCascade::ClipFromLight

Matrix4 SnAPI::Renderer::DirectionalShadowCascade::ClipFromLight {Matrix4::Identity()}

See also SnAPI::Renderer::DirectionalShadowCascade, SnAPI::Renderer::Matrix4.

SnAPI::Renderer::DirectionalShadowCascade::ClipFromWorld

Matrix4 SnAPI::Renderer::DirectionalShadowCascade::ClipFromWorld {Matrix4::Identity()}

See also SnAPI::Renderer::DirectionalShadowCascade, SnAPI::Renderer::Matrix4.

SnAPI::Renderer::DirectionalShadowCascade::LightSpaceXYMinMax

std::array<double, 4> SnAPI::Renderer::DirectionalShadowCascade::LightSpaceXYMinMax = {}

See also SnAPI::Renderer::DirectionalShadowCascade.

SnAPI::Renderer::DirectionalShadowCascade::LightSpaceZMinMax

std::array<double, 2> SnAPI::Renderer::DirectionalShadowCascade::LightSpaceZMinMax = {}

See also SnAPI::Renderer::DirectionalShadowCascade.

SnAPI::Renderer::DirectionalShadowPlan

struct SnAPI::Renderer::DirectionalShadowPlan

SnAPI::Renderer::DirectionalShadowPlan::DebugName

std::string SnAPI::Renderer::DirectionalShadowPlan::DebugName {}

See also SnAPI::Renderer::DirectionalShadowPlan.

SnAPI::Renderer::DirectionalShadowPlan::LightType

EShadowLightType SnAPI::Renderer::DirectionalShadowPlan::LightType {EShadowLightType::Directional}

See also SnAPI::Renderer::DirectionalShadowPlan, SnAPI::Renderer::EShadowLightType.

SnAPI::Renderer::DirectionalShadowPlan::LightMobility

ERenderMobility SnAPI::Renderer::DirectionalShadowPlan::LightMobility {ERenderMobility::Dynamic}

See also SnAPI::Renderer::DirectionalShadowPlan, SnAPI::Renderer::ERenderMobility.

SnAPI::Renderer::DirectionalShadowPlan::CachePolicy

EShadowCachePolicy SnAPI::Renderer::DirectionalShadowPlan::CachePolicy {EShadowCachePolicy::RenderEveryFrame}

See also SnAPI::Renderer::DirectionalShadowPlan, SnAPI::Renderer::EShadowCachePolicy.

SnAPI::Renderer::DirectionalShadowPlan::FilterPolicy

EShadowFilterPolicy SnAPI::Renderer::DirectionalShadowPlan::FilterPolicy {EShadowFilterPolicy::Pcf}

See also SnAPI::Renderer::DirectionalShadowPlan, SnAPI::Renderer::EShadowFilterPolicy.

SnAPI::Renderer::DirectionalShadowPlan::Cascades

std::vector<DirectionalShadowCascade> SnAPI::Renderer::DirectionalShadowPlan::Cascades {}

See also SnAPI::Renderer::DirectionalShadowPlan, SnAPI::Renderer::DirectionalShadowCascade.

SnAPI::Renderer::DirectionalShadowPlan::CasterMobility

ShadowSceneMobilitySummary SnAPI::Renderer::DirectionalShadowPlan::CasterMobility {}

See also SnAPI::Renderer::DirectionalShadowPlan, SnAPI::Renderer::ShadowSceneMobilitySummary.

SnAPI::Renderer::ShadowViewPlan

struct SnAPI::Renderer::ShadowViewPlan

SnAPI::Renderer::ShadowViewPlan::DirectionalPlans

std::vector<DirectionalShadowPlan> SnAPI::Renderer::ShadowViewPlan::DirectionalPlans {}

See also SnAPI::Renderer::ShadowViewPlan, SnAPI::Renderer::DirectionalShadowPlan.

SnAPI::Renderer::ShadowViewPlan::CasterMobility

ShadowSceneMobilitySummary SnAPI::Renderer::ShadowViewPlan::CasterMobility {}

See also SnAPI::Renderer::ShadowViewPlan, SnAPI::Renderer::ShadowSceneMobilitySummary.

SnAPI::Renderer::ShadowViewPlan::PunctualPlans

std::vector<PunctualShadowPlan> SnAPI::Renderer::ShadowViewPlan::PunctualPlans {}

See also SnAPI::Renderer::ShadowViewPlan, SnAPI::Renderer::PunctualShadowPlan.

SnAPI::Renderer::DirectionalShadowBuildDesc

struct SnAPI::Renderer::DirectionalShadowBuildDesc

SnAPI::Renderer::DirectionalShadowBuildDesc::View

RenderView SnAPI::Renderer::DirectionalShadowBuildDesc::View {}

See also SnAPI::Renderer::DirectionalShadowBuildDesc, SnAPI::Renderer::RenderView.

SnAPI::Renderer::DirectionalShadowBuildDesc::Light

DirectionalLightDesc SnAPI::Renderer::DirectionalShadowBuildDesc::Light {}

See also SnAPI::Renderer::DirectionalShadowBuildDesc, SnAPI::Renderer::DirectionalLightDesc.

SnAPI::Renderer::DirectionalShadowBuildDesc::Casters

std::span<const ShadowCasterSummary> SnAPI::Renderer::DirectionalShadowBuildDesc::Casters {}

See also SnAPI::Renderer::DirectionalShadowBuildDesc, SnAPI::Renderer::ShadowCasterSummary.

SnAPI::Renderer::DirectionalShadowBuildDesc::Settings

ShadowSystemSettings SnAPI::Renderer::DirectionalShadowBuildDesc::Settings {}

See also SnAPI::Renderer::DirectionalShadowBuildDesc, SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::DirectionalShadowBuildDesc::CachedDepthCascades

std::span<const DirectionalShadowCascade> SnAPI::Renderer::DirectionalShadowBuildDesc::CachedDepthCascades {}

See also SnAPI::Renderer::DirectionalShadowBuildDesc, SnAPI::Renderer::DirectionalShadowCascade.

SnAPI::Renderer::ShadowViewBuildDesc

struct SnAPI::Renderer::ShadowViewBuildDesc

SnAPI::Renderer::ShadowViewBuildDesc::View

RenderView SnAPI::Renderer::ShadowViewBuildDesc::View {}

See also SnAPI::Renderer::ShadowViewBuildDesc, SnAPI::Renderer::RenderView.

SnAPI::Renderer::ShadowViewBuildDesc::DirectionalLights

std::span<const DirectionalLightDesc> SnAPI::Renderer::ShadowViewBuildDesc::DirectionalLights {}

See also SnAPI::Renderer::ShadowViewBuildDesc, SnAPI::Renderer::DirectionalLightDesc.

SnAPI::Renderer::ShadowViewBuildDesc::Casters

std::span<const ShadowCasterSummary> SnAPI::Renderer::ShadowViewBuildDesc::Casters {}

See also SnAPI::Renderer::ShadowViewBuildDesc, SnAPI::Renderer::ShadowCasterSummary.

SnAPI::Renderer::ShadowViewBuildDesc::Settings

ShadowSystemSettings SnAPI::Renderer::ShadowViewBuildDesc::Settings {}

See also SnAPI::Renderer::ShadowViewBuildDesc, SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowViewBuildDesc::PunctualLights

std::span<const PunctualShadowLight> SnAPI::Renderer::ShadowViewBuildDesc::PunctualLights {}

See also SnAPI::Renderer::ShadowViewBuildDesc, SnAPI::Renderer::PunctualShadowLight.

SnAPI::Renderer::ShadowViewBuildDesc::PunctualFaceBudget

std::size_t SnAPI::Renderer::ShadowViewBuildDesc::PunctualFaceBudget {}

See also SnAPI::Renderer::ShadowViewBuildDesc.

SnAPI::Renderer::ShadowSystem

class SnAPI::Renderer::ShadowSystem

SnAPI::Renderer::ShadowSystem::DirectionalLightRotation

static Matrix4 SnAPI::Renderer::ShadowSystem::DirectionalLightRotation(const Vec3 &directionWorld) noexcept

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::Matrix4, SnAPI::Renderer::Vec3.

SnAPI::Renderer::ShadowSystem::Settings

const ShadowSystemSettings & SnAPI::Renderer::ShadowSystem::Settings() const noexcept

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystem::SetSettings

void SnAPI::Renderer::ShadowSystem::SetSettings(const ShadowSystemSettings &settings) noexcept

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::ShadowSystemSettings.

SnAPI::Renderer::ShadowSystem::BuildDirectionalShadowPlan

DirectionalShadowPlan SnAPI::Renderer::ShadowSystem::BuildDirectionalShadowPlan(const DirectionalShadowBuildDesc &desc) const

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::DirectionalShadowBuildDesc, SnAPI::Renderer::DirectionalShadowPlan.

SnAPI::Renderer::ShadowSystem::BuildPunctualShadowPlan

std::optional< PunctualShadowPlan > SnAPI::Renderer::ShadowSystem::BuildPunctualShadowPlan(const PunctualShadowLight &light, std::size_t faceBudget=6) const

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::PunctualShadowLight, SnAPI::Renderer::PunctualShadowPlan.

SnAPI::Renderer::ShadowSystem::BuildAreaCenterShadowPlan

std::optional< PunctualShadowPlan > SnAPI::Renderer::ShadowSystem::BuildAreaCenterShadowPlan(const AreaShadowLight &light, std::size_t packedIndex) const

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::AreaShadowLight, SnAPI::Renderer::PunctualShadowPlan.

SnAPI::Renderer::ShadowSystem::BuildViewShadowPlan

ShadowViewPlan SnAPI::Renderer::ShadowSystem::BuildViewShadowPlan(const ShadowViewBuildDesc &desc) const

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::ShadowViewBuildDesc, SnAPI::Renderer::ShadowViewPlan.

SnAPI::Renderer::ShadowSystem::BuildCasterSummaries

static std::vector< ShadowCasterSummary > SnAPI::Renderer::ShadowSystem::BuildCasterSummaries(const RasterPacketSubmissionPlan &submissionPlan)

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::RasterPacketSubmissionPlan, SnAPI::Renderer::ShadowCasterSummary.

SnAPI::Renderer::ShadowSystem::BuildCasterSummaries

static std::vector< ShadowCasterSummary > SnAPI::Renderer::ShadowSystem::BuildCasterSummaries(std::span< const StaticMeshInstancingBatch > batches)

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::ShadowCasterSummary, SnAPI::Renderer::StaticMeshInstancingBatch.

SnAPI::Renderer::ShadowSystem::SummarizeCasters

static ShadowSceneMobilitySummary SnAPI::Renderer::ShadowSystem::SummarizeCasters(std::span< const ShadowCasterSummary > casters) noexcept

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::ShadowCasterSummary, SnAPI::Renderer::ShadowSceneMobilitySummary.

SnAPI::Renderer::ShadowSystem::SelectCachePolicy

static EShadowCachePolicy SnAPI::Renderer::ShadowSystem::SelectCachePolicy(ERenderMobility lightMobility, const ShadowSceneMobilitySummary &casterMobility) noexcept

See also SnAPI::Renderer::ShadowSystem, SnAPI::Renderer::ERenderMobility, SnAPI::Renderer::EShadowCachePolicy, SnAPI::Renderer::ShadowSceneMobilitySummary.