Struct immeta::formats::gif::GraphicControlExtension

pub struct GraphicControlExtension {
    pub disposal_method: DisposalMethod,
    pub user_input: bool,
    pub transparent_color_index: Option<u8>,
    pub delay_time: u16,
}

Contains metadata for a graphic control extension block.

This block usually leads an image descriptor block and contains information on how this image should be displayed. It is especially important for animated GIF images because it contains delay and disposal method flags.

Fields

disposal_method: DisposalMethod

Indicates how the graphic should be treated after it is displayed.

See DisposalMethod enum documentation for more information.

user_input: bool

Whether or not user input is required before continuing.

How this flag is treated depends on a application.

transparent_color_index: Option<u8>

Specifies "transparent" color in a color table, if available.

"Transparent" color makes the decoder ignore a pixel and go on to the next one.

delay_time: u16

Defines the delay before processing the rest of the GIF stream.

The value is specified in one hundredths of a second. Use delay_time_ms() method to obtain a more conventional time representation.

If zero, it means that there is no delay time.

Methods

impl GraphicControlExtension

pub fn delay_time_ms(&self) -> u32

Returns delay time in milliseconds.

See delay_time field description.

Trait Implementations

impl Clone for GraphicControlExtension

fn clone(&self) -> GraphicControlExtension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for GraphicControlExtension

fn eq(&self, __arg_0: &GraphicControlExtension) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &GraphicControlExtension) -> bool

This method tests for !=.

impl Eq for GraphicControlExtension

impl Debug for GraphicControlExtension

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.