Skip to main content

WaterParams

Struct WaterParams 

Source
#[repr(C)]
pub struct WaterParams {
Show 13 fields pub centre: [f32; 4], pub deep_colour: [f32; 4], pub shallow_colour: [f32; 4], pub depth_falloff: f32, pub foam_width: f32, pub foam_intensity: f32, pub fresnel_power: f32, pub roughness: f32, pub refraction_strength: f32, pub wave_count: u32, pub _pad: f32, pub waves: [WaterWaveGpu; 4], pub planar: [f32; 4],
}
Expand description

Per-surface tunables for a WaterSurface, uploaded once per surface. The vec3-ish fields are [f32; 4] so the layout is byte-identical to the shader’s float4. Matches WaterParams in shaders/water.slang. 224 bytes.

Fields§

§centre: [f32; 4]

[x, y, z, _]: world-space surface centre.

§deep_colour: [f32; 4]

[r, g, b, _]: water tint at full column depth.

§shallow_colour: [f32; 4]

[r, g, b, _]: water tint just above the seabed.

§depth_falloff: f32

Depth over which the tint blends from shallow to deep, in metres.

§foam_width: f32

Width of the shoreline foam band, in world units.

§foam_intensity: f32

Foam brightness multiplier.

§fresnel_power: f32

Exponent of the Fresnel reflectance curve.

§roughness: f32

Perceptual roughness in [0, 1]; picks the reflection’s prefilter mip.

§refraction_strength: f32

How far refraction offsets the sampled background.

§wave_count: u32

Live entries in waves.

§_pad: f32

Padding so the field layout matches the shader-side struct.

§waves: [WaterWaveGpu; 4]

Wave coefficients; the first wave_count entries are live.

§planar: [f32; 4]

Planar reflection control: [strength, distortion, _, _]. strength > 0.5 selects the sharp planar reflection (the scene re-rendered mirrored across this surface’s rest plane, sampled at screen UV) over the probe / sky cube; distortion scales the wave-normal ripple offset of that lookup. 0 when planar is off (RT on, no planar slot, or the plane overflowed the budget), keeping the probe / sky path.

Trait Implementations§

Source§

impl Clone for WaterParams

Source§

fn clone(&self) -> WaterParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for WaterParams

Source§

impl NoUninit for WaterParams

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.