Struct open_cl_low_level::command_queue::ClCommandQueue

pub struct ClCommandQueue { /* fields omitted */ }

Methods

impl ClCommandQueue

pub unsafe fn new(cq: cl_command_queue) -> Output<ClCommandQueue>

Builds a ClCommandQueue after checking for null-pointer.

pub unsafe fn unchecked_new(object: cl_command_queue) -> ClCommandQueue

Builds a ClCommandQueue without checking for null-pointer.

pub unsafe fn retain_new(cq: cl_command_queue) -> Output<ClCommandQueue>

After checking for null-pointer and retaining the cl_command_queue builds a ClCommandQueue.

Safety

Calling this function with a cl_command_queue in an invalid state is undefined behavior.

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<T>,
    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<T>,
    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<()>

Trait Implementations

impl CommandQueuePtr for ClCommandQueue

unsafe fn command_queue_ptr(&self) -> cl_command_queue

The ffi-usable cl_command_queue pointer.

Safety

Usage of invalid ClObjects is undefined behavior.

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 Debug for ClCommandQueue

Clone is highly unsafe without ensuring Sync and Send

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

Formats the value using the given formatter.

impl Drop for ClCommandQueue

fn drop(&mut self)

Drops the ClCommandQueue by releasing and thereby decrementing the reference count of the cl_command_queue.

impl Eq for ClCommandQueue

impl PartialEq<ClCommandQueue> for ClCommandQueue

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 !=.