Struct opencv::core::_OutputArray

pub struct _OutputArray { /* private fields */ }

This type is very similar to InputArray except that it is used for input/output and output function parameters.

Just like with InputArray, OpenCV users should not care about OutputArray, they just pass Mat, vector<T> etc. to the functions. The same limitation as for InputArray: Do not explicitly create OutputArray instances applies here too.

If you want to make your function polymorphic (i.e. accept different arrays as output parameters), it is also not very difficult. Take the sample above as the reference. Note that _OutputArray::create() needs to be called before _OutputArray::getMat(). This way you guarantee that the output array is properly allocated.

Optional output parameters. If you do not need certain output array to be computed and returned to you, pass cv::noArray(), just like you would in the case of optional input array. At the implementation level, use _OutputArray::needed() to check if certain output array needs to be computed or not.

There are several synonyms for OutputArray that are used to assist automatic Python/Java/… wrapper generators:

   typedef OutputArray OutputArrayOfArrays;
   typedef OutputArray InputOutputArray;
   typedef OutputArray InputOutputArrayOfArrays;

Implementations

impl _OutputArray

pub fn default() -> Result<_OutputArray>

/////////////////////////////////////////////////////////////////////////////////////

pub unsafe fn new(_flags: i32, _obj: *mut c_void) -> Result<_OutputArray>

pub fn from_mat_mut( m: &mut impl MatTrait ) -> Result<BoxedRefMut<'_, _OutputArray>>

pub fn from_mat_vec_mut( vec: &mut Vector<Mat> ) -> Result<BoxedRefMut<'_, _OutputArray>>

pub fn from_gpumat_mut( d_mat: &mut impl GpuMatTrait ) -> Result<BoxedRefMut<'_, _OutputArray>>

pub fn from_gpumat_vec_mut( d_mat: &mut Vector<GpuMat> ) -> Result<BoxedRefMut<'_, _OutputArray>>

pub fn from_opengl_mut( buf: &mut impl BufferTrait ) -> Result<BoxedRefMut<'_, _OutputArray>>

pub fn from_hostmem_mut( cuda_mem: &mut impl HostMemTrait ) -> Result<BoxedRefMut<'_, _OutputArray>>

pub fn from_umat_mut( m: &mut impl UMatTrait ) -> Result<BoxedRefMut<'_, _OutputArray>>

pub fn from_umat_vec_mut( vec: &mut Vector<UMat> ) -> Result<BoxedRefMut<'_, _OutputArray>>

pub fn from_mat(m: &impl MatTraitConst) -> Result<BoxedRef<'_, _OutputArray>>

pub fn from_mat_vec(vec: &Vector<Mat>) -> Result<BoxedRef<'_, _OutputArray>>

pub fn from_gpumat( d_mat: &impl GpuMatTraitConst ) -> Result<BoxedRef<'_, _OutputArray>>

pub fn from_opengl( buf: &impl BufferTraitConst ) -> Result<BoxedRef<'_, _OutputArray>>

pub fn from_hostmem( cuda_mem: &impl HostMemTraitConst ) -> Result<BoxedRef<'_, _OutputArray>>

pub fn from_umat(m: &impl UMatTraitConst) -> Result<BoxedRef<'_, _OutputArray>>

pub fn from_umat_vec(vec: &Vector<UMat>) -> Result<BoxedRef<'_, _OutputArray>>

Trait Implementations

impl Boxed for _OutputArray

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for _OutputArray

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

Formats the value using the given formatter.

impl Drop for _OutputArray

fn drop(&mut self)

Executes the destructor for this type.

impl From<_InputOutputArray> for _OutputArray

fn from(s: _InputOutputArray) -> Self

Converts to this type from the input type.

impl From<_OutputArray> for _InputArray

fn from(s: _OutputArray) -> Self

Converts to this type from the input type.

impl ToInputArray for _OutputArray

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

impl ToOutputArray for _OutputArray

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

impl _InputArrayTrait for _OutputArray

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

impl _InputArrayTraitConst for _OutputArray

fn as_raw__InputArray(&self) -> *const c_void

fn get_mat(&self, idx: i32) -> Result<Mat>

C++ default parameters

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

Note

fn get_mat_(&self, idx: i32) -> Result<Mat>

C++ default parameters

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

Note

