Struct opencv::core::Buffer

pub struct Buffer { /* private fields */ }

Smart pointer for OpenGL buffer object with reference counting.

Buffer Objects are OpenGL objects that store an array of unformatted memory allocated by the OpenGL context. These can be used to store vertex data, pixel data retrieved from images or the framebuffer, and a variety of other things.

ogl::Buffer has interface similar with Mat interface and represents 2D array memory.

ogl::Buffer supports memory transfers between host and device and also can be mapped to CUDA memory.

Implementations

impl Buffer

pub fn default() -> Result<Buffer>

The constructors.

Creates empty ogl::Buffer object, creates ogl::Buffer object from existed buffer ( abufId parameter), allocates memory for ogl::Buffer object or copies from host/device memory.

pub fn new( arows: i32, acols: i32, atype: i32, abuf_id: u32, auto_release: bool ) -> Result<Buffer>

The constructors.

Creates empty ogl::Buffer object, creates ogl::Buffer object from existed buffer ( abufId parameter), allocates memory for ogl::Buffer object or copies from host/device memory.

Overloaded parameters

Parameters

• arows: Number of rows in a 2D array.
• acols: Number of columns in a 2D array.
• atype: Array type ( CV_8UC1, …, CV_64FC4 ). See Mat for details.
• abufId: Buffer object name.
• autoRelease: Auto release mode (if true, release will be called in object’s destructor).

C++ default parameters

• auto_release: false

pub fn new_def( arows: i32, acols: i32, atype: i32, abuf_id: u32 ) -> Result<Buffer>

@overload

Parameters

• arows: Number of rows in a 2D array.
• acols: Number of columns in a 2D array.
• atype: Array type ( CV_8UC1, …, CV_64FC4 ). See Mat for details.
• abufId: Buffer object name.
• autoRelease: Auto release mode (if true, release will be called in object’s destructor).

Note

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

• auto_release: false

pub fn new_1( asize: Size, atype: i32, abuf_id: u32, auto_release: bool ) -> Result<Buffer>

The constructors.

Creates empty ogl::Buffer object, creates ogl::Buffer object from existed buffer ( abufId parameter), allocates memory for ogl::Buffer object or copies from host/device memory.

Overloaded parameters

Parameters

• asize: 2D array size.
• atype: Array type ( CV_8UC1, …, CV_64FC4 ). See Mat for details.
• abufId: Buffer object name.
• autoRelease: Auto release mode (if true, release will be called in object’s destructor).

C++ default parameters

• auto_release: false

pub fn new_def_1(asize: Size, atype: i32, abuf_id: u32) -> Result<Buffer>

@overload

Parameters

• asize: 2D array size.
• atype: Array type ( CV_8UC1, …, CV_64FC4 ). See Mat for details.
• abufId: Buffer object name.
• autoRelease: Auto release mode (if true, release will be called in object’s destructor).

Note

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

• auto_release: false

pub fn new_2( arows: i32, acols: i32, atype: i32, target: Buffer_Target, auto_release: bool ) -> Result<Buffer>

The constructors.

Creates empty ogl::Buffer object, creates ogl::Buffer object from existed buffer ( abufId parameter), allocates memory for ogl::Buffer object or copies from host/device memory.

Overloaded parameters

Parameters

• arows: Number of rows in a 2D array.
• acols: Number of columns in a 2D array.
• atype: Array type ( CV_8UC1, …, CV_64FC4 ). See Mat for details.
• target: Buffer usage. See cv::ogl::Buffer::Target .
• autoRelease: Auto release mode (if true, release will be called in object’s destructor).

C++ default parameters

• target: ARRAY_BUFFER
• auto_release: false

pub fn new_def_2(arows: i32, acols: i32, atype: i32) -> Result<Buffer>

@overload

Parameters

• arows: Number of rows in a 2D array.
• acols: Number of columns in a 2D array.
• atype: Array type ( CV_8UC1, …, CV_64FC4 ). See Mat for details.
• target: Buffer usage. See cv::ogl::Buffer::Target .
• autoRelease: Auto release mode (if true, release will be called in object’s destructor).

Note

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

• target: ARRAY_BUFFER
• auto_release: false

pub fn new_3( asize: Size, atype: i32, target: Buffer_Target, auto_release: bool ) -> Result<Buffer>

The constructors.

Creates empty ogl::Buffer object, creates ogl::Buffer object from existed buffer ( abufId parameter), allocates memory for ogl::Buffer object or copies from host/device memory.

Overloaded parameters

Parameters

