Struct SpriteSheet 

#[non_exhaustive]
pub struct SpriteSheet {
    pub format: String,
    pub file_prefix: String,
    pub sprite_width_pixels: i32,
    pub sprite_height_pixels: i32,
    pub column_count: i32,
    pub row_count: i32,
    pub start_time_offset: Option<Duration>,
    pub end_time_offset: Option<Duration>,
    pub quality: i32,
    pub extraction_strategy: Option<ExtractionStrategy>,
    /* private fields */
}

Sprite sheet configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

format: String

Format type. The default is jpeg.

Supported formats:

• jpeg

file_prefix: String

Required. File name prefix for the generated sprite sheets.

Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as sprite_sheet0000000123.jpeg.

sprite_width_pixels: i32

Required. The width of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_width_pixels field or the SpriteSheet.sprite_height_pixels field, but not both (the API will automatically calculate the missing field).

For portrait videos that contain horizontal ASR and rotation metadata, provide the width, in pixels, per the horizontal ASR. The API calculates the height per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

sprite_height_pixels: i32

Required. The height of sprite in pixels. Must be an even integer. To preserve the source aspect ratio, set the SpriteSheet.sprite_height_pixels field or the SpriteSheet.sprite_width_pixels field, but not both (the API will automatically calculate the missing field).

For portrait videos that contain horizontal ASR and rotation metadata, provide the height, in pixels, per the horizontal ASR. The API calculates the width per the horizontal ASR. The API detects any rotation metadata and swaps the requested height and width for the output.

column_count: i32

The maximum number of sprites per row in a sprite sheet. The default is 0, which indicates no maximum limit.

row_count: i32

The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. The default is 0, which indicates no maximum limit.

start_time_offset: Option<Duration>

Start time in seconds, relative to the output file timeline. Determines the first sprite to pick. The default is 0s.

end_time_offset: Option<Duration>

End time in seconds, relative to the output file timeline. When end_time_offset is not specified, the sprites are generated until the end of the output file.

quality: i32

The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.

extraction_strategy: Option<ExtractionStrategy>

Specify either total number of sprites or interval to create sprites.

Implementations

impl SpriteSheet

pub fn new() -> Self

pub fn set_format<T: Into<String>>(self, v: T) -> Self

Sets the value of format.

pub fn set_file_prefix<T: Into<String>>(self, v: T) -> Self

Sets the value of file_prefix.

pub fn set_sprite_width_pixels<T: Into<i32>>(self, v: T) -> Self

Sets the value of sprite_width_pixels.

pub fn set_sprite_height_pixels<T: Into<i32>>(self, v: T) -> Self

Sets the value of sprite_height_pixels.

pub fn set_column_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of column_count.

pub fn set_row_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of row_count.

pub fn set_start_time_offset<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of start_time_offset.

pub fn set_or_clear_start_time_offset<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of start_time_offset.

pub fn set_end_time_offset<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of end_time_offset.

pub fn set_or_clear_end_time_offset<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of end_time_offset.

pub fn set_quality<T: Into<i32>>(self, v: T) -> Self

Sets the value of quality.

pub fn set_extraction_strategy<T: Into<Option<ExtractionStrategy>>>( self, v: T, ) -> Self

Sets the value of extraction_strategy.

Note that all the setters affecting extraction_strategy are mutually exclusive.

pub fn total_count(&self) -> Option<&i32>

The value of extraction_strategy if it holds a TotalCount, None if the field is not set or holds a different branch.

pub fn set_total_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of extraction_strategy to hold a TotalCount.

Note that all the setters affecting extraction_strategy are mutually exclusive.

pub fn interval(&self) -> Option<&Box<Duration>>

The value of extraction_strategy if it holds a Interval, None if the field is not set or holds a different branch.

pub fn set_interval<T: Into<Box<Duration>>>(self, v: T) -> Self

Sets the value of extraction_strategy to hold a Interval.

Note that all the setters affecting extraction_strategy are mutually exclusive.

Trait Implementations

impl Clone for SpriteSheet

fn clone(&self) -> SpriteSheet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteSheet

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

Formats the value using the given formatter.

impl Default for SpriteSheet

fn default() -> SpriteSheet

Returns the “default value” for a type.

impl Message for SpriteSheet

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SpriteSheet

fn eq(&self, other: &SpriteSheet) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SpriteSheet