clGetGLTextureInfo(3clc)

clGetGLTextureInfo3clc

Returns additional information about the gl texture object associated with a memory object.

cl_int clGetGLTextureInfo(cl_mem memobj, cl_gl_texture_info param_name, size_t param_value_size, void *param_value, size_t *param_value_size_ret);

Parameters

param_name

Specifies what additional information about the GL texture object associated with memobj to query. The list of supported param_name types and the information returned in param_value by clGetGLTextureInfo is described in the table below.

param_value

A pointer to memory where the result being queried is returned. If param_value is NULL, it is ignored.

param_value_size

Specifies the size in bytes of memory pointed to by param_value. This size must be ≥ size of return type as described in the table below.

param_value_size_ret

Returns the actual size in bytes of data copied to param_value. If param_value_size_ret is NULL, it is ignored.

cl_gl_texture_infoReturn TypeInformation returned in param_value
CL_GL_TEXTURE_TARGETGLenumThe texture_target argument specified in clCreateFromGLTexture(3clc).
CL_GL_MIPMAP_LEVELGLintThe miplevel argument specified in clCreateFromGLTexture(3clc).

Errors

Returns CL_SUCCESS if the function is 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 texture object associated with memobj.

• CL_INVALID_VALUE if param_name is not valid, or if size in bytes specified by param_value_size is < size of return type as described in the table above and param_value is not NULL, or if param_value and param_value_size_ret are NULL.

• 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 55, 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.