Skip to main content

ProcessSheetOptions

Struct ProcessSheetOptions 

Source
pub struct ProcessSheetOptions {
Show 21 fields pub input: PathBuf, pub output_dir: PathBuf, pub rows: u32, pub cols: u32, pub cell_size: u32, pub bg_hex: String, pub threshold: u8, pub edge_threshold: u8, pub fit_scale: f32, pub trim_border: u32, pub edge_clean_depth: u32, pub align: FrameAlign, pub shared_scale: bool, pub component_mode: ComponentMode, pub component_padding: u32, pub min_component_area: u32, pub edge_touch_margin: u32, pub reject_edge_touch: bool, pub gif_delay: u16, pub frame_labels: Option<Vec<String>>, pub prompt: Option<String>,
}
Expand description

Options for postprocessing a magenta-backed sprite sheet into normalized frames.

Fields§

§input: PathBuf

Input sprite-sheet image path.

§output_dir: PathBuf

Output directory where all generated files will be written.

§rows: u32

Number of rows in the source grid.

§cols: u32

Number of columns in the source grid.

§cell_size: u32

Output square cell size for each exported frame.

§bg_hex: String

RGB background color to remove, usually magenta.

§threshold: u8

Distance threshold used for chroma-key removal.

§edge_threshold: u8

More permissive edge cleanup threshold used for boundary flood fill.

§fit_scale: f32

Scale multiplier applied after fit-to-cell sizing.

§trim_border: u32

Number of pixels trimmed from each frame border before component analysis.

§edge_clean_depth: u32

Number of outer pixel layers cleaned to suppress border noise.

§align: FrameAlign

Vertical placement policy in the output cell.

§shared_scale: bool

Use a shared scale across all frames when true.

§component_mode: ComponentMode

Component selection strategy.

§component_padding: u32

Extra padding applied around the selected component bounding box.

§min_component_area: u32

Minimum connected-component area to consider during analysis.

§edge_touch_margin: u32

Margin used when deciding whether content touches a source cell edge.

§reject_edge_touch: bool

Fail processing when any source frame touches the cell edge.

§gif_delay: u16

GIF frame duration in centiseconds.

§frame_labels: Option<Vec<String>>

Optional logical frame labels. Length must equal rows * cols when provided.

§prompt: Option<String>

Optional prompt text to persist as prompt-used.txt.

Trait Implementations§

Source§

impl Clone for ProcessSheetOptions

Source§

fn clone(&self) -> ProcessSheetOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProcessSheetOptions

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.