Struct gif::Frame

source · [−]

pub struct Frame<'a> {
    pub delay: u16,
    pub dispose: DisposalMethod,
    pub transparent: Option<u8>,
    pub needs_user_input: bool,
    pub top: u16,
    pub left: u16,
    pub width: u16,
    pub height: u16,
    pub interlaced: bool,
    pub palette: Option<Vec<u8>>,
    pub buffer: Cow<'a, [u8]>,
}

Expand description

A GIF frame

Fields

delay: u16

Frame delay in units of 10 ms.

dispose: DisposalMethod

Disposal method.

transparent: Option<u8>

Transparent index (if available).

needs_user_input: bool

True if the frame needs user input to be displayed.

top: u16

Offset from the top border of the canvas.

left: u16

Offset from the left border of the canvas.

width: u16

Width of the frame.

height: u16

Height of the frame.

interlaced: bool

True if the image is interlaced.

palette: Option<Vec<u8>>

Frame local color palette if available.

buffer: Cow<'a, [u8]>

Buffer containing the image data. Only indices unless configured differently.

Implementations

source

impl Frame<'static>

source

pub fn from_rgba(width: u16, height: u16, pixels: &mut [u8 ]) -> Frame<'static>

Creates a frame from pixels in RGBA format.

This is a lossy method. The gif format does not support arbitrary alpha but only a 1-bit transparency mask per pixel. Any non-zero alpha value will be interpreted as a fully opaque pixel. Additionally, only 256 colors can appear in a single frame. The palette will be reduced by the NeuQuant algorithm if necessary. Different frames have independent palettes.

Note: This method is not optimized for speed.

Panics:

If the length of pixels does not equal width * height * 4.

source

pub fn from_rgba_speed(
 width: u16,
 height: u16,
 pixels: &mut [u8 ],
 speed: i32
) -> Frame<'static>

Creates a frame from pixels in RGBA format.

speed is a value in the range [1, 30]. The higher the value the faster it runs at the cost of image quality. A speed of 10 is a good compromise between speed and quality.

This is a lossy method. The gif format does not support arbitrary alpha but only a 1-bit transparency mask per pixel. Any non-zero alpha value will be interpreted as a fully opaque pixel. Additionally, only 256 colors can appear in a single frame. The palette will be reduced by the NeuQuant algorithm if necessary. Different frames have independent palettes.

Panics:

If the length of pixels does not equal width * height * 4.
If speed < 1 or speed > 30

source

pub fn from_palette_pixels(
 width: u16,
 height: u16,
 pixels: &[u8 ],
 palette: &[u8 ],
 transparent: Option<u8>
) -> Frame<'static>

Creates a frame from a palette and indexed pixels.

Panics:

If the length of pixels does not equal width * height.
If the length of palette > 256 * 3.

source

pub fn from_indexed_pixels(
 width: u16,
 height: u16,
 pixels: &[u8 ],
 transparent: Option<u8>
) -> Frame<'static>

Creates a frame from indexed pixels in the global palette.

Panics:

If the length of pixels does not equal width * height.

source

pub fn from_rgb(width: u16, height: u16, pixels: &[u8 ]) -> Frame<'static>

Creates a frame from pixels in RGB format.

This is a lossy method. In the gif format only 256 colors can appear in a single frame. The palette will be reduced by the NeuQuant algorithm if necessary. Different frames have independent palettes.

Note: This method is not optimized for speed.

Panics:

If the length of pixels does not equal width * height * 3.

source

pub fn from_rgb_speed(
 width: u16,
 height: u16,
 pixels: &[u8 ],
 speed: i32
) -> Frame<'static>

Creates a frame from pixels in RGB format.

speed is a value in the range [1, 30].

This is a lossy method. In the gif format only 256 colors can appear in a single frame. The palette will be reduced by the NeuQuant algorithm if necessary. Different frames have independent palettes.

The higher the value the faster it runs at the cost of image quality. A speed of 10 is a good compromise between speed and quality.

Panics:

If the length of pixels does not equal width * height * 3.
If speed < 1 or speed > 30

Trait Implementations

source

impl<'a> Clone for Frame<'a>

source

fn clone(&self) -> Frame<'a>

Returns a copy of the value. Read more

impl<'a> Send for Frame<'a>

impl<'a> Sync for Frame<'a>

impl<'a> Unpin for Frame<'a>

pub 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct gif::Frame

Fields

Implementations

impl Frame<'static>

pub fn from_rgba(width: u16, height: u16, pixels: &mut [u8]) -> Frame<'static>

pub fn from_rgba_speed( width: u16, height: u16, pixels: &mut [u8], speed: i32) -> Frame<'static>

pub fn from_palette_pixels( width: u16, height: u16, pixels: &[u8], palette: &[u8], transparent: Option<u8>) -> Frame<'static>

pub fn from_indexed_pixels( width: u16, height: u16, pixels: &[u8], transparent: Option<u8>) -> Frame<'static>

pub fn from_rgb(width: u16, height: u16, pixels: &[u8]) -> Frame<'static>

pub fn from_rgb_speed( width: u16, height: u16, pixels: &[u8], speed: i32) -> Frame<'static>

Trait Implementations

impl<'a> Clone for Frame<'a>

fn clone(&self) -> Frame<'a>

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

impl<'a> Debug for Frame<'a>

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

impl<'a> Default for Frame<'a>

fn default() -> Frame<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for Frame<'a>

impl<'a> Send for Frame<'a>

impl<'a> Sync for Frame<'a>

impl<'a> Unpin for Frame<'a>

impl<'a> UnwindSafe for Frame<'a>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

pub fn from_rgba(width: u16, height: u16, pixels: &mut [u8 ]) -> Frame<'static>

pub fn from_rgba_speed(
width: u16,
height: u16,
pixels: &mut [u8 ],
speed: i32
) -> Frame<'static>

pub fn from_palette_pixels(
width: u16,
height: u16,
pixels: &[u8 ],
palette: &[u8 ],
transparent: Option<u8>
) -> Frame<'static>

pub fn from_indexed_pixels(
width: u16,
height: u16,
pixels: &[u8 ],
transparent: Option<u8>
) -> Frame<'static>

pub fn from_rgb(width: u16, height: u16, pixels: &[u8 ]) -> Frame<'static>

pub fn from_rgb_speed(
width: u16,
height: u16,
pixels: &[u8 ],
speed: i32
) -> Frame<'static>

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

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

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

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

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

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

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