Module program

Structs

Program

An OpenCL program object.
Stores the names of the OpenCL kernels in the program. Implements the Drop trait to call release_program when the object is dropped.

Constants

BUILD_OPTION_SPIR_STD_1_2

BUILD_OPTION_X_SPIR

CL_BUILD_ERROR

CL_BUILD_IN_PROGRESS

CL_BUILD_NONE

CL_BUILD_SUCCESS

CL_DENORMS_ARE_ZERO

CL_FALSE

CL_FAST_RELAXED_MATH

CL_FINITE_MATH_ONLY

CL_FP_CORRECTLY_ROUNDED_DIVIDE_SQRT

CL_INVALID_VALUE

CL_KERNEL_ARG_INFO

This option allows the compiler to store information about the arguments of kernels in the program executable.

CL_MAD_ENABLE

CL_NO_SIGNED_ZEROS

CL_NO_SUBGROUP_INFO

CL_OPT_DISABLE

CL_PROGRAM_BINARIES

CL_PROGRAM_BINARY_SIZES

CL_PROGRAM_BINARY_TYPE

CL_PROGRAM_BINARY_TYPE_COMPILED_OBJECT

CL_PROGRAM_BINARY_TYPE_EXECUTABLE

CL_PROGRAM_BINARY_TYPE_LIBRARY

CL_PROGRAM_BINARY_TYPE_NONE

CL_PROGRAM_BUILD_GLOBAL_VARIABLE_TOTAL_SIZE

CL_PROGRAM_BUILD_LOG

CL_PROGRAM_BUILD_OPTIONS

CL_PROGRAM_BUILD_STATUS

CL_PROGRAM_CONTEXT

CL_PROGRAM_DEVICES

CL_PROGRAM_IL

CL_PROGRAM_KERNEL_NAMES

CL_PROGRAM_NUM_DEVICES

CL_PROGRAM_NUM_KERNELS

CL_PROGRAM_REFERENCE_COUNT

CL_PROGRAM_SCOPE_GLOBAL_CTORS_PRESENT

CL_PROGRAM_SCOPE_GLOBAL_DTORS_PRESENT

CL_PROGRAM_SOURCE

CL_SINGLE_RECISION_CONSTANT

CL_STD_2_0

Applications are required to specify the -cl-std=CL2.0 build option to compile or build programs with OpenCL C 2.0.

CL_STD_3_0

Applications are required to specify the -cl-std=CL3.0 build option to compile or build programs with OpenCL C 3.0.

CL_STRICT_ALIASING

CL_SUCCESS

CL_TRUE

CL_UNIFORM_WORK_GROUP_SIZE

CL_UNSAFE_MATH_OPTIMIZATIONS

CREATE_LIBRARY

DEBUG_OPTION

ENABLE_LINK_OPTIONS

Functions

build_program

Build (compile & link) a program executable. Calls clBuildProgram to build an OpenCL program object.

compile_program

Compile a program’s source for the devices the OpenCL context associated with the program. Calls clCompileProgram to compile an OpenCL program object.

create_program_with_binary^⚠

Create an OpenCL program object for a context and load binary bits into that object. Calls clCreateProgramWithBinary to create an OpenCL program object.

create_program_with_builtin_kernels^⚠

Create an OpenCL program object for a context and loads the information related to the built-in kernels into that object.

create_program_with_il

Create an OpenCL program object for a context and load code in an intermediate language into that object. Calls clCreateProgramWithIL to create an OpenCL program object. CL_VERSION_2_1

create_program_with_source

Create an OpenCL program object for a context and load source code into that object. Calls clCreateProgramWithSource to create an OpenCL program object.

get_program_build_data

Get data about an OpenCL program build. Calls clGetProgramBuildInfo to get the desired data about the program build.

get_program_build_info

Get specific information about an OpenCL program build. Calls clGetProgramBuildInfo to get the desired information about the program build.

get_program_data

Get data about an OpenCL program. Calls clGetProgramInfo to get the desired data about the program.

get_program_info

Get specific information about an OpenCL program. Calls clGetProgramInfo to get the desired information about the program.

link_program^⚠

Link a set of compiled program objects and libraries for the devices in the OpenCL context associated with the program. Calls clLinkProgram to link an OpenCL program object.

release_program^⚠

Release an OpenCL program. Calls clReleaseProgram to decrement the program reference count.

retain_program^⚠

Retain an OpenCL program. Calls clRetainProgram to increment the program reference count.

set_program_specialization_constant^⚠

Set the value of a specialization constant. Calls clSetProgramSpecializationConstant. CL_VERSION_2_2

unload_platform_compiler^⚠

Release the resources allocated by the OpenCL compiler for platform. Calls clUnloadPlatformCompiler.

Type Aliases

cl_context

cl_device_id

cl_int

cl_platform_id

cl_program

cl_program_build_info

cl_program_info

cl_uchar

cl_uint