Module sprite

Module sprite 

Source
Expand description

Unity Sprite processing module

This module provides comprehensive Sprite processing capabilities, organized following UnityPy and unity-rs best practices.

§Architecture

The module is organized into several sub-modules:

  • types - Core data structures (Sprite, SpriteRenderData, etc.)
  • parser - Sprite parsing from Unity objects
  • processor - High-level sprite processing and image extraction

§Examples

use unity_asset_decode::sprite::{SpriteProcessor, SpriteConfig};
use unity_asset_decode::unity_version::UnityVersion;

// Create processor with custom configuration
let version = UnityVersion::parse_version("2020.3.12f1")?;
let config = SpriteConfig {
    extract_images: true,
    process_atlas: true,
    max_sprite_size: Some((2048, 2048)),
    apply_transformations: true,
};
let processor = SpriteProcessor::with_config(version, config);

// Note: In real usage, you would create a UnityObject from parsed data
// For demonstration, we'll just show the processor creation
println!("Sprite processed successfully");

Re-exports§

pub use parser::SpriteParser;
pub use processor::SpriteProcessor;
pub use processor::SpriteStats;
pub use types::Sprite;
pub use types::SpriteAtlas;
pub use types::SpriteBorder;
pub use types::SpriteConfig;
pub use types::SpriteInfo;
pub use types::SpriteOffset;
pub use types::SpritePivot;
pub use types::SpriteRect;
pub use types::SpriteRenderData;
pub use types::SpriteResult;
pub use types::SpriteSettings;

Modules§

parser
Sprite parsing implementation
processor
Sprite processing implementation
types
Sprite type definitions

Structs§

ProcessingOptions
Sprite processing options
SpriteManager
Main sprite processing facade

Functions§

create_full_manager
Create a sprite manager with full features
create_manager
Convenience functions for common operations Create a sprite manager with default settings
create_performance_manager
Create a sprite manager optimized for performance
extract_sprite_image
Extract sprite image from texture (convenience function)
get_recommended_config
Get recommended sprite configuration for Unity version
get_sprite_area
Get sprite area in pixels
get_sprite_aspect_ratio
Get sprite aspect ratio
is_atlas_sprite
Check if sprite is from atlas
is_nine_slice_sprite
Check if sprite is 9-slice
is_sprite_feature_supported
Check if Unity version supports sprite feature
parse_sprite
Parse sprite from Unity object (convenience function)
validate_sprite
Validate sprite data (convenience function)