Struct open_cl_low_level::program::ClProgram

pub struct ClProgram { /* fields omitted */ }

Methods

impl ClProgram

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 unsafe fn unchecked_new(program: cl_program) -> ClProgram

Returns a new ClProgram, but does not check for null pointer.

Safety

Due to the lack of a null pointer check this function can lead to undefined behavior; dropping the new ClProgram will attempt to release a null pointer cl_program inside OpenCL. KABOOM.

pub unsafe fn new(prog: cl_program) -> Output<ClProgram>

Wraps a raw cl_program pointer into a ClProgram.

Safety

This function should only be used for cl_program pointers that are already retained (like from clCreateProgramWithSource). When a ClProgram drops "release" is called on the cl_program which decrements the cl_program's OpenCL atomic reference count.

pub unsafe fn retain_new(prog: cl_program) -> Output<ClProgram>

Retains and wraps a raw cl_program pointer into a ClProgram.

Safety

This function increments the OpenCL reference count of the given cl_program. This function should only be used on cl_program objects that are obtained from the OpenCL FFI that were not created, but retrieved through the info functions of other OpenCL objects.

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 Clone for ClProgram

fn clone(&self) -> ClProgram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClProgram

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

Formats the value using the given formatter.

impl Drop for ClProgram

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for ClProgram

impl PartialEq<ClProgram> for ClProgram

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 ProgramPtr for ClProgram

unsafe fn program_ptr(&self) -> cl_program

program_ptr is the trait to access a cl_program for wrappers of that cl_program.

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

The OpenCL reference count of the cl_program.

fn num_devices(&self) -> Output<usize>

The number of devices that this cl_program is built on.

fn source(&self) -> Output<String>

The source code String of this OpenCL program.

fn binary_sizes(&self) -> Output<Vec<usize>>

The size of the binaries for this OpenCL program.

fn binaries(&self) -> Output<Vec<u8>>

The executable binaries for this OpenCL program.

fn num_kernels(&self) -> Output<usize>

The number of kernels (defined functions) in this OpenCL program.

fn kernel_names(&self) -> Output<Vec<String>>

The names of the kernels (defined functions) in this OpenCL program.

fn devices(&self) -> Output<Vec<ClDeviceID>>

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