Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-12-04 02:19:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add documentation aliases

Browse source
This commit is contained in:
Marco Buono 2023-04-16 18:43:45 -03:00
parent 0dadf4e48d
commit ef04badefb
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
crates/bevy_pbr/src/pbr_material.rs
View file

@ -155,6 +155,7 @@ pub struct StandardMaterial {
///
/// **Note:** Typically used in conjunction with [`StandardMaterial::thickness`]. To avoid self-shadows on complicated
/// mesh shapes without having to fine tune the thickness, consider using the [`NotTransmittedShadowReceiver`](crate::light::NotTransmittedShadowReceiver) component.
#[doc(alias = "translucency")]
pub diffuse_transmission: f32,
/// A map that modulates diffuse transmission via its **A channel**. Multiplied by [`StandardMaterial::diffuse_transmission`]
@ -186,6 +187,7 @@ pub struct StandardMaterial {
/// The material's [`StandardMaterial::base_color`] also modulates the transmitted light.
///
/// **Note:** Typically used in conjunction with [`StandardMaterial::thickness`] and [`StandardMaterial::ior`].
#[doc(alias = "refraction")]
pub transmission: f32,
/// A map that modulates specular transmission via its **R channel**. Multiplied by [`StandardMaterial::transmission`]
@ -214,6 +216,8 @@ pub struct StandardMaterial {
///
/// **Note:** Typically used in conjunction with [`StandardMaterial::transmission`] and [`StandardMaterial::ior`], or with
/// [`StandardMaterial::diffuse_transmission`].
#[doc(alias = "volume")]
#[doc(alias = "thin_walled")]
pub thickness: f32,
/// A map that modulates thickness via its G channel. Multiplied by [`StandardMaterial::thickness`]