Struct openexr::core::preview_image::PreviewImage

#[repr(transparent)]
pub struct PreviewImage(_);

A usually small, low-dynamic range image, that is intended to be stored in an image file’s header

Implementations

impl PreviewImage

pub fn empty() -> Result<PreviewImage, Error>

Creates a new PreviewImage with dimensions width = 0 and height = 0

Errors

• Error::Base - If an error occurs

pub fn with_dimensions(width: u32, height: u32) -> Result<PreviewImage, Error>

Creates a new PreviewImage with the provided dimensions

Errors

• Error::Overflow - If the size of the image is bigger than the supported size
• Error::Base - If an error occurs

pub fn with_pixels(
    width: u32,
    height: u32,
    pixels: &[PreviewRgba]
) -> Result<PreviewImage, Error>

Creates a new PreviewImage with the provided dimensions and pixels

Errors

• Error::Overflow - If the size of the image is bigger than the supported size
• Error::Base - If an error occurs

pub fn width(&self) -> u32

Returns the width of the PreviewImage

pub fn height(&self) -> u32

Returns the height of the PreviewImage

pub fn pixels<'a>(&'a self) -> &'a [PreviewRgba]

Get the image pixels as a slice

pub fn mut_pixels<'a>(&'a mut self) -> &'a mut [PreviewRgba]

Get the image pixels as a mutable slice

pub fn set_pixel(
    &mut self,
    x: u32,
    y: u32,
    value: PreviewRgba
) -> Result<(), Error>

Sets the pixel value at the specified coordinates

Errors

• Error::OutOfRange - If the coordinates are outside of the image size
• Error::Base - If an error occurs

pub fn get_pixel(&self, x: u32, y: u32) -> Option<PreviewRgba>

Gets the pixel value at the specified coordinates

Returns None if the coordinates are outside of the image size, or some other error ocurred

Trait Implementations

impl Clone for PreviewImage

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for PreviewImage

fn drop(&mut self)

Executes the destructor for this type.

impl OpaquePtr for PreviewImage

type SysPointee = Imf_PreviewImage_t

type Pointee = PreviewImage