Struct open_cl_low_level::kernel::ClKernel

pub struct ClKernel { /* fields omitted */ }

ClKernel is a low-level object wrapper for cl_kernel. ClKernel implements Drop that utilizes clRetainKernel and Clone that utilizes clReleaseKernel.

Safety

Using ClKernel in an invalid state is undefined behavior.

Lifetime Dependencies

ClKernel depends on cl_program and, by proxy, cl_context.

Methods

impl ClKernel

pub unsafe fn new(object: cl_kernel) -> Output<ClKernel>

Creates a ClKernel after checking that the cl_kernel is a non-null pointer.

Safety

Providing a non-null pointer will return an Err Result, but providing an invalid cl_kernel is not safe.

pub unsafe fn unchecked_new(object: cl_kernel) -> ClKernel

Creates a ClKernel without checking that the cl_kernel is a null pointer.

Safety

Providing a null pointer or an otherwise invalid cl_kernel is not safe.

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.

Trait Implementations

impl Clone for ClKernel

fn clone(&self) -> ClKernel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for ClKernel

fn drop(&mut self)

Executes the destructor for this type.

impl KernelPtr for ClKernel

unsafe fn kernel_ptr(&self) -> cl_kernel

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

unsafe fn function_name(&self) -> Output<String>

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

Returns the number of args for a kernel.

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

Returns the OpenCL reference count of the kernel.

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

unsafe fn program(&self) -> Output<ClProgram>

unsafe fn attributes(&self) -> Output<String>