Struct gift::block::ImageDesc

pub struct ImageDesc { /* private fields */ }

The image descriptor block contains properties which apply to one frame.

use gift::block::{
    ColorTableConfig, ColorTableExistence, ColorTableOrdering, ImageDesc,
};

let desc = ImageDesc::default()
    .with_width(64)
    .with_height(64)
    .with_color_table_config(ColorTableConfig::new(
        ColorTableExistence::Present,
        ColorTableOrdering::NotSorted,
        16,
    ));

Implementations

impl ImageDesc

pub fn with_left(self, left: u16) -> Self

Set the left position

pub fn left(&self) -> u16

Get the left position

pub fn with_top(self, top: u16) -> Self

Set the top position

pub fn top(&self) -> u16

Get the top position

pub fn with_width(self, width: u16) -> Self

Set the width

pub fn width(&self) -> u16

Get the width

pub fn with_height(self, height: u16) -> Self

Set the height

pub fn height(&self) -> u16

Get the height

pub fn with_flags(self, flags: u8) -> Self

Set the flags which control the interlace value and the local color table configuration.

It is recommended to use with_interlaced or with_color_table_config instead.

pub fn flags(&self) -> u8

Get the flags which control the interlace value and the local color table configuration.

pub fn with_interlaced(self, interlaced: bool) -> Self

Set the interlaced flag

pub fn interlaced(&self) -> bool

Get the interlaced flag

pub fn color_table_config(&self) -> ColorTableConfig

Get the local color table configuration

pub fn with_color_table_config(self, tbl: ColorTableConfig) -> Self

Set the local color table configuration

pub fn image_sz(&self) -> usize

Get the image size (bytes)

Trait Implementations

impl Clone for ImageDesc

fn clone(&self) -> ImageDesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageDesc

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

Formats the value using the given formatter.

impl Default for ImageDesc

fn default() -> ImageDesc

Returns the “default value” for a type.

impl From<ImageDesc> for Block

fn from(b: ImageDesc) -> Self

Converts to this type from the input type.

impl PartialEq for ImageDesc

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

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

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

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

impl Copy for ImageDesc

impl Eq for ImageDesc

impl StructuralEq for ImageDesc

impl StructuralPartialEq for ImageDesc