Struct open_cl_low_level::object_wrapper::ObjectWrapper

pub struct ObjectWrapper<T: ClObject + RetainRelease + CheckValidClObject> { /* fields omitted */ }

Methods

impl<T: ClObject + RetainRelease + CheckValidClObject> ObjectWrapper<T>

pub unsafe fn unchecked_new(object: T) -> Self

pub unsafe fn cl_object(&self) -> T

pub unsafe fn cl_object_ref(&self) -> &T

pub unsafe fn cl_object_mut_ref(&mut self) -> &mut T

pub unsafe fn new(object: T) -> Output<Self>

pub unsafe fn retain_new(object: T) -> Output<Self>

pub fn address(&self) -> String

pub fn type_name(&self) -> &'static str

impl ObjectWrapper<cl_command_queue>

pub unsafe fn create(
    context: &ClContext,
    device: &ClDeviceID,
    opt_props: Option<CommandQueueProperties>
) -> Output<ClCommandQueue>

Create a new ClCommandQueue in the given ClContext on the given ClDeviceID with the given CommandQueueProperties (optional).

Safety

Calling this function with an invalid ClContext or ClDeviceID is undefined behavior.

pub unsafe fn create_from_raw_pointers(
    context: cl_context,
    device: cl_device_id,
    props: cl_command_queue_properties
) -> Output<ClCommandQueue>

Creates a ClCommandQueue from raw ClObject pointers.

Safety

Passing an invalid ClObject is undefined behavior.

pub unsafe fn create_copy(&self) -> Output<ClCommandQueue>

Creates a copy of a ClCommandQueue. The copy is, in fact, a completely differnt ClCommandQueue that has the same cl_context and cl_device_id as the original.

Safety

Calling this function on an invalid ClCommandQueue is undefined behavior.

pub unsafe fn write_buffer<'a, T: ClNumber, H: Into<VecOrSlice<'a, T>>>(
    &mut self,
    mem: &mut ClMem,
    host_buffer: H,
    opts: Option<CommandQueueOptions>
) -> Output<ClEvent>

write_buffer is used to move data from the host buffer (buffer: &[T]) to the mutable OpenCL cl_mem pointer.

pub unsafe fn read_buffer<'a, T: ClNumber, H: Into<MutVecOrSlice<'a, T>>>(
    &mut self,
    mem: &ClMem,
    host_buffer: H,
    opts: Option<CommandQueueOptions>
) -> Output<BufferReadEvent<T>>

Copies data from a ClMem buffer to a &mut [T] or mut Vec.

pub unsafe fn enqueue_kernel(
    &mut self,
    kernel: &mut ClKernel,
    work: &Work,
    opts: Option<CommandQueueOptions>
) -> Output<ClEvent>

Enqueues a ClKernel onto a the ClCommandQueue.

Safety

Usage of invalid ClObjects is undefined behavior.

pub unsafe fn finish(&mut self) -> Output<()>

impl ObjectWrapper<*mut _cl_context>

pub unsafe fn create<D>(devices: &[D]) -> Output<ClContext> where
    D: DevicePtr, 

impl ObjectWrapper<*mut _cl_event>

pub fn time(&self, info: ProfilingInfo) -> Output<u64>

pub fn queue_time(&self) -> Output<u64>

pub fn submit_time(&self) -> Output<u64>

pub fn start_time(&self) -> Output<u64>

pub fn end_time(&self) -> Output<u64>

pub fn profiling(&self) -> Profiling

pub unsafe fn info<T: Copy>(&self, flag: EventInfo) -> Output<ClPointer<T>>

pub fn reference_count(&self) -> Output<u32>

pub unsafe fn cl_command_queue(&self) -> Output<cl_command_queue>

pub unsafe fn command_queue(&self) -> Output<ClCommandQueue>

pub unsafe fn cl_context(&self) -> Output<cl_context>

pub unsafe fn context(&self) -> Output<ClContext>

pub fn command_execution_status(&self) -> Output<CommandExecutionStatus>

impl ObjectWrapper<*mut _cl_kernel>

pub unsafe fn create(program: &ClProgram, name: &str) -> Output<ClKernel>

Creates a wrapped cl_kernel object.

Safety

Calling this function with an invalid ClProgram is undefined behavior.

pub unsafe fn set_arg<T: KernelArg>(
    &mut self,
    arg_index: usize,
    arg: &mut T
) -> Output<()>

Set adds and arg to a kernel at a given index.

Safety

Calling this function on invalid kernel or with invalid arg is undefined behavior.

pub unsafe fn set_arg_raw(
    &mut self,
    arg_index: u32,
    arg_size: usize,
    arg_ptr: *const c_void
) -> Output<()>

impl ObjectWrapper<*mut _cl_program>

pub unsafe fn create_with_source(
    context: &ClContext,
    src: &str
) -> Output<ClProgram>

Creates a new ClProgram on the context and device with the given OpenCL source code.

Safety

The provided ClContext and ClDeviceID must be in valid state or else undefined behavior is expected.

pub unsafe fn create_with_binary(
    context: &ClContext,
    device: &ClDeviceID,
    bin: &[u8]
) -> Output<ClProgram>

Creates a new ClProgram on the context and device with the given executable binary.

Safety

The provided ClContext and ClDeviceID must be in valid state or else undefined behavior is expected.

pub fn build<D>(&mut self, devices: &[D]) -> Output<()> where
    D: DevicePtr, 

pub fn get_log<D: DevicePtr>(&self, device: &D) -> Output<String>

Trait Implementations

impl<T: RetainRelease> Clone for ObjectWrapper<T>

fn clone(&self) -> ObjectWrapper<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandQueuePtr for ObjectWrapper<cl_command_queue>

unsafe fn command_queue_ptr(&self) -> cl_command_queue

fn address(&self) -> String

unsafe fn info<T: Copy>(&self, flag: CQInfo) -> Output<ClPointer<T>>

unsafe fn cl_context(&self) -> Output<cl_context>

unsafe fn context(&self) -> Output<ClContext>

unsafe fn cl_device_id(&self) -> Output<cl_device_id>

unsafe fn device(&self) -> Output<ClDeviceID>

unsafe fn reference_count(&self) -> Output<u32>

unsafe fn cl_command_queue_properties(
    &self
) -> Output<cl_command_queue_properties>

unsafe fn properties(&self) -> Output<CommandQueueProperties>

impl<T: ClObject + RetainRelease> Debug for ObjectWrapper<T>

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

Formats the value using the given formatter.

impl<T: RetainRelease> Drop for ObjectWrapper<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ClObject + RetainRelease> Eq for ObjectWrapper<T>

impl<T: ClObject + RetainRelease> PartialEq<ObjectWrapper<T>> for ObjectWrapper<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.