Struct HostMem

pub struct HostMem { /* private fields */ }

Class with reference counting wrapping special memory type allocation functions from CUDA.

Its interface is also Mat-like but with additional memory type parameters.

• PAGE_LOCKED sets a page locked memory type used commonly for fast and asynchronous uploading/downloading data from/to GPU.
• SHARED specifies a zero copy memory allocation that enables mapping the host memory to GPU address space, if supported.
• WRITE_COMBINED sets the write combined buffer that is not cached by CPU. Such buffers are used to supply GPU with data when GPU only reads it. The advantage is a better CPU cache utilization.

Note: Allocation size of such memory types is usually limited. For more details, see CUDA 2.2 Pinned Memory APIs document or CUDA C Programming Guide.

Implementations

impl HostMem

pub fn new(alloc_type: HostMem_AllocType) -> Result<HostMem>

C++ default parameters

• alloc_type: HostMem::AllocType::PAGE_LOCKED

pub fn new_def() -> Result<HostMem>

Note

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

• alloc_type: HostMem::AllocType::PAGE_LOCKED

pub fn copy(m: &impl HostMemTraitConst) -> Result<HostMem>

pub fn new_1( rows: i32, cols: i32, typ: i32, alloc_type: HostMem_AllocType, ) -> Result<HostMem>

C++ default parameters

• alloc_type: HostMem::AllocType::PAGE_LOCKED

pub fn new_def_1(rows: i32, cols: i32, typ: i32) -> Result<HostMem>

Note

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

• alloc_type: HostMem::AllocType::PAGE_LOCKED

pub fn new_2( size: Size, typ: i32, alloc_type: HostMem_AllocType, ) -> Result<HostMem>

C++ default parameters

• alloc_type: HostMem::AllocType::PAGE_LOCKED

pub fn new_def_2(size: Size, typ: i32) -> Result<HostMem>

Note

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

• alloc_type: HostMem::AllocType::PAGE_LOCKED

pub fn new_3( arr: &impl ToInputArray, alloc_type: HostMem_AllocType, ) -> Result<HostMem>

creates from host memory with coping data

C++ default parameters

• alloc_type: HostMem::AllocType::PAGE_LOCKED

pub fn new_def_3(arr: &impl ToInputArray) -> Result<HostMem>

creates from host memory with coping data

Note

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

• alloc_type: HostMem::AllocType::PAGE_LOCKED

Trait Implementations

impl Boxed for HostMem

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Clone for HostMem

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 HostMem

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

Formats the value using the given formatter.

impl Drop for HostMem

fn drop(&mut self)

Executes the destructor for this type.

impl HostMemTrait for HostMem

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

fn set_flags(&mut self, val: i32)

fn set_rows(&mut self, val: i32)

fn set_cols(&mut self, val: i32)

fn set_step(&mut self, val: size_t)

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

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

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

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

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

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

fn set_alloc_type(&mut self, val: HostMem_AllocType)

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

fn swap(&mut self, b: &mut impl HostMemTrait) -> Result<()>

swaps with other smart pointer

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

allocates new matrix data unless the matrix already has specified size and type.

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

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

decrements reference counter and released memory if needed.

impl HostMemTraitConst for HostMem

fn as_raw_HostMem(&self) -> *const c_void

fn flags(&self) -> i32

fn rows(&self) -> i32

fn cols(&self) -> i32

fn step(&self) -> size_t

fn data(&self) -> *const u8

fn refcount(&self) -> *const i32

fn datastart(&self) -> *const u8

fn dataend(&self) -> *const u8

fn alloc_type(&self) -> HostMem_AllocType

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

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

fn reshape(&self, cn: i32, rows: i32) -> Result<HostMem>

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

fn reshape_def(&self, cn: i32) -> Result<HostMem>

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

fn create_mat_header(&self) -> Result<Mat>

returns matrix header with disabled reference counting for HostMem data.

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

Maps CPU memory to GPU address space and creates the cuda::GpuMat header without reference counting for it.

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

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

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

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

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

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

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

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

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

impl Send for HostMem