Skip to main content

ModularImage

Struct ModularImage 

Source
pub struct ModularImage {
    pub channels: Vec<Channel>,
    pub bit_depth: u32,
    pub is_grayscale: bool,
    pub has_alpha: bool,
}
Expand description

A modular image consisting of multiple channels.

For RGB images, this typically contains 3 channels. For RGBA, 4 channels (with alpha stored last).

Fields§

§channels: Vec<Channel>

The channels in this image.

§bit_depth: u32

Bit depth of the original image.

§is_grayscale: bool

Whether the image is originally grayscale.

§has_alpha: bool

Whether the image has alpha.

Implementations§

Source§

impl ModularImage

Source

pub fn from_rgb8(data: &[u8], width: usize, height: usize) -> Result<Self>

Creates a new modular image from 8-bit RGB data.

Source

pub fn from_rgba8(data: &[u8], width: usize, height: usize) -> Result<Self>

Creates a new modular image from 8-bit RGBA data.

Source

pub fn from_gray8(data: &[u8], width: usize, height: usize) -> Result<Self>

Creates a new modular image from 8-bit grayscale data.

Source

pub fn from_rgb16(data: &[u8], width: usize, height: usize) -> Result<Self>

Creates a new modular image from 16-bit RGB data (big-endian).

Source

pub fn from_rgb16_native( data: &[u8], width: usize, height: usize, ) -> Result<Self>

Creates a new modular image from native-endian 16-bit RGB data.

Input is a byte slice interpreted as &[u16] in native endian order (6 bytes per pixel: R_lo, R_hi, G_lo, G_hi, B_lo, B_hi on little-endian).

Source

pub fn from_rgba16_native( data: &[u8], width: usize, height: usize, ) -> Result<Self>

Creates a new modular image from native-endian 16-bit RGBA data.

Input is 8 bytes per pixel (R, G, B, A as native-endian u16).

Source

pub fn from_gray16_native( data: &[u8], width: usize, height: usize, ) -> Result<Self>

Creates a new modular image from native-endian 16-bit grayscale data.

Input is 2 bytes per pixel (native-endian u16).

Source

pub fn width(&self) -> usize

Returns the width of the image.

Source

pub fn height(&self) -> usize

Returns the height of the image.

Source

pub fn num_channels(&self) -> usize

Returns the number of channels.

Source

pub fn channel(&self, idx: usize) -> &Channel

Returns a reference to a channel.

Source

pub fn channel_mut(&mut self, idx: usize) -> &mut Channel

Returns a mutable reference to a channel.

Source

pub fn extract_region( &self, x_start: usize, y_start: usize, x_end: usize, y_end: usize, ) -> Result<Self>

Extracts a rectangular region from the image.

Creates a new ModularImage containing only the pixels within the specified bounds. Used for multi-group encoding.

Trait Implementations§

Source§

impl Clone for ModularImage

Source§

fn clone(&self) -> ModularImage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ModularImage

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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 = Infallible

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

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

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.