C Specification

To query additional information about the OpenGL texture object associated with an OpenCL memory object, call the function

// Provided by cl_khr_gl_sharing
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);
clGetGLTextureInfo is provided by the cl_khr_gl_sharing extension.

Parameters

  • memobj is the memory object to query.

  • param_name specifies what additional information about the OpenGL 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 is 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 greater than or equal to the size of the return type specified in the OpenGL Texture Queries table. If param_value is NULL, it is ignored.

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

Description

Table 1. OpenGL texture info that may be queried with clGetGLTextureInfo
cl_gl_texture_info Return Type Info. Returned in param_value

CL_GL_TEXTURE_TARGET

provided by the cl_khr_gl_sharing extension.

GLenum

The texture_target argument specified in clCreateFromGLTexture.

CL_GL_MIPMAP_LEVEL

provided by the cl_khr_gl_sharing extension.

GLint

The miplevel argument specified in clCreateFromGLTexture.

CL_GL_NUM_SAMPLES

provided by the cl_khr_gl_msaa_sharing extension.

GLsizei

The samples argument passed to glTexImage2DMultisample or glTexImage3DMultisample.

If image is not a MSAA texture, 1 is returned.

clGetGLTextureInfo 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 OpenGL texture object associated with memobj.

  • CL_INVALID_VALUE if param_name is not one of the supported values, or if the size in bytes specified by param_value_size is less than size of the return type specified in the OpenGL Texture Queries table and param_value is not NULL.

  • CL_INVALID_VALUE 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.

See Also

cl_gl_texture_info, cl_khr_gl_sharing, cl_mem

Document Notes

For more information, see the OpenCL Specification

This page is extracted from the OpenCL Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2025 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0