• asize: 2D array size.
• atype: Array type ( CV_8UC1, …, CV_64FC4 ). See Mat for details.
• target: Buffer usage. See cv::ogl::Buffer::Target .
• autoRelease: Auto release mode (if true, release will be called in object’s destructor).

C++ default parameters

• target: ARRAY_BUFFER
• auto_release: false

pub fn new_def_3(asize: Size, atype: i32) -> Result<Buffer>

@overload

Parameters

• asize: 2D array size.
• atype: Array type ( CV_8UC1, …, CV_64FC4 ). See Mat for details.
• target: Buffer usage. See cv::ogl::Buffer::Target .
• autoRelease: Auto release mode (if true, release will be called in object’s destructor).

Note

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

• target: ARRAY_BUFFER
• auto_release: false

pub fn new_4( arr: &impl ToInputArray, target: Buffer_Target, auto_release: bool ) -> Result<Buffer>

The constructors.

Creates empty ogl::Buffer object, creates ogl::Buffer object from existed buffer ( abufId parameter), allocates memory for ogl::Buffer object or copies from host/device memory.

Overloaded parameters

Parameters

• arr: Input array (host or device memory, it can be Mat , cuda::GpuMat or std::vector ).
• target: Buffer usage. See cv::ogl::Buffer::Target .
• autoRelease: Auto release mode (if true, release will be called in object’s destructor).

C++ default parameters

• target: ARRAY_BUFFER
• auto_release: false

pub fn new_def_4(arr: &impl ToInputArray) -> Result<Buffer>

@overload

Parameters

• arr: Input array (host or device memory, it can be Mat , cuda::GpuMat or std::vector ).
• target: Buffer usage. See cv::ogl::Buffer::Target .
• autoRelease: Auto release mode (if true, release will be called in object’s destructor).

Note

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

• target: ARRAY_BUFFER
• auto_release: false

pub fn unbind(target: Buffer_Target) -> Result<()>

Unbind any buffers from the specified binding point.

Parameters

• target: Binding point. See cv::ogl::Buffer::Target .

Trait Implementations

impl Boxed for Buffer

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl BufferTrait for Buffer

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

fn create( &mut self, arows: i32, acols: i32, atype: i32, target: Buffer_Target, auto_release: bool ) -> Result<()>

Allocates memory for ogl::Buffer object.

fn create_def(&mut self, arows: i32, acols: i32, atype: i32) -> Result<()>

Allocates memory for ogl::Buffer object.

fn create_size( &mut self, asize: Size, atype: i32, target: Buffer_Target, auto_release: bool ) -> Result<()>

Allocates memory for ogl::Buffer object.

fn create_size_def(&mut self, asize: Size, atype: i32) -> Result<()>

@overload

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

Decrements the reference counter and destroys the buffer object if needed.

fn set_auto_release(&mut self, flag: bool) -> Result<()>

Sets auto release mode.

fn copy_from( &mut self, arr: &impl ToInputArray, target: Buffer_Target, auto_release: bool ) -> Result<()>

Copies from host/device memory to OpenGL buffer.

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

Copies from host/device memory to OpenGL buffer.

fn copy_from_1( &mut self, arr: &impl ToInputArray, stream: &mut impl StreamTrait, target: Buffer_Target, auto_release: bool ) -> Result<()>

Copies from host/device memory to OpenGL buffer.

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

@overload

fn map_host(&mut self, access: Buffer_Access) -> Result<Mat>

Maps OpenGL buffer to host memory.

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

Unmaps OpenGL buffer.

fn map_device(&mut self) -> Result<GpuMat>

map to device memory (blocking)

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

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

Maps OpenGL buffer to CUDA device memory.

fn unmap_device_1(&mut self, stream: &mut impl StreamTrait) -> Result<()>

Unmaps OpenGL buffer.

impl BufferTraitConst for Buffer

fn as_raw_Buffer(&self) -> *const c_void

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

Copies from OpenGL buffer to host/device memory or another OpenGL buffer object.

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

Copies from OpenGL buffer to host/device memory or another OpenGL buffer object.

fn clone(&self, target: Buffer_Target, auto_release: bool) -> Result<Buffer>

Creates a full copy of the buffer object and the underlying data.

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

Creates a full copy of the buffer object and the underlying data.

fn bind(&self, target: Buffer_Target) -> Result<()>

Binds OpenGL buffer to the specified buffer binding point.

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

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

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

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

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

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

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

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

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

fn buf_id(&self) -> Result<u32>

get OpenGL opject id

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Drop for Buffer

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Buffer