cl-sys 0.4.2

OpenCL FFI bindings.
Documentation
//! CGL (Apple) stuff.

pub use cl_h::cl_context_properties;

// Introduced in Mac OS X 10.6
pub const CL_CONTEXT_PROPERTY_USE_CGL_SHAREGROUP_APPLE: cl_context_properties = 0x10000000;

// /*******************************************************************************
//  * Copyright (c) 2008 - 2012 The Khronos Group Inc.
//  *
//  * Permission is hereby granted, free of charge, to any person obtaining a
//  * copy of this software and/or associated documentation files (the
//  * "Materials"), to deal in the Materials without restriction, including
//  * without limitation the rights to use, copy, modify, merge, publish,
//  * distribute, sublicense, and/or sell copies of the Materials, and to
//  * permit persons to whom the Materials are furnished to do so, subject to
//  * the following conditions:
//  *
//  * The above copyright notice and this permission notice shall be included
//  * in all copies or substantial portions of the Materials.
//  *
//  * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
//  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
//  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
//  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
//  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
//  * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
//  ******************************************************************************/
//
// #ifndef __OPENCL_CL_GL_EXT_H
// #define __OPENCL_CL_GL_EXT_H
//
// #ifdef __cplusplus
// extern "C" {
// #endif
//
// #include <OpenCL/cl_gl.h>
//
// #include <OpenGL/CGLTypes.h>
// #include <OpenGL/CGLDevice.h>
//
// #ifndef AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER
// #include <IOSurface/IOSurface.h>
// #endif
//
// /* Context GL sharing
//  *
//  * Please check for the "cl_APPLE_gl_sharing" extension using clGetDeviceInfo(CL_DEVICE_EXTENSIONS)
//  * before using these extensions.
//
//  * Apple extension for creating a CL context from a CGL share group
//  *
//  * This enumerated value can be specified as part of the <properties> argument passed to clCreateContext
//  * to allow OpenCL compliant devices in an existing CGL share group to be used as the devices in
//  * the newly created CL context. GL objects that were allocated in the given CGL share group can
//  * now be shared between CL and GL.
//  *
//  * If the <num_devices> and <devices> argument values to clCreateContext are 0 and NULL respectively,
//  * all CL compliant devices in the CGL share group will be used to create the context.
//  * Additional CL devices can also be specified using the <num_devices> and <devices> arguments.
//  * These, however, cannot be GPU devices. On Mac OS X, you can add the CPU to the list of CL devices
//  * (in addition to the CL compliant devices in the CGL share group) used to create the CL context.
//  * Note that if a CPU device is specified, the CGL share group must also include the GL float renderer;
//  * Otherwise CL_INVALID_DEVICE will be returned.
//  *
//  * NOTE:  Make sure that appropriate cl_gl.h header file is included separately
//  */
// #define CL_CONTEXT_PROPERTY_USE_CGL_SHAREGROUP_APPLE        0x10000000 /* Introduced in Mac OS X 10.6 */
//
// /* Apple extension for retrieving OpenGL context information for a CL context
//  * created via the above method.
//  *
//  * Provides a query mechanism to retrieve OpenGL context specific information
//  * from an OpenCL context to help identify device specific mappings and usage.
//  *
//  * For example, one possible usage would be to allow the client to map a CGL
//  * virtual screen index to an appropriate CL device id to insure that the
//  * rendering device and the compute device are the same, thus guaranteeing
//  * any shared OpenGL memory that is attached o a CL memory object remains
//  * resident on the active device.
//  */
//
// cl_int	clGetGLContextInfoAPPLE ( cl_context __nonnull /* context */,
// 								  void * __nonnull /* platform_gl_ctx */,
// 								  cl_gl_platform_info /* param_name */,
// 								  size_t /* param_value_size */,
// 								  void *  __nullable /* param_value */,
// 								  size_t * __nullable /* param_value_size_ret */)  CL_EXT_SUFFIX__VERSION_1_0;
//
// /* The list of supported param_name values and the information returned in param_value by
//  * clGetContextInfo are listed below:
//
//  * Returns a cl_device_id for the CL device associated with the virtual screen for
//  * the given CGL context.  Return type: cl_device_id
//  */
// #define CL_CGL_DEVICE_FOR_CURRENT_VIRTUAL_SCREEN_APPLE 		0x10000002 /* Introduced in Mac OS X 10.6 */
//
// /* Returns an array of cl_device_ids for the CL device(s) corresponding to
//  * the virtual screen(s) for the given CGL context.   Return type: cl_device_id[]
//  */
// #define CL_CGL_DEVICES_FOR_SUPPORTED_VIRTUAL_SCREENS_APPLE	0x10000003 /* Introduced in Mac OS X 10.6 */
//
// /* Error code returned by clGetGLContextInfoAPPLE if an invalid platform_gl_ctx is provided           */
// #define CL_INVALID_GL_CONTEXT_APPLE                         -1000      /* Introduced in Mac OS X 10.6 */
//
// /*
//  *  cl_khr_gl_event  extension
//  *  See section 9.9 in the OpenCL 1.1 spec for more information
//  */
// #define CL_COMMAND_GL_FENCE_SYNC_OBJECT_KHR     0x200D
//
// extern CL_API_ENTRY cl_event __nullable CL_API_CALL
// clCreateEventFromGLsyncKHR(cl_context __nonnull  /* context */,
//                            cl_GLsync  __nonnull  /* cl_GLsync */,
//                            cl_int *   __nullable /* errcode_ret */) CL_EXT_SUFFIX__VERSION_1_1;
//
// #ifdef AVAILABLE_MAC_OS_X_VERSION_10_7_AND_LATER
// typedef struct __IOSurface* IOSurfaceRef;
// #endif
//
// cl_mem __nullable clCreateImageFromIOSurface2DAPPLE(cl_context __nonnull /* context */,
// 										 cl_mem_flags /* flags */,
// 										 const cl_image_format * __nonnull /* image_format */,
// 										 size_t /* image_width */,
// 										 size_t /* image_height */,
// 										 IOSurfaceRef __nonnull/* iosurface */,
// 										 cl_int * __nullable /* errcode_ret */) CL_EXT_SUFFIX__VERSION_1_1;
//
// typedef intptr_t cl_iosurface_properties_APPLE;
//
// /* Specifies the IOSurfaceRef used to create the cl_mem image object. */
// #define CL_IOSURFACE_REF_APPLE                              0x10000019 /* Introduced in Mac OS X 10.9 */
//
// /* Specifies the plane of the IOSurface that the cl_mem should be bound. Default 0 */
// #define CL_IOSURFACE_PLANE_APPLE                            0x1000001a /* Introduced in Mac OS X 10.9 */
//
// /*
//  * Create a 2D CL image from an IOSurface given a format, optional description, and property list. If
//  * the image_desc argument is NULL, the width and height of the IOSurfaceRef will be used.
//  */
// cl_mem __nullable clCreateImageFromIOSurfaceWithPropertiesAPPLE(cl_context __nonnull /* context */,
//                       cl_mem_flags                              /* flags */,
//                       const cl_image_format * __nonnull         /* image_format */,
//                       const cl_image_desc *   __nonnull         /* image_desc */,
//                       cl_iosurface_properties_APPLE * __nonnull /* properties */,
//                       cl_int * __nullable                       /* errcode_ret */) CL_EXT_SUFFIX__VERSION_1_2;
//
// /* Query parameter name for clGetImageInfo that returns the IOSurface backing the image (IOSurfaceRef) */
// #define CL_IMAGE_IOSURFACE_APPLE                            0x1000001b /* Introduced in Mac OS X 10.9 */
//
// /* Query parameter name for clGetImageInfo that returns the plane of the IOSurface backing the image (cl_uint) */
// #define CL_IMAGE_IOSURFACE_PLANE_APPLE                      0x1000001c /* Introduced in Mac OS X 10.9 */
//
// #ifdef __cplusplus
// }
// #endif
//
// #endif /* __OPENCL_CL_GL_EXT_H */