Struct SkinningPlugin 

pub struct SkinningPlugin { /* private fields */ }

Handle to the GPU skinning deformer.

Returned by SkinningPlugin::install. Holds the assigned DeformerId plus a marker set tracking which meshes have had weights attached, so Self::is_skinned_mesh can answer without going through the registry. Clone-cheap: the marker set is shared.

Implementations

impl SkinningPlugin

pub fn install( resources: &mut DeviceResources, device: &Device, ) -> ViewportResult<Self>

Register the skinning deformer with the renderer.

Call once at startup before uploading any skin data. Composes the LBS body into the mesh shader family and validates the result through wgpu’s error scope.

Errors

Propagates the registry error if shader composition or validation fails (extremely unlikely for the shipped body, which is covered by unit tests).

pub fn deformer_id(&self) -> DeformerId

The DeformerId assigned to skinning on install.

pub fn attach_weights( &self, resources: &mut DeviceResources, device: &Device, mesh_id: MeshId, weights: &SkinWeights, )

Attach per-vertex skin weights to an uploaded mesh.

Marks the mesh as skinnable and packs the weights into the deformer’s per-mesh slot. Calling again on the same mesh replaces the prior weights buffer.

pub fn begin_upload_weights( &self, resources: &mut DeviceResources, device: &Device, mesh_id: MeshId, weights: SkinWeights, ) -> JobId

Start an asynchronous skin-weights upload.

Returns a JobId immediately. The packed weight stream is computed on a worker thread; buffer creation runs on the main thread during the next process_uploads call after the worker finishes.

pub fn attach_palette( &self, resources: &mut DeviceResources, device: &Device, queue: &Queue, mesh_id: MeshId, instance_id: u32, palette: &[Mat4], ) -> bool

Upload the joint palette for one instance of a skinned mesh.

instance_id lets multiple skinned instances of one bind-pose mesh coexist. For single-instance meshes pass 0. Returns false if Self::attach_weights has not been called for mesh_id.

palette[i] is the object-space skinning matrix for joint i produced by [crate::JointMatrices::compute]: the joint’s skeleton-local transform multiplied by its inverse bind. The mesh’s object.model is applied separately at draw time, so the palette composes with the scene node transform rather than replacing it.

pub fn is_skinned_mesh(&self, mesh_id: MeshId) -> bool

Whether mesh_id has been marked as skinnable via Self::attach_weights.

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

Detach the skin weights attached to mesh_id and unmark it as skinnable.

Reverses attach_weights: reclaims the per-mesh weight buffer and drops the mesh from the skinnable set, so it renders as a static mesh afterward (the deformer branch gates off once its slot has no data). Returns true if weights were removed, false if the mesh had none. Any joint palettes attached for the mesh become inert; reclaim them with detach_palette or by freeing the mesh.

pub fn detach_palette( &self, resources: &mut DeviceResources, device: &Device, queue: &Queue, mesh_id: MeshId, instance_id: u32, ) -> bool

Detach the joint palette for one instance of a skinned mesh.

Reverses attach_palette for a single (mesh_id, instance_id) pair, reclaiming that palette buffer. Returns true if a palette was removed, false if none was attached. Leaves the mesh’s weight slot and skinnable marker in place.

pub fn uninstall(self, resources: &mut DeviceResources, device: &Device)

Tear down every per-mesh skin buffer attached through this handle.

Detaches the weight slot of every mesh marked skinnable and clears the marker set, reclaiming that GPU memory. Consumes the handle: its lifecycle is install -> attach_weights / attach_palette (or the begin_upload_weights / event forms) -> uninstall.

The deformer body itself stays registered for the session: DeformerId is an append-only registry slot, so a later install returns the same id at no cost. Per-instance palettes are keyed by (mesh, instance) and are not tracked here; reclaim them with detach_palette or by freeing the meshes before uninstalling if their buffers must go immediately.

Trait Implementations

impl Clone for SkinningPlugin

fn clone(&self) -> SkinningPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.