Struct Image 

pub struct Image<'t> { /* private fields */ }

Available on crate feature kitty-graphics only.

Opaque reference to a Kitty graphics image.

Obtained via Graphics::image with an image ID. The reference is borrowed from the storage with lifetime 't and remains valid until the next mutating terminal call.

Implementations

impl<'t> Image<'t>

pub fn id(&self) -> Result<u32>

The image ID.

pub fn number(&self) -> Result<u32>

The image number.

pub fn width(&self) -> Result<u32>

Image width in pixels.

pub fn height(&self) -> Result<u32>

Image height in pixels.

pub fn generation(&self) -> Result<u64>

Generation stamp assigned when this image was added to or replaced in the storage.

A changed generation for a given image ID means the pixel contents may have changed even when the dimensions, format, and data length are identical, for example a retransmission of the same image ID, so texture caches must key staleness on this value rather than on size heuristics.

Stamps are unique and monotonically increasing process-wide and are drawn from the same sequence as Graphics::generation. Never zero for a stored image, so zero can be used as an empty sentinel by callers.

pub fn format(&self) -> Result<ImageFormat>

Pixel format of the image.

pub fn compression(&self) -> Result<Compression>

Compression of the image.

pub fn data(&self) -> Result<&'t [u8]>

Borrowed pointer to the raw pixel data.

Valid as long as the underlying terminal is not mutated.

Trait Implementations

impl<'t> Debug for Image<'t>

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

Formats the value using the given formatter.