fn get_umat(&self, idx: i32) -> Result<UMat>

C++ default parameters

fn get_umat_def(&self) -> Result<UMat>

Note

fn get_mat_vector(&self, mv: &mut Vector<Mat>) -> Result<()>

fn get_umat_vector(&self, umv: &mut Vector<UMat>) -> Result<()>

fn get_gpu_mat_vector(&self, gpumv: &mut Vector<GpuMat>) -> Result<()>

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

fn get_o_gl_buffer(&self) -> Result<Buffer>

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

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

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

fn kind(&self) -> Result<_InputArray_KindFlag>

fn dims(&self, i: i32) -> Result<i32>

C++ default parameters

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

Note

fn cols(&self, i: i32) -> Result<i32>

C++ default parameters

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

Note

fn rows(&self, i: i32) -> Result<i32>

C++ default parameters

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

Note

fn size(&self, i: i32) -> Result<Size>

C++ default parameters

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

Note

fn sizend(&self, sz: &mut i32, i: i32) -> Result<i32>

C++ default parameters

fn sizend_def(&self, sz: &mut i32) -> Result<i32>

Note

fn same_size(&self, arr: &impl ToInputArray) -> Result<bool>

fn total(&self, i: i32) -> Result<size_t>

C++ default parameters

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

Note

fn typ(&self, i: i32) -> Result<i32>

C++ default parameters

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

Note

fn depth(&self, i: i32) -> Result<i32>

C++ default parameters

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

Note

fn channels(&self, i: i32) -> Result<i32>

C++ default parameters

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

Note

fn is_continuous(&self, i: i32) -> Result<bool>

C++ default parameters

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

Note

fn is_submatrix(&self, i: i32) -> Result<bool>

C++ default parameters

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

Note

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

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

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

fn offset(&self, i: i32) -> Result<size_t>

C++ default parameters

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

Note

fn step(&self, i: i32) -> Result<size_t>

C++ default parameters

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

Note

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

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

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

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

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

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

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

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

impl _OutputArrayTrait for _OutputArray

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

impl _OutputArrayTraitConst for _OutputArray

fn as_raw__OutputArray(&self) -> *const c_void

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

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

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

fn get_mat_ref(&self, i: i32) -> Result<Mat>

C++ default parameters

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

Note

fn get_umat_ref(&self, i: i32) -> Result<UMat>

C++ default parameters

fn get_umat_ref_def(&self) -> Result<UMat>

Note

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

fn get_gpu_mat_vec_ref(&self) -> Result<Vector<GpuMat>>

fn get_o_gl_buffer_ref(&self) -> Result<Buffer>

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

fn create_size( &self, sz: Size, typ: i32, i: i32, allow_transposed: bool, fixed_depth_mask: _OutputArray_DepthMask ) -> Result<()>

C++ default parameters

fn create_size_def(&self, sz: Size, typ: i32) -> Result<()>

Note

fn create( &self, rows: i32, cols: i32, typ: i32, i: i32, allow_transposed: bool, fixed_depth_mask: _OutputArray_DepthMask ) -> Result<()>

C++ default parameters

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

Note

fn create_nd( &self, size: &[i32], typ: i32, i: i32, allow_transposed: bool, fixed_depth_mask: _OutputArray_DepthMask ) -> Result<()>

C++ default parameters

fn create_nd_def(&self, size: &[i32], typ: i32) -> Result<()>

Note

unsafe fn create_same_size( &self, arr: &impl ToInputArray, mtype: i32 ) -> Result<()>

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

fn clear(&self) -> Result<()>

fn set_to( &self, value: &impl ToInputArray, mask: &impl ToInputArray ) -> Result<()>

C++ default parameters

fn set_to_def(&self, value: &impl ToInputArray) -> Result<()>

Note

fn assign_umat(&self, u: &impl UMatTraitConst) -> Result<()>

fn assign_mat(&self, m: &impl MatTraitConst) -> Result<()>

fn assign_umat_vec(&self, v: &Vector<UMat>) -> Result<()>

fn assign_mat_vec(&self, v: &Vector<Mat>) -> Result<()>

fn move_umat(&self, u: &mut impl UMatTrait) -> Result<()>

fn move_mat(&self, m: &mut impl MatTrait) -> Result<()>

impl Send for _OutputArray