Struct opencv::core::Stream

pub struct Stream { /* private fields */ }

This class encapsulates a queue of asynchronous calls.

Note: Currently, you may face problems if an operation is enqueued twice with different data. Some functions use the constant GPU memory, and next call may update the memory before the previous one has been finished. But calling different operations asynchronously is safe because each operation has its own constant buffer. Memory copy/upload/download/set operations to the buffers you hold are also safe.

Note: The Stream class is not thread-safe. Please use different Stream objects for different CPU threads.

void thread1()
{
   cv::cuda::Stream stream1;
   cv::cuda::func1(..., stream1);
}
 
void thread2()
{
   cv::cuda::Stream stream2;
   cv::cuda::func2(..., stream2);
}

Note: By default all CUDA routines are launched in Stream::Null() object, if the stream is not specified by user. In multi-threading environment the stream objects must be passed explicitly (see previous note).

Implementations

impl Stream

pub fn default() -> Result<Stream>

creates a new asynchronous stream

pub fn new(allocator: &Ptr<dyn GpuMat_Allocator>) -> Result<Stream>

creates a new asynchronous stream with custom allocator

pub fn new_1(cuda_flags: size_t) -> Result<Stream>

creates a new Stream using the cudaFlags argument to determine the behaviors of the stream

Note: The cudaFlags parameter is passed to the underlying api cudaStreamCreateWithFlags() and supports the same parameter values.

   // creates an OpenCV cuda::Stream that manages an asynchronous, non-blocking,
   // non-default CUDA stream
   cv::cuda::Stream cvStream(cudaStreamNonBlocking);

pub fn null() -> Result<Stream>

return Stream object for default CUDA stream

Trait Implementations

impl Boxed for Stream

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

Wrap the specified raw pointer

fn into_raw(self) -> *mut c_void

Return an the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> *const c_void

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Drop for Stream

fn drop(&mut self)

Executes the destructor for this type.

impl StreamTrait for Stream

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

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

Blocks the current CPU thread until all operations in the stream are complete.

fn wait_event(&mut self, event: &Event) -> Result<()>

Makes a compute stream wait on an event.

fn enqueue_host_callback(
    &mut self,
    callback: Stream_StreamCallback
) -> Result<()>

Adds a callback to be called on the host after all currently enqueued items in the stream have completed.

impl StreamTraitConst for Stream

fn as_raw_Stream(&self) -> *const c_void

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

Returns true if the current stream queue is finished. Otherwise, it returns false.

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

return Pointer to CUDA stream

impl Send for Stream