Struct Image 

pub struct Image<T, L = C1> { /* private fields */ }

RAII owner for pitched image memory allocated by NPP.

Values are created through Image::create and released with sys::nppiFree from Drop. The raw pointer must not be freed by callers. step is the NPP row pitch in bytes and can be larger than the logical ROI row size.

Implementations

impl<T, L> Image<T, L>

where L: ChannelLayout,

pub fn create(size: Size) -> Result<Self>

where T: SupportedImage<L>,

pub fn copy_to_device_memory(&self) -> Result<DeviceMemory<T>>

pub fn copy_to_host_vec(&self) -> Result<Vec<T>>

pub fn copy_into_device_memory( &self, destination: &mut DeviceMemory<T>, ) -> Result<()>

pub const fn size(&self) -> Size

Returns the image ROI size requested at allocation time.

pub const fn step(&self) -> i32

Returns the NPP row pitch in bytes.

pub fn view(&self) -> Result<ImageView<'_, T, L>>

Borrows this allocation as an immutable NPP image view.

Errors

Returns an error if the stored size or pitch is not valid for an NPP image view.

pub fn view_mut(&mut self) -> Result<ImageViewMut<'_, T, L>>

Borrows this allocation as a mutable NPP image view.

Errors

Returns an error if the stored size or pitch is not valid for an NPP image view.

pub const fn as_ptr(&self) -> *const T

Returns the raw device pointer owned by this allocation.

The pointer remains owned by self and is freed with nppiFree when the Image is dropped.

pub const fn as_mut_ptr(&mut self) -> *mut T

Returns the mutable raw device pointer owned by this allocation.

The pointer remains owned by self and is freed with nppiFree when the Image is dropped.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<T, L> Drop for Image<T, L>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.