Struct rusty_spine::SkeletonBinary

pub struct SkeletonBinary { /* private fields */ }

A loader for Spine binary files.

Spine API Reference

Implementations

impl SkeletonBinary

pub fn new(atlas: Arc<Atlas>) -> Self

Create a new Binary loader using the default atlas attachment loader.

use std::sync::Arc;
use rusty_spine::{AnimationState, AnimationStateData, Atlas, SpineError, Skeleton, SkeletonBinary};

fn load_skeleton() -> Result<(Skeleton, AnimationState), SpineError> {
    let atlas = Arc::new(Atlas::new_from_file("spineboy.atlas")?);
    let skeleton_binary = SkeletonBinary::new(atlas);
    let skeleton_data = Arc::new(skeleton_binary.read_skeleton_data_file("spineboy.skel")?);
    let animation_state_data = AnimationStateData::new(skeleton_data.clone());
    // ... prepare animation state (see AnimationStateData docs) ...
    let skeleton = Skeleton::new(skeleton_data);
    let animation_state = AnimationState::new(Arc::new(animation_state_data));
    Ok((skeleton, animation_state))
}

pub fn read_skeleton_data( &self, data: &[u8] ) -> Result<SkeletonData, SpineError>

Read the Spine skeleton binary data in-memory. See SkeletonBinary::new for a full example.

Errors

Returns SpineError::ParsingFailed if parsing of the binary data failed.

pub fn read_skeleton_data_file<P: AsRef<Path>>( &self, path: P ) -> Result<SkeletonData, SpineError>

Read the Spine skeleton binary data from a file. See SkeletonBinary::new for a full example.

Errors

Returns SpineError::ParsingFailed if parsing of the binary data failed. Returns SpineError::NulError if path contains an internal 0 byte. Returns SpineError::PathNotUtf8 if the specified path is not utf-8.

pub fn scale(&self) -> f32

Scales bone positions, image sizes, and translations as they are loaded. This allows different size images to be used at runtime than were used in Spine.

See Scaling in the Spine Runtimes Guide.

pub fn set_scale(&mut self, value: f32)

Sets the scaling of this skeleton, see scale.

pub const fn c_ptr(&self) -> *mut spSkeletonBinary

Get a pointer to the underlying spine-c type.

Trait Implementations

impl Debug for SkeletonBinary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for SkeletonBinary

fn drop(&mut self)

Executes the destructor for this type.