Struct WindPlugin 

pub struct WindPlugin { /* private fields */ }

Wind plugin handle.

Typical setup:

let wind = WindPlugin::new(WindAuthoring::default());
wind.install(&mut resources, &device)?;

let runtime = ViewportRuntime::new()
    .with_plugin(wind.cpu_plugin())
    .with_gpu_plugin(wind.gpu_plugin());

// For each grass / banner / branch mesh:
let mask = WindSwayWeights::height_falloff(&positions, 0.0, top_y);
wind.attach_sway_mask(&mut resources, &device, mesh_id, &mask)?;

The CPU half advances the wind clock during runtime.step(). The GPU half writes the current field state into the deformer’s slot params during runtime.pre_prepare() so every wind-affected mesh sees the same global field that frame.

Implementations

impl WindPlugin

pub fn new(authoring: WindAuthoring) -> Self

Create a new plugin with the given authoring values. Call Self::install before either trait-object half runs.

pub fn install( &self, resources: &mut DeviceResources, device: &Device, ) -> Result<DeformerId, ViewportError>

Register the wind deformer against viewport-lib’s mesh shader family.

Composes the deformer body into every mesh-family shader, allocates a registry slot, and stashes a handle the GPU half uses each frame to push the wind state into the slot’s slot_params.

Returns the assigned DeformerId in case the host wants to reference the slot directly.

pub fn attach_sway_mask( &self, resources: &mut DeviceResources, device: &Device, mesh_id: MeshId, weights: &WindSwayWeights, ) -> bool

Attach a sway mask to one mesh. The mask’s length must equal the mesh’s vertex count.

Returns false and does nothing if Self::install has not run yet.

pub fn detach_sway_mask( &self, resources: &mut DeviceResources, device: &Device, mesh_id: MeshId, ) -> bool

Detach the sway mask from one mesh.

pub fn attach_material_params( &self, resources: &mut DeviceResources, device: &Device, queue: &Queue, mesh_id: MeshId, params: &WindMaterialParams, ) -> bool

Attach per-mesh material multipliers (strength / density / speed).

Optional. Meshes that only have a sway mask attached use defaults of 1.0 across the board, matching the shipped global formula. Hosts that import per-material wind params from their content pipeline (e.g. Unity _WindStrength, _WindDensity, _WindSpeed) call this once after Self::attach_sway_mask for each mesh.

Per-(mesh, instance) under the hood; for hosts that don’t care about multiple instances per mesh, instance_id = 0 is the convention and is what the shader body reads.

Returns false and does nothing if Self::install has not run.

pub fn cpu_plugin(&self) -> impl RuntimePlugin

Trait object for the CPU half. Runs at phase::PREPARE.

pub fn gpu_plugin(&self) -> impl GpuPlugin

Trait object for the GPU half. Runs at gpu_phase::PRE_PREPARE.

pub fn set_authoring(&self, authoring: WindAuthoring)

Replace the authoring values. The wind clock is preserved.

pub fn field(&self) -> WindField

Snapshot the field for CPU consumers. Returns a clone so the caller can sample without holding the lock for the read.