Skip to content

Commit 9827f42

Browse files
committed
add simple doc strings for GpuAtmosphere and ExtractedAtmosphere
1 parent bc194d3 commit 9827f42

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

crates/bevy_pbr/src/atmosphere/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,8 @@ impl ExtractComponent for Atmosphere {
268268
}
269269
}
270270

271+
/// The render-world representation of an `Atmosphere`, but which
272+
/// hasn't been converted into shader uniforms yet.
271273
#[derive(Clone, Component)]
272274
pub struct ExtractedAtmosphere {
273275
pub bottom_radius: f32,

crates/bevy_pbr/src/atmosphere/resources.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -520,8 +520,10 @@ pub(super) fn prepare_atmosphere_textures(
520520
#[error("ScatteringMedium missing with id {0:?}: make sure the asset was not removed.")]
521521
struct ScatteringMediumMissingError(AssetId<ScatteringMedium>);
522522

523+
/// The shader-uniform representation of an Atmosphere.
523524
#[derive(Clone, Component, ShaderType)]
524525
pub struct GpuAtmosphere {
526+
//TODO: rename to Planet later?
525527
pub ground_albedo: Vec3,
526528
pub bottom_radius: f32,
527529
pub top_radius: f32,

0 commit comments

Comments
 (0)