Struct RenderImage 

pub struct RenderImage {
    pub id: ImageId,
    /* private fields */
}

A decoded image: one or more frames of BGRA pixels, ready to draw.

Create one with RenderImage::new. Two images are equal when their ImageIds are equal. Still images have one frame. Animated images have one frame per step of the animation.

Fields

id: ImageId

The ID that identifies this image. See ImageId.

Implementations

impl RenderImage

pub fn new(data: impl Into<SmallVec<[Frame; 1]>>) -> Self

Creates an image from decoded frames, with a new ImageId.

The frames are moved in, not copied. Pass a SmallVec<[Frame; 1]>, or anything that converts into one, such as a Vec<Frame>.

Examples

use image::{Frame, ImageBuffer, Rgba};

let pixels = ImageBuffer::from_pixel(2, 3, Rgba([255u8, 0, 0, 255]));
let image = RenderImage::new(vec![Frame::new(pixels)]);

assert_eq!(image.frame_count(), 1);
assert_eq!(image.as_bytes(0).map(|bytes| bytes.len()), Some(2 * 3 * 4));

pub fn as_bytes(&self, frame_index: usize) -> Option<&[u8]>

Returns the pixels of frame frame_index as BGRA bytes, four per pixel, with rows packed and no padding.

Returns None if there is no such frame.

pub fn size(&self, frame_index: usize) -> Size<DevicePixels>

Returns the size of frame frame_index in device pixels. Returns zero for a missing frame.

pub fn delay(&self, frame_index: usize) -> Delay

Returns how long to show frame frame_index before the next one. Returns 100 ms for a missing frame.

pub fn frame_count(&self) -> usize

Returns the number of frames. A still image has one. A GIF or animated WebP has one per frame.

Trait Implementations

impl Debug for RenderImage

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

Formats the value using the given formatter.

impl Eq for RenderImage

impl PartialEq for RenderImage

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

Equality operator ==.

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

Inequality operator !=.