Struct apriltag::image_buf::Image

#[repr(transparent)]
pub struct Image { /* private fields */ }

The single-channel image with pixels in bytes.

Implementations

impl Image

pub unsafe fn new_uinit(width: usize, height: usize) -> Result<Self, Error>

Give width and height and create an uninitialized image.

Safety

After the image is returned, the caller must explicitly initialize the image buffer.

pub unsafe fn new_uinit_with_stride(
    width: usize,
    height: usize,
    stride: usize
) -> Result<Self, Error>

Give width, height and stride and create an uninitialized image.

Safety

After the image is returned, the caller must explicitly initialize the image buffer.

pub fn from_pnm_file(path: &str) -> Result<Self, Error>

Create an image from a PNM file.

pub fn from_pnm_file_with_alignment(
    path: &str,
    alignment: usize
) -> Result<Self, Error>

Create an image from a PNM file with a specified alignment.

pub fn zeros_with_stride(
    width: usize,
    height: usize,
    stride: usize
) -> Result<Self, Error>

Create a zerod image.

The stride must be more than or equal to width. Otherwise it returns None.

pub fn zeros_with_alignment(
    width: usize,
    height: usize,
    alignment: usize
) -> Result<Self, Error>

Create a zerod image.

The alignment must be non-zero. Otherwise it returns None.

pub fn samples_iter(&self) -> impl Iterator<Item = u8> + '_

Create an iterator traversing pixels in row-major order.

pub fn indexed_samples_iter(
    &self
) -> impl Iterator<Item = (usize, usize, u8)> + '_

Create an iterator that traverses pixels with pixel positions in row-major order.

The iterator item is in (x, y, pixel_value) format.

pub fn width(&self) -> usize

Gets the image width.

pub fn height(&self) -> usize

Gets the image height.

pub fn stride(&self) -> usize

Gets the per-row stride in bytes.

pub fn as_slice(&self) -> &[u8]

Get the pixel buffer with size height*stride.

pub fn as_slice_mut(&mut self) -> &mut [u8]

Get the mutable pixel buffer with size height*stride.

pub unsafe fn from_raw(ptr: *mut image_u8_t) -> Self

Creates an instance from pointer.

The pointer will be managed by the type. Do not run manual deallocation on the pointer. Panics if the pointer is null.

Safety

The method is safe when the pointer was created by image_u8_create_stride or image_u8_create_alignment.

pub fn into_raw(self) -> NonNull<image_u8_t>

Returns the underlying pointer.

Trait Implementations

impl AsMut<[u8]> for Image

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Image

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Image

fn clone(&self) -> Self

Returns a copy 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 Drop for Image

fn drop(&mut self)

Executes the destructor for this type.

impl Index<(usize, usize)> for Image

type Output = u8

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<(usize, usize)> for Image

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

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