Struct FrameOptionsMetal

#[repr(C)]
pub struct FrameOptionsMetal {
    pub clear_history: bool,
    pub frame_direction: i32,
    pub rotation: u32,
    pub total_subframes: u32,
    pub current_subframe: u32,
    pub aspect_ratio: f32,
    pub frames_per_second: f32,
    pub frametime_delta: u32,
}

Options for each frame.

Fields

clear_history: bool

Whether or not to clear the history buffers.

frame_direction: i32

The direction of rendering. -1 indicates that the frames are played in reverse order.

rotation: u32

The rotation of the output. 0 = 0deg, 1 = 90deg, 2 = 180deg, 3 = 270deg.

total_subframes: u32

The total number of subframes ran. Default is 1.

current_subframe: u32

The current sub frame. Default is 1.

aspect_ratio: f32

The expected aspect ratio of the source image.

This can differ from the actual aspect ratio of the source image.

The default is 0 which will automatically infer the ratio from the source image.

frames_per_second: f32

The original frames per second of the source. Default is 1.

frametime_delta: u32

Time in milliseconds between the current and previous frame. Default is 0.

Trait Implementations

impl Clone for FrameOptionsMetal

fn clone(&self) -> FrameOptionsMetal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameOptionsMetal

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

Formats the value using the given formatter.

impl Default for FrameOptionsMetal

fn default() -> Self

Returns the “default value” for a type.