Struct Image

pub struct Image { /* private fields */ }

Implementations

impl Image

pub fn new(shape: Shape, colorspace: ColorSpace) -> Self

pub fn from_data(data: Vec<u8>, shape: Shape, colorspace: ColorSpace) -> Self

pub fn swap(&mut self, idx_a: usize, idx_b: usize)

pub fn slice(&self, start: usize, end: usize) -> &[u8]

pub fn mut_slice(&mut self, start: usize, end: usize) -> &mut [u8]

pub fn width(&self) -> usize

pub fn height(&self) -> usize

pub fn size(&self) -> usize

pub fn crop(&self, topleft: Point, shape: Shape) -> Self

pub fn get_index(&self, point: &Point) -> Result<usize, Error>

Calculates the 1D Index based on the provided (x, y) Just wraps get_index_from_xy for sake of convenience

Arguments

• Point - Point containing desired x and y

Returns

• usize containing Index if within bounds, otherwise Error

pub fn get_index_from_xy(&self, x: usize, y: usize) -> Result<usize, Error>

Compute 1D Index (row-major) when provided with the x, y coordinate, width and channel value.

Arguments

• x - The x coordinate (should be between 0 - width of Image)
• y - The y coordinate (should be between 0 - height of Image)

Returns

• usize containing Index if within bounds, otherwise Error

pub fn get_pixel(&self, point: &Point) -> &[u8]

Return a slize of 1 pixel (including all channels)

Arguments

• x - The x coordinate
• y - The y coordinate

Returns

• An immutable &u8

pub fn get_mut_pixel(&mut self, point: &Point) -> &mut [u8]

Same as get_pixel but just a mutable reference

pub fn set_pixel(&mut self, point: &Point, color: &Color) -> Result<(), Error>

Trait Implementations

impl Clone for Image

fn clone(&self) -> Image

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Image

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

Formats the value using the given formatter.

impl Drawable<CircleParams> for Image

fn draw(&mut self, params: &CircleParams) -> Result<(), Error>

Draw a circle on the Image using the Midpoint Circle Algorithm.

impl Drawable<RectParams> for Image

fn draw(&mut self, params: &RectParams) -> Result<(), Error>

Draw a rectangle on the Image

impl Encoder for Image

fn encode(&self, codec: Codex) -> Result<Vec<u8>, Error>

impl Index<(usize, usize)> for Image

Overriding [] for 2D indexing.

Returns an immutable reference to a given pixel

type Output = [u8]

The returned type after indexing.

fn index(&self, (x, y): Index2D) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<(usize, usize, usize)> for Image

Overriding [] for 3D indexing. This is useful when you want to modify a specific channel For example, to modify green channel, image[(2, 2, 1)] = 255 Where 1 = the channel number.

See ColorSpace for more information on Channel Numbers

type Output = u8

The returned type after indexing.

fn index(&self, (x, y, c): Index3D) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Image

Overriding [] for 1D indexing.

Returns an immutable reference to the requested Index

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<(usize, usize)> for Image

fn index_mut(&mut self, (x, y): Index2D) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<(usize, usize, usize)> for Image

fn index_mut(&mut self, (x, y, c): Index3D) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Image

Overriding [] for 1D indexing.

Returns a mutable reference to the requested Index

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Reader for Image

fn read(path: &str, codex: Codex) -> Result<Image, Error>

impl Resizable<BiCubicParams> for Image

fn resize(&mut self, shape: Shape) -> Result<(), Error>

impl Resizable<BiLinearParams> for Image

fn resize(&mut self, shape: Shape) -> Result<(), Error>

impl Resizable<NearestNeighborParams> for Image

fn resize(&mut self, shape: Shape) -> Result<(), Error>

impl Rotatable<RotationType> for Image

fn rotate(&mut self, value: RotationType) -> Result<(), Error>

Perform in-place rotation.

impl Rotatable<i32> for Image

fn rotate(&mut self, value: i32) -> Result<(), Error>

impl Writer for Image

fn write(&self, path: String, codec: Codex) -> Result<(), Error>