cl3 0.13.1

A Rust implementation of the Khronos OpenCL 3.0 API and extensions.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

// Copyright (c) 2023-2025 Via Technology Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! `OpenCL` layer extensions

#![allow(unused_unsafe)]

pub use opencl_sys::cl_layer::*;
pub use opencl_sys::*;

#[allow(unused_imports)]
use libc::{c_void, size_t};
#[allow(unused_imports)]
use std::ptr;

/// Query information about the `OpenCL` layer.
/// Calls `clGetLayerInfo`.
pub fn get_layer_data(param_name: cl_layer_info) -> Result<Vec<u8>, cl_int> {
    let mut size: size_t = 0;
    let status = unsafe {
        cl_call!(cl_layer::clGetLayerInfo(
            param_name,
            0,
            ptr::null_mut(),
            &raw mut size
        ))
    };
    if CL_SUCCESS == status {
        let mut data: Vec<u8> = Vec::with_capacity(size);
        let status = unsafe {
            cl_call!(cl_layer::clGetLayerInfo(
                param_name,
                size,
                data.as_mut_ptr().cast::<c_void>(),
                ptr::null_mut(),
            ))
        };
        if CL_SUCCESS == status {
            Ok(data)
        } else {
            Err(status)
        }
    } else {
        Err(status)
    }
}

/// Initialise `OpenCL` layer(s).
/// Calls `clGetLayerInfo`.
///
/// # Safety
///
/// This is unsafe if `target_dispatch` is not valid.
#[allow(clippy::cast_possible_truncation)]
pub fn init_layer(target_dispatch: &[cl_icd_dispatch]) -> Result<&[cl_icd_dispatch], cl_int> {
    let mut num_entries_ret: cl_uint = 0;
    let mut layer_dispatch_ret: *const cl_icd_dispatch = ptr::null();
    let status = cl_call!(cl_layer::clInitLayer(
        target_dispatch.len() as cl_uint,
        target_dispatch.as_ptr(),
        &raw mut num_entries_ret,
        &raw mut layer_dispatch_ret,
    ));
    if CL_SUCCESS == status {
        let slice =
            unsafe { std::slice::from_raw_parts(layer_dispatch_ret, num_entries_ret as usize) };
        Ok(slice)
    } else {
        Err(status)
    }
}