Struct opencl_core::session::Session

pub struct Session { /* fields omitted */ }

Methods

impl Session

pub fn create_with_devices<'a, D>(
    devices: D,
    src: &str,
    cq_props: Option<CommandQueueProperties>
) -> Output<Vec<Session>> where
    D: Into<VecOrSlice<'a, Device>>, 

pub fn create(
    src: &str,
    cq_props: Option<CommandQueueProperties>
) -> Output<Vec<Session>>

pub fn context(&self) -> Context

pub fn device(&self) -> Device

pub fn program(&self) -> Program

pub fn read_queue(&self) -> RwLockReadGuard<ClCommandQueue>

pub fn write_queue(&self) -> RwLockWriteGuard<ClCommandQueue>

pub fn low_level_device(&self) -> &ClDeviceID

pub fn low_level_context(&self) -> &ClContext

pub fn low_level_program(&self) -> &ClProgram

pub fn create_copy(&self) -> Output<Session>

pub fn create_kernel(&self, kernel_name: &str) -> Output<Kernel>

Creates a ClKernel from the session's program.

pub fn create_buffer<T: ClNumber, B: BufferCreator<T>>(
    &self,
    buffer_creator: B
) -> Output<Buffer>

Creates a ClMem object in the given context, with the given buffer creator (either a length or some data). This function uses the BufferCreator's implementation to retrieve the appropriate MemConfig.

pub fn create_buffer_with_config<T: ClNumber, B: BufferCreator<T>>(
    &self,
    buffer_creator: B,
    mem_config: MemConfig
) -> Output<Buffer>

Creates a ClMem object in the given context, with the given buffer creator (either a length or some data) and a given MemConfig.

pub fn sync_write_buffer<'a, T: ClNumber, H: Into<VecOrSlice<'a, T>>>(
    &self,
    buffer: &Buffer,
    host_buffer: H,
    opts: Option<CommandQueueOptions>
) -> Output<()>

This function copies data from the host buffer into the device mem buffer. The host buffer must be a mutable slice or a vector to ensure the safety of the read_Buffer operation.

pub fn sync_read_buffer<'a, T: ClNumber, H: Into<MutVecOrSlice<'a, T>>>(
    &self,
    buffer: &Buffer,
    host_buffer: H,
    opts: Option<CommandQueueOptions>
) -> Output<Option<Vec<T>>>

This function copies data from a device mem buffer into a host buffer. The host buffer must be a mutable slice or a vector. For the moment the device mem must also be passed as mutable; I don't trust OpenCL.

pub fn sync_enqueue_kernel(
    &self,
    kernel: &Kernel,
    work: &Work,
    opts: Option<CommandQueueOptions>
) -> Output<()>

This function enqueues a CLKernel into a command queue

Safety

If the ClKernel is not in a usable state or any of the Kernel's dependent object has been release, or the kernel belongs to a different session, or the ClKernel's pointer is a null pointer, then calling this function will cause undefined behavior.

pub fn execute_sync_kernel_operation<'a, T>(
    &self,
    kernel_op: KernelOperation<'a, T>
) -> Output<()> where
    T: ClNumber + KernelArg, 

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl Drop for Session

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Session

impl PartialEq<Session> for Session

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

impl Send for Session

impl Sync for Session