Small docs PR for PointLightShadowMap
/DirectionalLightShadowMap
(#18768)
# Objective - Improve the docs for `PointLightShadowMap` and `DirectionalLightShadowMap` ## Solution - Add example for how to use `PointLightShadowMap` and move the `DirectionalLightShadowMap` example from `DirectionalLight`. - Match `PointLight` and `DirectionalLight` docs about shadows. - Describe what `size` means. --------- Co-authored-by: Robert Swain <robert.swain@gmail.com>
This commit is contained in:
parent
ee7b624024
commit
ea69012799
@ -41,14 +41,7 @@ use super::*;
|
|||||||
/// To modify the cascade setup, such as the number of cascades or the maximum shadow distance,
|
/// To modify the cascade setup, such as the number of cascades or the maximum shadow distance,
|
||||||
/// change the [`CascadeShadowConfig`] component of the entity with the [`DirectionalLight`].
|
/// change the [`CascadeShadowConfig`] component of the entity with the [`DirectionalLight`].
|
||||||
///
|
///
|
||||||
/// To control the resolution of the shadow maps, use the [`DirectionalLightShadowMap`] resource:
|
/// To control the resolution of the shadow maps, use the [`DirectionalLightShadowMap`] resource.
|
||||||
///
|
|
||||||
/// ```
|
|
||||||
/// # use bevy_app::prelude::*;
|
|
||||||
/// # use bevy_pbr::DirectionalLightShadowMap;
|
|
||||||
/// App::new()
|
|
||||||
/// .insert_resource(DirectionalLightShadowMap { size: 2048 });
|
|
||||||
/// ```
|
|
||||||
#[derive(Component, Debug, Clone, Reflect)]
|
#[derive(Component, Debug, Clone, Reflect)]
|
||||||
#[reflect(Component, Default, Debug, Clone)]
|
#[reflect(Component, Default, Debug, Clone)]
|
||||||
#[require(
|
#[require(
|
||||||
|
@ -91,9 +91,21 @@ pub mod light_consts {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Controls the resolution of [`PointLight`] shadow maps.
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// # use bevy_app::prelude::*;
|
||||||
|
/// # use bevy_pbr::PointLightShadowMap;
|
||||||
|
/// App::new()
|
||||||
|
/// .insert_resource(PointLightShadowMap { size: 2048 });
|
||||||
|
/// ```
|
||||||
#[derive(Resource, Clone, Debug, Reflect)]
|
#[derive(Resource, Clone, Debug, Reflect)]
|
||||||
#[reflect(Resource, Debug, Default, Clone)]
|
#[reflect(Resource, Debug, Default, Clone)]
|
||||||
pub struct PointLightShadowMap {
|
pub struct PointLightShadowMap {
|
||||||
|
/// The width and height of each of the 6 faces of the cubemap.
|
||||||
|
|
||||||
|
///
|
||||||
|
/// Defaults to `1024`.
|
||||||
pub size: usize,
|
pub size: usize,
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -108,9 +120,19 @@ impl Default for PointLightShadowMap {
|
|||||||
pub type WithLight = Or<(With<PointLight>, With<SpotLight>, With<DirectionalLight>)>;
|
pub type WithLight = Or<(With<PointLight>, With<SpotLight>, With<DirectionalLight>)>;
|
||||||
|
|
||||||
/// Controls the resolution of [`DirectionalLight`] shadow maps.
|
/// Controls the resolution of [`DirectionalLight`] shadow maps.
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// # use bevy_app::prelude::*;
|
||||||
|
/// # use bevy_pbr::DirectionalLightShadowMap;
|
||||||
|
/// App::new()
|
||||||
|
/// .insert_resource(DirectionalLightShadowMap { size: 4096 });
|
||||||
|
/// ```
|
||||||
#[derive(Resource, Clone, Debug, Reflect)]
|
#[derive(Resource, Clone, Debug, Reflect)]
|
||||||
#[reflect(Resource, Debug, Default, Clone)]
|
#[reflect(Resource, Debug, Default, Clone)]
|
||||||
pub struct DirectionalLightShadowMap {
|
pub struct DirectionalLightShadowMap {
|
||||||
|
// The width and height of each cascade.
|
||||||
|
///
|
||||||
|
/// Defaults to `2048`.
|
||||||
pub size: usize,
|
pub size: usize,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -19,6 +19,12 @@ use super::*;
|
|||||||
/// | 4000 | 300 | | 75-100 | 40.5 |
|
/// | 4000 | 300 | | 75-100 | 40.5 |
|
||||||
///
|
///
|
||||||
/// Source: [Wikipedia](https://en.wikipedia.org/wiki/Lumen_(unit)#Lighting)
|
/// Source: [Wikipedia](https://en.wikipedia.org/wiki/Lumen_(unit)#Lighting)
|
||||||
|
///
|
||||||
|
/// ## Shadows
|
||||||
|
///
|
||||||
|
/// To enable shadows, set the `shadows_enabled` property to `true`.
|
||||||
|
///
|
||||||
|
/// To control the resolution of the shadow maps, use the [`PointLightShadowMap`] resource.
|
||||||
#[derive(Component, Debug, Clone, Copy, Reflect)]
|
#[derive(Component, Debug, Clone, Copy, Reflect)]
|
||||||
#[reflect(Component, Default, Debug, Clone)]
|
#[reflect(Component, Default, Debug, Clone)]
|
||||||
#[require(
|
#[require(
|
||||||
|
Loading…
Reference in New Issue
Block a user