Skip to main content

ImageRef

Struct ImageRef 

Source
pub struct ImageRef<'a> { /* private fields */ }
Expand description

A borrowed, validated view of pixels to encode.

Rows run top to bottom with no padding between them. 16-bit samples are big-endian byte pairs (PNG’s own order); 1-, 2- and 4-bit grey samples are packed most significant bits first, each row starting on a fresh byte.

use pltrs_codec::png::{BitDepth, ColorType, ImageRef};

let pixels = [0u8; 3 * 2 * 4];
let image = ImageRef::rgba8(3, 2, &pixels)?;
assert_eq!(image.row_bytes(), 12);

// Two 16-bit grey pixels: 0x0102 and 0xFFFF.
let image = ImageRef::new(2, 1, ColorType::Gray, BitDepth::Sixteen, &[1, 2, 0xFF, 0xFF])?;
assert!(ImageRef::rgba8(3, 3, &pixels).is_err());

Implementations§

Source§

impl<'a> ImageRef<'a>

Source

pub fn new( width: u32, height: u32, color: ColorType, bit_depth: BitDepth, data: &'a [u8], ) -> Result<Self, EncodeError>

Wraps data as a width × height image in the given format.

The encoder supports grey at every bit depth and grey + alpha, RGB and RGBA at 8 or 16 bits; indexed images are not supported.

Source

pub fn rgba8( width: u32, height: u32, data: &'a [u8], ) -> Result<Self, EncodeError>

Wraps 8-bit RGBA pixels (4 bytes per pixel), the format of rendered figures.

Source

pub fn rgb8( width: u32, height: u32, data: &'a [u8], ) -> Result<Self, EncodeError>

Wraps 8-bit RGB pixels (3 bytes per pixel).

Source

pub const fn width(&self) -> u32

Width in pixels.

Source

pub const fn height(&self) -> u32

Height in pixels.

Source

pub const fn color_type(&self) -> ColorType

Colour type of the pixels.

Source

pub const fn bit_depth(&self) -> BitDepth

Bits per sample.

Source

pub const fn data(&self) -> &'a [u8] ⓘ

The pixel bytes.

Source

pub fn row_bytes(&self) -> usize

Bytes per row.

Trait Implementations§

Source§

impl<'a> Clone for ImageRef<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for ImageRef<'a>

Source§

impl<'a> Debug for ImageRef<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for ImageRef<'a>

Source§

impl<'a> PartialEq for ImageRef<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for ImageRef<'a>

Auto Trait Implementations§

§

impl<'a> Forget for ImageRef<'a>

§

impl<'a> Freeze for ImageRef<'a>

§

impl<'a> Move for ImageRef<'a>

§

impl<'a> RefUnwindSafe for ImageRef<'a>

§

impl<'a> Send for ImageRef<'a>

§

impl<'a> Sync for ImageRef<'a>

§

impl<'a> Unpin for ImageRef<'a>

§

impl<'a> UnsafeUnpin for ImageRef<'a>

§

impl<'a> UnwindSafe for ImageRef<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.