Struct GpuMat

pub struct GpuMat { /* private fields */ }

Base storage class for GPU memory with reference counting.

Its interface matches the Mat interface with the following limitations:

• no arbitrary dimensions support (only 2D)
• no functions that return references to their data (because references on GPU are not valid for CPU)
• no expression templates technique support

Beware that the latter limitation may lead to overloaded matrix operators that cause memory allocations. The GpuMat class is convertible to cuda::PtrStepSz and cuda::PtrStep so it can be passed directly to the kernel.

Note: In contrast with Mat, in most cases GpuMat::isContinuous() == false . This means that rows are aligned to a size depending on the hardware. Single-row GpuMat is always a continuous matrix.

Note: You are not recommended to leave static or global GpuMat variables allocated, that is, to rely on its destructor. The destruction order of such variables and CUDA context is undefined. GPU memory release function returns error if the CUDA context has been destroyed before.

Some member functions are described as a “Blocking Call” while some are described as a “Non-Blocking Call”. Blocking functions are synchronous to host. It is guaranteed that the GPU operation is finished when the function returns. However, non-blocking functions are asynchronous to host. Those functions may return even if the GPU operation is not finished.

Compared to their blocking counterpart, non-blocking functions accept Stream as an additional argument. If a non-default stream is passed, the GPU operation may overlap with operations in other streams.

See also

Mat

Implementations

impl GpuMat

pub fn default_allocator() -> Result<AbstractRefMut<'static, GpuMat_Allocator>>

default allocator

pub unsafe fn set_default_allocator( allocator: &mut impl GpuMat_AllocatorTrait, ) -> Result<()>

pub unsafe fn new(allocator: &mut impl GpuMat_AllocatorTrait) -> Result<GpuMat>

default constructor

C++ default parameters

• allocator: GpuMat::defaultAllocator()

pub fn new_def() -> Result<GpuMat>

default constructor

Note

This alternative version of [new] function uses the following default values for its arguments:

• allocator: GpuMat::defaultAllocator()

pub unsafe fn new_rows_cols( rows: i32, cols: i32, typ: i32, allocator: &mut impl GpuMat_AllocatorTrait, ) -> Result<GpuMat>

constructs GpuMat of the specified size and type

C++ default parameters

• allocator: GpuMat::defaultAllocator()

pub fn new_rows_cols_def(rows: i32, cols: i32, typ: i32) -> Result<GpuMat>

constructs GpuMat of the specified size and type

Note

This alternative version of [new_rows_cols] function uses the following default values for its arguments:

• allocator: GpuMat::defaultAllocator()

pub unsafe fn new_size( size: Size, typ: i32, allocator: &mut impl GpuMat_AllocatorTrait, ) -> Result<GpuMat>

C++ default parameters

• allocator: GpuMat::defaultAllocator()

pub fn new_size_def(size: Size, typ: i32) -> Result<GpuMat>

Note

This alternative version of [new_size] function uses the following default values for its arguments:

• allocator: GpuMat::defaultAllocator()

pub unsafe fn new_rows_cols_with_default( rows: i32, cols: i32, typ: i32, s: Scalar, allocator: &mut impl GpuMat_AllocatorTrait, ) -> Result<GpuMat>

constructs GpuMat and fills it with the specified value _s

C++ default parameters

• allocator: GpuMat::defaultAllocator()

pub fn new_rows_cols_with_default_def( rows: i32, cols: i32, typ: i32, s: Scalar, ) -> Result<GpuMat>

constructs GpuMat and fills it with the specified value _s

Note

This alternative version of [new_rows_cols_with_default] function uses the following default values for its arguments:

• allocator: GpuMat::defaultAllocator()

pub unsafe fn new_size_with_default( size: Size, typ: i32, s: Scalar, allocator: &mut impl GpuMat_AllocatorTrait, ) -> Result<GpuMat>

C++ default parameters

• allocator: GpuMat::defaultAllocator()

pub fn new_size_with_default_def( size: Size, typ: i32, s: Scalar, ) -> Result<GpuMat>

Note

This alternative version of [new_size_with_default] function uses the following default values for its arguments:

• allocator: GpuMat::defaultAllocator()

