CLGETGLOBJECTINFO(3clc)

📦
version 1.0~svn33624 · 3 versions
, in ubuntu jammy, ubuntu noble

💖 CLGETGLOBJECTINFO 💖

okay bestie, pull up a chair, because we're talking about the OpenCL Manual's very own clGetGLObjectInfo from the 3clc section. this is the lil function that lets you peek at the OpenGL memory object that got used to make an OpenCL memory object. no cap, it's giving detective energy 🔍✨

✨ NAME ✨

clGetGLObjectInfo — Query an OpenGL memory object used to create an OpenCL memory object.

🌸 SYNOPSIS 🌸

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

🎀 PARAMETERS 🎀

  • gl_object_type — this one returns the type of GL object attached to memobj, and it can be any of these icons: 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. and if gl_object_type is NULL? literally ignored. she said not today 💅
  • gl_object_name — this one returns the GL object name that was used to create memobj. and if gl_object_name is NULL, it is ignored too. equality, we love to see it 🫶

🦋 DESCRIPTION 🦋

so basically, the OpenGL object that was used to create the OpenCL memory object — plus info about the object type, like whether it's a texture, a renderbuffer, or a buffer object — can all be queried using this function. it's the group chat where GL and CL finally talk to each other, and honestly? iconic. 🌈

💀 ERRORS 💀

returns CL_SUCCESS if the call was executed successfully. otherwise, it returns one of the following errors, and yes we're reading them all, don't scroll past:

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

👀 SEE ALSO 👀

👑 AUTHORS 👑

The Khronos Group

Copyright © 2007-2011 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 condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.

📝 NOTES 📝

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

and that's the whole page, bestie!! 🎉 this cutie came to you courtesy of The Khronos Group, dated 01/14/2021, and it lives under CLGETGLOBJECTINFO(3clc). mwah, go query some GL objects responsibly 💋✨🦋

📦 where this page comes from