Struct Image 

pub struct Image<T = ()>(/* private fields */);

Native Wolfram Image_WL or Image3D_WL.

Use UninitImage::new_2d() to construct a new 2-dimensional image.

Implementations

impl<T: ImageData> Image<T>

pub fn as_slice(&self) -> &[T::STORAGE]

Access the data in this Image as a flat buffer.

The returned slice will have a length equal to flattened_length().

Examples found in repository

examples/tests/test_images.rs (line 11)

fn test_image_arg(image: &Image<bool>) -> NumericArray<i8> {
    let mut array = UninitNumericArray::from_dimensions(&[image.flattened_length()]);

    for pair in image
        .as_slice()
        .iter()
        .zip(array.as_slice_mut().into_iter())
    {
        let (pixel, elem): (&i8, &mut std::mem::MaybeUninit<i8>) = pair;
        elem.write(*pixel);
    }

    // Safety: We iterated over every element in `array` and initialized it with the
    //         corresponding pixel value from `image`.
    unsafe { array.assume_init() }
}

pub fn get(&self, pixel: Pixel, channel: usize) -> Option<T>

Get the value of the specified pixel and channel.

Example

Get the value of the second channel of the top-left pixel in an image.

// let image: Image<u8> = ...

let value: u8 = image.get(Pixel::D2([0, 0]), 2).unwrap();

In an RGB image, this is the value of the green channel for this pixel.

In an HSB image, this is the value of the saturation for this pixel.

impl<T> Image<T>

pub fn flattened_length(&self) -> usize

The number of elements in the underlying flat data buffer.

LibraryLink C API Documentation: MImage_getFlattenedLength

Examples found in repository

examples/tests/test_images.rs (line 8)

fn test_image_arg(image: &Image<bool>) -> NumericArray<i8> {
    let mut array = UninitNumericArray::from_dimensions(&[image.flattened_length()]);

    for pair in image
        .as_slice()
        .iter()
        .zip(array.as_slice_mut().into_iter())
    {
        let (pixel, elem): (&i8, &mut std::mem::MaybeUninit<i8>) = pair;
        elem.write(*pixel);
    }

    // Safety: We iterated over every element in `array` and initialized it with the
    //         corresponding pixel value from `image`.
    unsafe { array.assume_init() }
}

pub fn channels(&self) -> usize

LibraryLink C API Documentation: MImage_getChannels

pub fn rank(&self) -> usize

LibraryLink C API Documentation: MImage_getRank

pub fn row_count(&self) -> usize

LibraryLink C API Documentation: MImage_getRowCount

pub fn column_count(&self) -> usize

LibraryLink C API Documentation: MImage_getColumnCount

pub fn slice_count(&self) -> usize

LibraryLink C API Documentation: MImage_getSliceCount

pub fn color_space(&self) -> ColorSpace

Get the color space of this image.

LibraryLink C API Documentation: MImage_getColorSpace

pub fn color_space_raw(&self) -> colorspace_t

LibraryLink C API Documentation: MImage_getColorSpace

pub fn data_type(&self) -> ImageType

Get the data type of this image.

pub fn data_type_raw(&self) -> imagedata_t

LibraryLink C API Documentation: MImage_getDataType

pub fn has_alpha_channel(&self) -> bool

LibraryLink C API Documentation: MImage_alphaChannelQ

pub fn is_interleaved(&self) -> bool

LibraryLink C API Documentation: MImage_interleavedQ

pub fn share_count(&self) -> usize

Returns the share count of this Image.

If this Image is not shared, the share count is 0.

If this Image was passed into the current library “by reference” due to use of the Automatic or "Constant" memory management strategy, that reference is not reflected in the share_count().

LibraryLink C API Documentation: MImage_shareCount

pub unsafe fn from_raw(raw: MImage) -> Image<T>

Construct an Image from a raw MImage.

pub unsafe fn into_raw(self) -> MImage

Extract the raw MImage instance from this Image.

pub unsafe fn as_raw(&self) -> MImage

pub unsafe fn raw_data(&self) -> *mut c_void

LibraryLink C API Documentation: MImage_getRawData

Trait Implementations

impl<T: Debug> Debug for Image<T>

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

Formats the value using the given formatter.

impl<'a, T: ImageData> FromArg<'a> for &'a Image<T>

unsafe fn from_arg(arg: &'a MArgument) -> &'a Image<T>

fn parameter_type() -> Expr

Return the LibraryLink parameter type as a Wolfram Language expression.

impl<'a, T: ImageData> FromArg<'a> for Image<T>

unsafe fn from_arg(arg: &'a MArgument) -> Image<T>

fn parameter_type() -> Expr

Return the LibraryLink parameter type as a Wolfram Language expression.

impl<'a> FromArg<'a> for &'a Image<()>

unsafe fn from_arg(arg: &'a MArgument) -> &'a Image<()>

fn parameter_type() -> Expr

Return the LibraryLink parameter type as a Wolfram Language expression.

impl<'a> FromArg<'a> for Image<()>

unsafe fn from_arg(arg: &'a MArgument) -> Image<()>

fn parameter_type() -> Expr

Return the LibraryLink parameter type as a Wolfram Language expression.

impl<T: ImageData> IntoArg for Image<T>

unsafe fn into_arg(self, arg: MArgument)

Move self into arg.

fn return_type() -> Expr

Return the LibraryLink return type as a Wolfram Language expression.

impl<T> RefCast for Image<T>

type From = *mut IMAGEOBJ_ENTRY

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self