Struct opencv::core::Buffer

pub struct Buffer { /* fields omitted */ }

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 as_raw_Buffer(&self) -> *const c_void

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

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_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_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_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_4(
    arr: &dyn 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 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

pub unsafe fn from_raw(ptr: *mut c_void) -> Self

Wrap the specified raw pointer

pub fn into_raw(self) -> *mut c_void

Return an the underlying raw pointer while consuming this wrapper.

pub fn as_raw(&self) -> *const c_void

Return the underlying raw pointer.

pub fn as_raw_mut(&mut self) -> *mut c_void

Return the underlying mutable raw pointer

impl BufferTrait for Buffer

pub fn as_raw_Buffer(&self) -> *const c_void

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

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

Allocates memory for ogl::Buffer object.

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

Allocates memory for ogl::Buffer object.

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

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

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

Sets auto release mode.

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

Copies from host/device memory to OpenGL buffer.

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

Copies from host/device memory to OpenGL buffer.

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

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

pub fn copy_to_1(
    &self,
    arr: &mut dyn ToOutputArray,
    stream: &mut Stream
) -> Result<()>

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

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

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

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

Binds OpenGL buffer to the specified buffer binding point.

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

Maps OpenGL buffer to host memory.

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

Unmaps OpenGL buffer.

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

map to device memory (blocking)

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

pub fn map_device_1(&mut self, stream: &mut Stream) -> Result<GpuMat>

Maps OpenGL buffer to CUDA device memory.

pub fn unmap_device_1(&mut self, stream: &mut Stream) -> Result<()>

Unmaps OpenGL buffer.

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

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

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

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

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

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

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

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

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

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

get OpenGL opject id

impl Drop for Buffer

pub fn drop(&mut self)

Executes the destructor for this type.

impl Send for Buffer