pub fn copy(m: &impl GpuMatTraitConst) -> Result<GpuMat>

copy constructor

pub unsafe fn new_rows_cols_with_data( rows: i32, cols: i32, typ: i32, data: *mut c_void, step: size_t, ) -> Result<GpuMat>

constructor for GpuMat headers pointing to user-allocated data

C++ default parameters

• step: Mat::AUTO_STEP

pub unsafe fn new_rows_cols_with_data_def( rows: i32, cols: i32, typ: i32, data: *mut c_void, ) -> Result<GpuMat>

constructor for GpuMat headers pointing to user-allocated data

Note

This alternative version of [new_rows_cols_with_data] function uses the following default values for its arguments:

• step: Mat::AUTO_STEP

pub unsafe fn new_size_with_data( size: Size, typ: i32, data: *mut c_void, step: size_t, ) -> Result<GpuMat>

C++ default parameters

• step: Mat::AUTO_STEP

pub unsafe fn new_size_with_data_def( size: Size, typ: i32, data: *mut c_void, ) -> Result<GpuMat>

Note

This alternative version of [new_size_with_data] function uses the following default values for its arguments:

• step: Mat::AUTO_STEP

pub fn rowscols( m: &impl GpuMatTraitConst, row_range: impl RangeTrait, col_range: impl RangeTrait, ) -> Result<BoxedRef<'_, GpuMat>>

creates a GpuMat header for a part of the bigger matrix

pub fn rowscols_mut( m: &mut impl GpuMatTrait, row_range: impl RangeTrait, col_range: impl RangeTrait, ) -> Result<BoxedRefMut<'_, GpuMat>>

creates a GpuMat header for a part of the bigger matrix

pub fn roi(m: &impl GpuMatTraitConst, roi: Rect) -> Result<BoxedRef<'_, GpuMat>>

pub fn roi_mut( m: &mut impl GpuMatTrait, roi: Rect, ) -> Result<BoxedRefMut<'_, GpuMat>>

pub unsafe fn from_hostmem( arr: &impl ToInputArray, allocator: &mut impl GpuMat_AllocatorTrait, ) -> Result<GpuMat>

builds GpuMat from host memory (Blocking call)

C++ default parameters

• allocator: GpuMat::defaultAllocator()

pub fn from_hostmem_def(arr: &impl ToInputArray) -> Result<GpuMat>

builds GpuMat from host memory (Blocking call)

Note

This alternative version of [from_hostmem] function uses the following default values for its arguments:

• allocator: GpuMat::defaultAllocator()

Trait Implementations

impl Boxed for GpuMat

unsafe fn from_raw(ptr: <GpuMat as OpenCVFromExtern>::ExternReceive) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <GpuMat as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <GpuMat as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut(&mut self) -> <GpuMat as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Clone for GpuMat

fn clone(&self) -> Self

Calls try_clone() and panics if that fails

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

Performs copy-assignment from source.

impl Debug for GpuMat

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

Formats the value using the given formatter.

impl Drop for GpuMat

fn drop(&mut self)

Executes the destructor for this type.

impl GpuMatTrait for GpuMat

fn as_raw_mut_GpuMat(&mut self) -> *mut c_void

fn set_flags(&mut self, val: i32)

! includes several bit-fields:

fn set_rows(&mut self, val: i32)

the number of rows and columns

fn set_cols(&mut self, val: i32)

the number of rows and columns

fn set_step(&mut self, val: size_t)

a distance between successive rows in bytes; includes the gap if any

fn data_mut(&mut self) -> *mut u8

pointer to the data

unsafe fn set_data(&mut self, val: *const u8)

pointer to the data

fn refcount_mut(&mut self) -> *mut i32

pointer to the reference counter; when GpuMat points to user-allocated data, the pointer is NULL

unsafe fn set_refcount(&mut self, val: *const i32)

pointer to the reference counter; when GpuMat points to user-allocated data, the pointer is NULL

fn datastart_mut(&mut self) -> *mut u8

helper fields used in locateROI and adjustROI

unsafe fn set_datastart(&mut self, val: *const u8)

helper fields used in locateROI and adjustROI

fn allocator(&mut self) -> AbstractRefMut<'_, GpuMat_Allocator>

