[][src]Crate cl3

A Rust implementation of the Khronos OpenCL 3.0 API.

Description

The ffi modules provide unsafe Foreign Function Interfaces for the OpenCL C functions, while types contains all the OpenCL API data types.

Most of the other modules are named after their equivalent OpenCL objects and provide simple, safe functions around the C API functions that return Rust Result types. The exceptions are:

  • error_codes - contains the OpenCL API error codes from cl.h that are returned in the OpenCL API Result types.
  • info_type - contains a Rust enum (InfoType) to hold the OpenCL types that can be returned from OpenCL "Info" functions, e.g. clGetPlatformInfo, clGetDeviceInfo, clGetProgramInfo, etc.
  • macros - contains Rust macros to call the OpenCL "Info" functions and return the appropriate InfoType in a Rust Result.

Modules

command_queue

OpenCL Command Queue API.

context

OpenCL Context API.

device

OpenCL Device API.

error_codes

OpenCL API Error Codes.

event

OpenCL Event Object API.

ffi

OpenCL API Functions.

info_type
kernel

OpenCL Kernel Object API.

macros
memory

OpenCL Memory Object API.

platform

OpenCL Platform API.

program

OpenCL Program Object API.

sampler

OpenCL Sampler API.

types

OpenCL API data types.

Macros

api2_info_size
api2_info_value
api2_info_vector
api_info_size
api_info_value
api_info_vector