Struct opencv::core::OpenCLExecutionContext

pub struct OpenCLExecutionContext { /* private fields */ }

Implementations

impl OpenCLExecutionContext

pub fn default() -> OpenCLExecutionContext

pub fn copy(unnamed: &OpenCLExecutionContext) -> OpenCLExecutionContext

pub fn copy_mut(unnamed: &mut OpenCLExecutionContext) -> OpenCLExecutionContext

pub fn get_current() -> Result<OpenCLExecutionContext>

Get OpenCL execution context of current thread.

Initialize OpenCL execution context if it is empty

• create new
• reuse context of the main thread (threadID = 0)

pub fn get_current_ref() -> Result<OpenCLExecutionContext>

Get OpenCL execution context of current thread (can be empty)

pub unsafe fn create(
    platform_name: &str,
    platform_id: *mut c_void,
    context: *mut c_void,
    device_id: *mut c_void
) -> Result<OpenCLExecutionContext>

Creates OpenCL execution context OpenCV will check if available OpenCL platform has platformName name, then assign context to OpenCV. The deviceID device will be used as target device and a new command queue will be created.

Note: On success, ownership of one reference of the context and device is taken. The caller should additionally call clRetainContext and/or clRetainDevice to increase the reference count if it wishes to continue using them.

Parameters

• platformName: name of OpenCL platform to attach, this string is used to check if platform is available to OpenCV at runtime
• platformID: ID of platform attached context was created for (cl_platform_id)
• context: OpenCL context to be attached to OpenCV (cl_context)
• deviceID: OpenCL device (cl_device_id)

pub fn create_1(
    context: &Context,
    device: &Device,
    queue: &Queue
) -> Result<OpenCLExecutionContext>

Creates OpenCL execution context

Parameters

• context: non-empty OpenCL context
• device: non-empty OpenCL device (must be a part of context)
• queue: non-empty OpenCL queue for provided context and device

pub fn create_2(
    context: &Context,
    device: &Device
) -> Result<OpenCLExecutionContext>

Creates OpenCL execution context

Parameters

• context: non-empty OpenCL context
• device: non-empty OpenCL device (must be a part of context)
• queue: non-empty OpenCL queue for provided context and device

Overloaded parameters

Trait Implementations

impl Boxed for OpenCLExecutionContext

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 Default for OpenCLExecutionContext

fn default() -> Self

Forwards to infallible Self::default()

impl Drop for OpenCLExecutionContext

fn drop(&mut self)

Executes the destructor for this type.

impl OpenCLExecutionContextTrait for OpenCLExecutionContext

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

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

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

impl OpenCLExecutionContextTraitConst for OpenCLExecutionContext

fn as_raw_OpenCLExecutionContext(&self) -> *const c_void

fn get_context(&self) -> Result<Context>

Get associated ocl::Context

fn get_device(&self) -> Result<Device>

Get the single default associated ocl::Device

fn get_queue(&self) -> Result<Queue>

Get the single ocl::Queue that is associated with the ocl::Context and the single default ocl::Device

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

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

Bind this OpenCL execution context to current thread.

fn clone_with_new_queue(&self, q: &Queue) -> Result<OpenCLExecutionContext>

Creates new execution context with same OpenCV context and device

fn clone_with_new_queue_1(&self) -> Result<OpenCLExecutionContext>

Creates new execution context with same OpenCV context and device

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

impl Send for OpenCLExecutionContext