allocator

unsafe fn set_allocator(&mut self, val: &impl GpuMat_AllocatorTraitConst)

allocator

fn set(&mut self, m: &impl GpuMatTraitConst) -> Result<()>

assignment operators

fn create(&mut self, rows: i32, cols: i32, typ: i32) -> Result<()>

allocates new GpuMat data unless the GpuMat already has specified size and type

fn create_1(&mut self, size: Size, typ: i32) -> Result<()>

fn release(&mut self) -> Result<()>

decreases reference counter, deallocate the data when reference counter reaches 0

fn swap(&mut self, mat: &mut impl GpuMatTrait) -> Result<()>

swaps with other smart pointer

fn upload(&mut self, arr: &impl ToInputArray) -> Result<()>

Performs data upload to GpuMat (Blocking call)

fn upload_async( &mut self, arr: &impl ToInputArray, stream: &mut impl StreamTrait, ) -> Result<()>

Performs data upload to GpuMat (Non-Blocking call)

fn set_to(&mut self, s: Scalar) -> Result<GpuMat>

sets some of the GpuMat elements to s (Blocking call)

fn set_to_1( &mut self, s: Scalar, stream: &mut impl StreamTrait, ) -> Result<GpuMat>

sets some of the GpuMat elements to s (Non-Blocking call)

fn set_to_2(&mut self, s: Scalar, mask: &impl ToInputArray) -> Result<GpuMat>

sets some of the GpuMat elements to s, according to the mask (Blocking call)

fn set_to_3( &mut self, s: Scalar, mask: &impl ToInputArray, stream: &mut impl StreamTrait, ) -> Result<GpuMat>

sets some of the GpuMat elements to s, according to the mask (Non-Blocking call)

fn ptr_mut(&mut self, y: i32) -> Result<*mut u8>

returns pointer to y-th row

fn ptr_mut_def(&mut self) -> Result<*mut u8>

returns pointer to y-th row

fn row_mut(&mut self, y: i32) -> Result<BoxedRefMut<'_, GpuMat>>

returns a new GpuMat header for the specified row

fn col_mut(&mut self, x: i32) -> Result<BoxedRefMut<'_, GpuMat>>

returns a new GpuMat header for the specified column

fn row_bounds_mut( &mut self, startrow: i32, endrow: i32, ) -> Result<BoxedRefMut<'_, GpuMat>>

… for the specified row span

fn row_range_mut( &mut self, r: impl RangeTrait, ) -> Result<BoxedRefMut<'_, GpuMat>>

fn col_bounds_mut( &mut self, startcol: i32, endcol: i32, ) -> Result<BoxedRefMut<'_, GpuMat>>

… for the specified column span

fn col_range_mut( &mut self, r: impl RangeTrait, ) -> Result<BoxedRefMut<'_, GpuMat>>

fn rowscols_mut( &mut self, row_range: impl RangeTrait, col_range: impl RangeTrait, ) -> Result<BoxedRefMut<'_, GpuMat>>

extracts a rectangular sub-GpuMat (this is a generalized form of row, rowRange etc.)

fn roi_mut(&mut self, roi: Rect) -> Result<BoxedRefMut<'_, GpuMat>>

fn reshape_def_mut(&mut self, cn: i32) -> Result<BoxedRefMut<'_, GpuMat>>

creates alternative GpuMat header for the same data, with different number of channels and/or different number of rows

fn reshape_mut(&mut self, cn: i32, rows: i32) -> Result<BoxedRefMut<'_, GpuMat>>

creates alternative GpuMat header for the same data, with different number of channels and/or different number of rows

fn adjust_roi( &mut self, dtop: i32, dbottom: i32, dleft: i32, dright: i32, ) -> Result<GpuMat>

moves/resizes the current GpuMat ROI inside the parent GpuMat

fn update_continuity_flag(&mut self) -> Result<()>

internal use method: updates the continuity flag

impl GpuMatTraitConst for GpuMat

fn as_raw_GpuMat(&self) -> *const c_void

fn flags(&self) -> i32

! includes several bit-fields:

fn rows(&self) -> i32

the number of rows and columns

fn cols(&self) -> i32

the number of rows and columns

