Struct opencv::core::OpenCLExecutionContext

pub struct OpenCLExecutionContext { /* fields omitted */ }

Implementations

impl OpenCLExecutionContext

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

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

impl OpenCLExecutionContext

pub fn default() -> Result<OpenCLExecutionContext>

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

pub fn copy_mut(
    unnamed: &mut OpenCLExecutionContext
) -> Result<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 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 and call clRetainContext function. The deviceID device will be used as target device and new command queue will be created.

Note: Lifetime of passed handles is transferred to OpenCV wrappers on success

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

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

pub fn drop(&mut self)

Executes the destructor for this type.

impl OpenCLExecutionContextTrait for OpenCLExecutionContext

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

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

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

Get associated ocl::Context

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

Get the single default associated ocl::Device

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

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

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

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

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

Bind this OpenCL execution context to current thread.

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

Creates new execution context with same OpenCV context and device

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

Creates new execution context with same OpenCV context and device

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

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

impl Send for OpenCLExecutionContext