Struct SliceOptions 

pub struct SliceOptions {

    pub input: PathBuf,
    pub output: PathBuf,
    pub frame_width: u32,
    pub frame_height: u32,
    pub columns: Option<u32>,
    pub rows: Option<u32>,
    pub offset_x: u32,
    pub offset_y: u32,
    pub gap_x: u32,
    pub gap_y: u32,
    pub skip_empty: bool,
    pub alpha_threshold: u8,
    pub min_opaque_pixels: u32,
    pub bg_hex: Option<String>,
    pub bg_threshold: u8,
    pub manifest_name: String,
}

Options for slicing a regular sprite sheet into fixed-size frames.

Fields

input: PathBuf

Input sprite sheet path.

output: PathBuf

Output directory where frames and manifests will be written.

frame_width: u32

Width of a single frame.

frame_height: u32

Height of a single frame.

columns: Option<u32>

Number of columns in the sheet. When None, the value is derived.

rows: Option<u32>

Number of rows in the sheet. When None, the value is derived.

offset_x: u32

Horizontal offset from the left edge of the sheet.

offset_y: u32

Vertical offset from the top edge of the sheet.

gap_x: u32

Horizontal gap between frames.

gap_y: u32

Vertical gap between frames.

skip_empty: bool

When true, frames below min_opaque_pixels are not exported.

alpha_threshold: u8

Pixels with alpha less than or equal to this value count as transparent.

min_opaque_pixels: u32

Minimum number of foreground pixels required to keep a frame.

bg_hex: Option<String>

Optional background color used to ignore solid-color backdrops.

bg_threshold: u8

Allowed per-channel distance when comparing to bg_hex.

manifest_name: String

Output file name for the manifest, usually frames.toml.

Trait Implementations

impl Clone for SliceOptions

fn clone(&self) -> SliceOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SliceOptions

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

Formats the value using the given formatter.