fn step(&self) -> size_t

a distance between successive rows in bytes; includes the gap if any

fn data(&self) -> *const u8

pointer to the data

fn refcount(&self) -> *const i32

pointer to the reference counter; when GpuMat points to user-allocated data, the pointer is NULL

fn datastart(&self) -> *const u8

helper fields used in locateROI and adjustROI

fn dataend(&self) -> *const u8

fn download(&self, dst: &mut impl ToOutputArray) -> Result<()>

Performs data download from GpuMat (Blocking call)

fn download_async( &self, dst: &mut impl ToOutputArray, stream: &mut impl StreamTrait, ) -> Result<()>

Performs data download from GpuMat (Non-Blocking call)

fn try_clone(&self) -> Result<GpuMat>

returns deep copy of the GpuMat, i.e. the data is copied

fn copy_to(&self, dst: &mut impl ToOutputArray) -> Result<()>

copies the GpuMat content to device memory (Blocking call)

fn copy_to_gpu_mat(&self, dst: &mut impl GpuMatTrait) -> Result<()>

bindings overload which copies the GpuMat content to device memory (Blocking call)

fn copy_to_stream( &self, dst: &mut impl ToOutputArray, stream: &mut impl StreamTrait, ) -> Result<()>

copies the GpuMat content to device memory (Non-Blocking call)

fn copy_to_gpu_mat_stream( &self, dst: &mut impl GpuMatTrait, stream: &mut impl StreamTrait, ) -> Result<()>

bindings overload which copies the GpuMat content to device memory (Non-Blocking call)

fn copy_to_mask( &self, dst: &mut impl ToOutputArray, mask: &impl ToInputArray, ) -> Result<()>

copies those GpuMat elements to “m” that are marked with non-zero mask elements (Blocking call)

fn copy_to_gpu_mat_mask( &self, dst: &mut impl GpuMatTrait, mask: &mut impl GpuMatTrait, ) -> Result<()>

bindings overload which copies those GpuMat elements to “m” that are marked with non-zero mask elements (Blocking call)

fn copy_to_mask_stream( &self, dst: &mut impl ToOutputArray, mask: &impl ToInputArray, stream: &mut impl StreamTrait, ) -> Result<()>

copies those GpuMat elements to “m” that are marked with non-zero mask elements (Non-Blocking call)

fn copy_to_gpu_mat_mask_stream( &self, dst: &mut impl GpuMatTrait, mask: &mut impl GpuMatTrait, stream: &mut impl StreamTrait, ) -> Result<()>

bindings overload which copies those GpuMat elements to “m” that are marked with non-zero mask elements (Non-Blocking call)

fn convert_to(&self, dst: &mut impl ToOutputArray, rtype: i32) -> Result<()>

converts GpuMat to another datatype (Blocking call)

fn convert_to_1( &self, dst: &mut impl ToOutputArray, rtype: i32, stream: &mut impl StreamTrait, ) -> Result<()>

converts GpuMat to another datatype (Non-Blocking call)

fn convert_to_2( &self, dst: &mut impl GpuMatTrait, rtype: i32, stream: &mut impl StreamTrait, ) -> Result<()>

bindings overload which converts GpuMat to another datatype (Non-Blocking call)

fn convert_to_3( &self, dst: &mut impl ToOutputArray, rtype: i32, alpha: f64, beta: f64, ) -> Result<()>

converts GpuMat to another datatype with scaling (Blocking call)

fn convert_to_def( &self, dst: &mut impl ToOutputArray, rtype: i32, alpha: f64, ) -> Result<()>

converts GpuMat to another datatype with scaling (Blocking call)

fn convert_to_4( &self, dst: &mut impl GpuMatTrait, rtype: i32, alpha: f64, beta: f64, ) -> Result<()>

bindings overload which converts GpuMat to another datatype with scaling(Blocking call)

fn convert_to_def_1(&self, dst: &mut impl GpuMatTrait, rtype: i32) -> Result<()>

bindings overload which converts GpuMat to another datatype with scaling(Blocking call)

fn convert_to_5( &self, dst: &mut impl ToOutputArray, rtype: i32, alpha: f64, stream: &mut impl StreamTrait, ) -> Result<()>

