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 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
// Copyright (c) 2021-2024 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` `OpenGL` Interoperability API.
#![allow(non_camel_case_types, deprecated)]
#![allow(clippy::not_unsafe_ptr_arg_deref, clippy::missing_safety_doc)]
pub use opencl_sys::{
cl_GLenum, cl_GLint, cl_GLsync, cl_GLuint, cl_command_queue, cl_context, cl_context_properties,
cl_event, cl_gl_context_info, cl_gl_object_type, cl_gl_platform_info, cl_gl_texture_info,
cl_int, cl_mem, cl_mem_flags, cl_uint, CL_CGL_SHAREGROUP_KHR,
CL_COMMAND_GL_FENCE_SYNC_OBJECT_KHR, CL_CURRENT_DEVICE_FOR_GL_CONTEXT_KHR,
CL_DEVICES_FOR_GL_CONTEXT_KHR, CL_EGL_DISPLAY_KHR, CL_GLX_DISPLAY_KHR, CL_GL_CONTEXT_KHR,
CL_GL_MIPMAP_LEVEL, CL_GL_NUM_SAMPLES, CL_GL_OBJECT_BUFFER, CL_GL_OBJECT_RENDERBUFFER,
CL_GL_OBJECT_TEXTURE1D, CL_GL_OBJECT_TEXTURE1D_ARRAY, CL_GL_OBJECT_TEXTURE2D,
CL_GL_OBJECT_TEXTURE2D_ARRAY, CL_GL_OBJECT_TEXTURE3D, CL_GL_OBJECT_TEXTURE_BUFFER,
CL_GL_TEXTURE_TARGET, CL_INVALID_VALUE, CL_KHR_GL_SHARING, CL_SUCCESS, CL_WGL_HDC_KHR,
};
#[allow(unused_imports)]
use opencl_sys::{
clCreateEventFromGLsyncKHR, clCreateFromGLBuffer, clCreateFromGLRenderbuffer,
clCreateFromGLTexture, clCreateFromGLTexture2D, clCreateFromGLTexture3D,
clEnqueueAcquireGLObjects, clEnqueueReleaseGLObjects, clGetGLContextInfoKHR, clGetGLObjectInfo,
clGetGLTextureInfo,
};
use super::info_type::InfoType;
use super::{api_info_size, api_info_value, api_info_vector};
#[allow(unused_imports)]
use libc::{c_void, intptr_t, size_t};
use std::mem;
use std::ptr;
/// Create an `OpenCL` buffer object for a context from an OpenGL buffer.
/// Calls clCreateFromGLBuffer to create an `OpenCL` buffer object.
///
/// * `context` - a valid `OpenCL` context created from an OpenGL context.
/// * `flags` - a bit-field used to specify allocation and usage information
/// about the image memory object being created, see:
/// [Memory Flags](https://www.khronos.org/registry/OpenCL/specs/3.0-unified/html/OpenCL_API.html#memory-flags-table).
/// * `bufobj` - the OpenGL buffer.
///
/// returns a Result containing the new `OpenCL` buffer object
/// or the error code from the `OpenCL` C API function.
#[inline]
pub unsafe fn create_from_gl_buffer(
context: cl_context,
flags: cl_mem_flags,
bufobj: cl_GLuint,
) -> Result<cl_mem, cl_int> {
let mut status: cl_int = CL_INVALID_VALUE;
let mem = clCreateFromGLBuffer(context, flags, bufobj, &mut status);
if CL_SUCCESS == status {
Ok(mem)
} else {
Err(status)
}
}
/// Create an `OpenCL` image object, image array object, or image buffer object
/// for a context from an OpenGL texture object, texture array object,
/// texture buffer object, or a single face of an OpenGL cubemap texture object.
/// Calls clCreateFromGLTexture to create an `OpenCL` memory object.
///
/// * `context` - a valid `OpenCL` context created from an OpenGL context.
/// * `flags` - a bit-field used to specify allocation and usage information
/// about the image memory object being created, see:
/// [Memory Flags](https://www.khronos.org/registry/OpenCL/specs/3.0-unified/html/OpenCL_API.html#memory-flags-table).
/// * `texture_target` - used to define the image type of texture.
/// * `miplevel ` - used to define the mipmap level.
/// * `texture ` - the name of a GL buffer texture object.
///
/// returns a Result containing the new `OpenCL` image object
/// or the error code from the `OpenCL` C API function.
#[inline]
pub unsafe fn create_from_gl_texture(
context: cl_context,
flags: cl_mem_flags,
texture_target: cl_GLenum,
miplevel: cl_GLint,
texture: cl_GLuint,
) -> Result<cl_mem, cl_int> {
let mut status: cl_int = CL_INVALID_VALUE;
let mem = clCreateFromGLTexture(
context,
flags,
texture_target,
miplevel,
texture,
&mut status,
);
if CL_SUCCESS == status {
Ok(mem)
} else {
Err(status)
}
}
/// Create an `OpenCL` 2D image object from an OpenGL renderbuffer object.
/// Calls clCreateFromGLRenderbuffer to create an `OpenCL` buffer object.
///
/// * `context` - a valid `OpenCL` context created from an OpenGL context.
/// * `flags` - a bit-field used to specify allocation and usage information
/// about the image memory object being created, see:
/// [Memory Flags](https://www.khronos.org/registry/OpenCL/specs/3.0-unified/html/OpenCL_API.html#memory-flags-table).
/// * `renderbuffer` - a GL renderbuffer object.
///
/// returns a Result containing the new `OpenCL` image object
/// or the error code from the `OpenCL` C API function.
#[inline]
pub unsafe fn create_from_gl_render_buffer(
context: cl_context,
flags: cl_mem_flags,
renderbuffer: cl_GLuint,
) -> Result<cl_mem, cl_int> {
let mut status: cl_int = CL_INVALID_VALUE;
let mem = clCreateFromGLRenderbuffer(context, flags, renderbuffer, &mut status);
if CL_SUCCESS == status {
Ok(mem)
} else {
Err(status)
}
}
/// Query an OpenGL object used to create an `OpenCL` memory object.
/// Calls clGetGLObjectInfo to get the object type and name.
///
/// * `memobj` - a valid `OpenCL` memory object handle.
///
/// returns a Result containing the OpenGL object type and name
/// or the error code from the `OpenCL` C API function.
#[inline]
pub fn get_gl_object_info(memobj: cl_mem) -> Result<(cl_GLuint, cl_GLuint), cl_int> {
let mut object_type: cl_uint = CL_GL_OBJECT_BUFFER;
let mut object_name: cl_uint = 0;
let status = unsafe { clGetGLObjectInfo(memobj, &mut object_type, &mut object_name) };
if CL_SUCCESS == status {
Ok((object_type, object_name))
} else {
Err(status)
}
}
/// Get data about an OpenGL texture object.
/// Calls clGetGLTextureInfo to get the desired data about the texture object.
pub fn get_gl_texture_data(
memobj: cl_mem,
param_name: cl_gl_texture_info,
) -> Result<Vec<u8>, cl_int> {
api_info_size!(get_size, clGetGLTextureInfo);
let size = get_size(memobj, param_name)?;
api_info_vector!(get_vector, u8, clGetGLTextureInfo);
get_vector(memobj, param_name, size)
}
/// Get information about the GL texture object associated with a memory object.
/// Calls clGetGLTextureInfo to get the desired information.
///
/// * `memobj` - the `OpenCL` memory object.
/// * `param_name` - the type of memory object information being queried, see:
/// [Texture Info](https://www.khronos.org/registry/OpenCL//sdk/2.2/docs/man/html/clGetGLTextureInfo.html).
///
/// returns a Result containing the desired information in an `InfoType` enum
/// or the error code from the `OpenCL` C API function.
pub fn get_gl_texture_info(
memobj: cl_mem,
param_name: cl_gl_texture_info,
) -> Result<InfoType, cl_int> {
match param_name {
CL_GL_TEXTURE_TARGET => {
api_info_value!(get_value, cl_GLenum, clGetGLTextureInfo);
Ok(InfoType::Uint(get_value(memobj, param_name)?))
}
CL_GL_MIPMAP_LEVEL | CL_GL_NUM_SAMPLES => {
api_info_value!(get_value, cl_GLint, clGetGLTextureInfo);
Ok(InfoType::Int(get_value(memobj, param_name)?))
}
_ => Ok(InfoType::VecUchar(get_gl_texture_data(memobj, param_name)?)),
}
}
/// Acquire `OpenCL` memory objects that have been created from `OpenGL` objects.
/// Calls `clEnqueueAcquireGLObjects`.
///
/// * `command_queue` - a valid `OpenCL` `command_queue`.
/// * `num_objects` - the number of memory objects to acquire.
/// * `mem_objects` - the memory objects to acquire.
/// * `num_events_in_wait_list` - the number of events in the wait list.
/// * `event_wait_list` - the wait list events.
///
/// returns a Result containing the new `OpenCL` event
/// or the error code from the `OpenCL` C API function.
#[inline]
pub unsafe fn enqueue_acquire_gl_objects(
command_queue: cl_command_queue,
num_objects: cl_uint,
mem_objects: *const cl_mem,
num_events_in_wait_list: cl_uint,
event_wait_list: *const cl_event,
) -> Result<cl_event, cl_int> {
let mut event: cl_event = ptr::null_mut();
let status: cl_int = clEnqueueAcquireGLObjects(
command_queue,
num_objects,
mem_objects,
num_events_in_wait_list,
event_wait_list,
&mut event,
);
if CL_SUCCESS == status {
Ok(event)
} else {
Err(status)
}
}
/// Release `OpenCL` memory objects that have been created from `OpenGL` objects.
/// Calls `clEnqueueReleaseGLObjects`.
///
/// * `command_queue` - a valid `OpenCL` `command_queue`.
/// * `num_objects` - the number of memory objects to acquire.
/// * `mem_objects` - the memory objects to acquire.
/// * `num_events_in_wait_list` - the number of events in the wait list.
/// * `event_wait_list` - the wait list events.
///
/// returns a Result containing the new `OpenCL` event
/// or the error code from the `OpenCL` C API function.
#[inline]
pub unsafe fn enqueue_release_gl_objects(
command_queue: cl_command_queue,
num_objects: cl_uint,
mem_objects: *const cl_mem,
num_events_in_wait_list: cl_uint,
event_wait_list: *const cl_event,
) -> Result<cl_event, cl_int> {
let mut event: cl_event = ptr::null_mut();
let status: cl_int = clEnqueueReleaseGLObjects(
command_queue,
num_objects,
mem_objects,
num_events_in_wait_list,
event_wait_list,
&mut event,
);
if CL_SUCCESS == status {
Ok(event)
} else {
Err(status)
}
}
/// Create an `OpenCL` 2D image object from an `OpenGL` 2D texture object,
/// or a single face of an OpenGL cubemap texture object.
/// Calls clCreateFromGLTexture2D to create an `OpenCL` memory object.
/// Deprecated in `CL_VERSION_1_2`, use `create_from_gl_texture`.
///
/// * `context` - a valid `OpenCL` context created from an OpenGL context.
/// * `flags` - a bit-field used to specify allocation and usage information
/// about the image memory object being created, see:
/// [Memory Flags](https://www.khronos.org/registry/OpenCL/specs/3.0-unified/html/OpenCL_API.html#memory-flags-table).
/// * `texture_target` - used to define the image type of texture.
/// * `miplevel ` - used to define the mipmap level.
/// * `texture ` - the name of a GL 2D, cubemap or rectangle texture object.
///
/// returns a Result containing the new `OpenCL` image object
/// or the error code from the `OpenCL` C API function.
#[cfg_attr(
any(
feature = "CL_VERSION_1_2",
feature = "CL_VERSION_2_0",
feature = "CL_VERSION_2_1",
feature = "CL_VERSION_2_2",
feature = "CL_VERSION_3_0"
),
deprecated(
since = "0.1.0",
note = "From CL_VERSION_1_2 use create_from_gl_texture"
)
)]
#[inline]
pub unsafe fn create_from_gl_texture_2d(
context: cl_context,
flags: cl_mem_flags,
texture_target: cl_GLenum,
miplevel: cl_GLint,
texture: cl_GLuint,
) -> Result<cl_mem, cl_int> {
let mut status: cl_int = CL_INVALID_VALUE;
let mem = clCreateFromGLTexture2D(
context,
flags,
texture_target,
miplevel,
texture,
&mut status,
);
if CL_SUCCESS == status {
Ok(mem)
} else {
Err(status)
}
}
/// Create an `OpenCL` 3D image object from an OpenGL 3D texture object.
/// Calls `clCreateFromGLTexture3D` to create an `OpenCL` memory object.
/// Deprecated in `CL_VERSION_1_2`, use `create_from_gl_texture`.
///
/// * `context` - a valid `OpenCL` context created from an OpenGL context.
/// * `flags` - a bit-field used to specify allocation and usage information
/// about the image memory object being created, see:
/// [Memory Flags](https://www.khronos.org/registry/OpenCL/specs/3.0-unified/html/OpenCL_API.html#memory-flags-table).
/// * `texture_target` - used to define the image type of texture.
/// * `miplevel ` - used to define the mipmap level.
/// * `texture ` - the name of a GL 2D, cubemap or rectangle texture object.
///
/// returns a Result containing the new `OpenCL` image object
/// or the error code from the `OpenCL` C API function.
#[cfg_attr(
any(
feature = "CL_VERSION_1_2",
feature = "CL_VERSION_2_0",
feature = "CL_VERSION_2_1",
feature = "CL_VERSION_2_2",
feature = "CL_VERSION_3_0"
),
deprecated(
since = "0.1.0",
note = "From CL_VERSION_1_2 use create_from_gl_texture"
)
)]
#[inline]
pub unsafe fn create_from_gl_texture_3d(
context: cl_context,
flags: cl_mem_flags,
texture_target: cl_GLenum,
miplevel: cl_GLint,
texture: cl_GLuint,
) -> Result<cl_mem, cl_int> {
let mut status: cl_int = CL_INVALID_VALUE;
let mem = clCreateFromGLTexture3D(
context,
flags,
texture_target,
miplevel,
texture,
&mut status,
);
if CL_SUCCESS == status {
Ok(mem)
} else {
Err(status)
}
}
/// Get OpenGL context information.
/// Calls `clGetGLContextInfoKHR` to get the desired information.
///
/// * `properties` - the `OpenCL` context properties.
/// * `param_name` - the type of memory object information being queried, see:
/// [Context Info](https://www.khronos.org/registry/OpenCL//sdk/2.2/docs/man/html/clGetGLContextInfoKHR.html).
///
/// returns a Result containing the desired information in an `InfoType` enum
/// or the error code from the `OpenCL` C API function.
#[cfg(feature = "cl_khr_gl_sharing")]
pub fn get_gl_context_info_khr(
properties: *mut cl_context_properties,
param_name: cl_gl_context_info,
) -> Result<InfoType, cl_int> {
match param_name {
CL_CURRENT_DEVICE_FOR_GL_CONTEXT_KHR => {
let mut data: intptr_t = 0;
let data_ptr: *mut intptr_t = &mut data;
let status = unsafe {
clGetGLContextInfoKHR(
properties,
param_name,
mem::size_of::<intptr_t>(),
data_ptr.cast::<c_void>(),
ptr::null_mut(),
)
};
if CL_SUCCESS == status {
Ok(InfoType::Ptr(data))
} else {
Err(status)
}
}
CL_DEVICES_FOR_GL_CONTEXT_KHR => {
// Get the size
let mut size: size_t = 0;
let status = unsafe {
clGetGLContextInfoKHR(properties, param_name, 0, ptr::null_mut(), &mut size)
};
if CL_SUCCESS != status {
Err(status)
} else if 0 < size {
// Get the data
let count = size / mem::size_of::<intptr_t>();
let mut data: Vec<intptr_t> = Vec::with_capacity(count);
let status = unsafe {
clGetGLContextInfoKHR(
properties,
param_name,
size,
data.as_mut_ptr().cast::<c_void>(),
ptr::null_mut(),
)
};
if CL_SUCCESS == status {
Ok(InfoType::VecIntPtr(data))
} else {
Err(status)
}
} else {
Ok(InfoType::VecIntPtr(Vec::default()))
}
}
_ => {
// Get the size
let mut size: size_t = 0;
let status = unsafe {
clGetGLContextInfoKHR(properties, param_name, 0, ptr::null_mut(), &mut size)
};
if CL_SUCCESS != status {
Err(status)
} else if 0 < size {
// Get the data
let mut data: Vec<u8> = Vec::with_capacity(size);
let status = unsafe {
clGetGLContextInfoKHR(
properties,
param_name,
size,
data.as_mut_ptr().cast::<c_void>(),
ptr::null_mut(),
)
};
if CL_SUCCESS == status {
Ok(InfoType::VecUchar(data))
} else {
Err(status)
}
} else {
Ok(InfoType::VecUchar(Vec::default()))
}
}
}
}
/// Create an event object linked to an OpenGL sync object.
/// Requires the `cl_khr_gl_event` extension
/// Calls `clCreateEventFromGLsyncKHR`.
///
/// * `context` - a valid `OpenCL` context.
/// * `sync` - the sync object in the GL share group associated with context.
///
/// returns a Result containing the new `OpenCL` event
/// or the error code from the `OpenCL` C API function.
#[cfg(feature = "cl_khr_gl_event")]
#[inline]
pub fn create_event_from_gl_sync_khr(
context: cl_context,
sync: cl_GLsync,
) -> Result<cl_event, cl_int> {
let mut status: cl_int = CL_INVALID_VALUE;
let event: cl_event = unsafe { clCreateEventFromGLsyncKHR(context, sync, &mut status) };
if CL_SUCCESS == status {
Ok(event)
} else {
Err(status)
}
}