clGetGLObjectInfo(3clc)

clGetGLObjectInfo3clc

Query an opengl memory object used to create an opencl memory object.

cl_int clGetGLObjectInfo(cl_mem memobj, cl_gl_object_type *gl_object_type, GLuint *gl_object_name);

Parameters

gl_object_type

Returns the type of GL object attached to memobj and can be CL_GL_OBJECT_BUFFER, CL_GL_OBJECT_TEXTURE2D, CL_GL_OBJECT_TEXTURE3D, CL_GL_OBJECT_TEXTURE2D_ARRAY, CL_GL_OBJECT_TEXTURE1D, CL_GL_OBJECT_TEXTURE1D_ARRAY, CL_GL_OBJECT_TEXTURE_BUFFER, or CL_GL_OBJECT_RENDERBUFFER. If gl_object_type is NULL, it is ignored.

gl_object_name

Returns the GL object name used to create memobj. If gl_object_name is NULL, it is ignored.

Overview

The OpenGL object used to create the OpenCL memory object and information about the object type i.e. whether it is a texture, renderbuffer, or buffer object can be queried using this function.

Errors

Returns CL_SUCCESS if the call was executed successfully. Otherwise, it returns one of the following errors:

• CL_INVALID_MEM_OBJECT if memobj is not a valid OpenCL memory object.

• CL_INVALID_GL_OBJECT if there is no GL object associated with memobj.

• CL_OUT_OF_RESOURCES if there is a failure to allocate resources required by the OpenCL implementation on the device.

• CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

Specification

OpenCL Specification[1]

Notes

1.

OpenCL Specification

page 54, section 9.7.5 - Querying GL object information from a CL...

Releases

5 releases since Debian 8 (Jessie); the text changed 3 times.

  1. 8–9
  2. 10
  3. 11
  4. 13

Authors

The Khronos Group

From opencl-1.2-man-doc 1.0~svn33624-5.1 in Debian 13 (Trixie). Parsed by carta from the page's man source.