converts GpuMat to another datatype with scaling (Non-Blocking call)

fn convert_to_6( &self, dst: &mut impl ToOutputArray, rtype: i32, alpha: f64, beta: f64, stream: &mut impl StreamTrait, ) -> Result<()>

converts GpuMat to another datatype with scaling (Non-Blocking call)

fn convert_to_7( &self, dst: &mut impl GpuMatTrait, rtype: i32, alpha: f64, beta: f64, stream: &mut impl StreamTrait, ) -> Result<()>

bindings overload which converts GpuMat to another datatype with scaling (Non-Blocking call)

fn assign_to(&self, m: &mut impl GpuMatTrait, typ: i32) -> Result<()>

C++ default parameters

fn assign_to_def(&self, m: &mut impl GpuMatTrait) -> Result<()>

Note

fn ptr(&self, y: i32) -> Result<*const u8>

C++ default parameters

fn ptr_def(&self) -> Result<*const u8>

Note

fn row(&self, y: i32) -> Result<BoxedRef<'_, GpuMat>>

returns a new GpuMat header for the specified row

fn col(&self, x: i32) -> Result<BoxedRef<'_, GpuMat>>

returns a new GpuMat header for the specified column

fn row_bounds(&self, startrow: i32, endrow: i32) -> Result<BoxedRef<'_, GpuMat>>

… for the specified row span

fn row_range(&self, r: impl RangeTrait) -> Result<BoxedRef<'_, GpuMat>>

fn col_bounds(&self, startcol: i32, endcol: i32) -> Result<BoxedRef<'_, GpuMat>>

… for the specified column span

fn col_range(&self, r: impl RangeTrait) -> Result<BoxedRef<'_, GpuMat>>

fn rowscols( &self, row_range: impl RangeTrait, col_range: impl RangeTrait, ) -> Result<BoxedRef<'_, GpuMat>>

extracts a rectangular sub-GpuMat (this is a generalized form of row, rowRange etc.)

fn roi(&self, roi: Rect) -> Result<BoxedRef<'_, GpuMat>>

fn reshape(&self, cn: i32, rows: i32) -> Result<BoxedRef<'_, GpuMat>>

creates alternative GpuMat header for the same data, with different number of channels and/or different number of rows

fn reshape_def(&self, cn: i32) -> Result<BoxedRef<'_, GpuMat>>

creates alternative GpuMat header for the same data, with different number of channels and/or different number of rows

fn locate_roi(&self, whole_size: &mut Size, ofs: &mut Point) -> Result<()>

locates GpuMat header within a parent GpuMat

fn is_continuous(&self) -> Result<bool>

returns true iff the GpuMat data is continuous (i.e. when there are no gaps between successive rows)

fn elem_size(&self) -> Result<size_t>

returns element size in bytes

fn elem_size1(&self) -> Result<size_t>

returns the size of element channel in bytes

fn typ(&self) -> Result<i32>

returns element type

fn depth(&self) -> Result<i32>

returns element type

fn channels(&self) -> Result<i32>

returns number of channels

fn step1(&self) -> Result<size_t>

returns step/elemSize1()

fn size(&self) -> Result<Size>

returns GpuMat size : width == number of columns, height == number of rows

fn empty(&self) -> Result<bool>

returns true if GpuMat data is NULL

fn cuda_ptr(&self) -> Result<*mut c_void>

impl ToInputArray for &GpuMat

fn input_array(&self) -> Result<BoxedRef<'_, _InputArray>>

impl ToInputArray for GpuMat

fn input_array(&self) -> Result<BoxedRef<'_, _InputArray>>

impl ToInputOutputArray for &mut GpuMat

fn input_output_array(&mut self) -> Result<BoxedRefMut<'_, _InputOutputArray>>

impl ToInputOutputArray for GpuMat

fn input_output_array(&mut self) -> Result<BoxedRefMut<'_, _InputOutputArray>>

impl ToOutputArray for &mut GpuMat

fn output_array(&mut self) -> Result<BoxedRefMut<'_, _OutputArray>>

impl ToOutputArray for GpuMat

fn output_array(&mut self) -> Result<BoxedRefMut<'_, _OutputArray>>

impl Send for GpuMat