blob: c152212f9c89fc748a8022c544d9a0a02b745bd1 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
<holder>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.</holder>
<!-- ================================ SYNOPSIS -->
<refnamediv id="clGetGLObjectInfo">
Query an OpenGL memory object used to create an OpenCL memory object.
<refsynopsisdiv xmlns:xlink=""><title></title>
<funcdef><link xlink:href="scalarDataTypes.html">cl_int</link>
<paramdef><link xlink:href="abstractDataTypes.html">cl_mem</link><parameter>memobj</parameter></paramdef>
<paramdef><link xlink:href="enums.html#cl_gl_object_type">cl_gl_object_type</link><parameter>*gl_object_type</parameter></paramdef>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters">
<term> <varname>gl_object_type </varname> </term>
Returns the type of GL object attached to <varname>memobj</varname>
and can be <constant>CL_GL_OBJECT_BUFFER</constant>,
<constant>CL_GL_OBJECT_TEXTURE_BUFFER</constant>, or
<constant>CL_GL_OBJECT_RENDERBUFFER</constant>. If
<varname>gl_object_type</varname> is NULL, it is ignored.
<term> <varname> gl_object_name </varname> </term>
Returns the GL object name used to create <varname>memobj</varname>. If
<varname>gl_object_name</varname> is NULL, it is ignored.
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
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 -->
<refsect1 id="errors"><title>Errors</title>
Returns <errorname>CL_SUCCESS</errorname> if the call was executed
successfully. Otherwise, it returns one of the following errors:
<itemizedlist mark="disc">
<errorname>CL_INVALID_MEM_OBJECT</errorname> if <varname>memobj</varname>
is not a valid OpenCL memory object.
<errorname>CL_INVALID_GL_OBJECT</errorname> if there is no GL object associated
with <varname>memobj</varname>.
<errorname>CL_OUT_OF_RESOURCES</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the device.
<errorname>CL_OUT_OF_HOST_MEMORY</errorname> if there is a failure to allocate
resources required by the OpenCL implementation on the host.
<!-- ================================ EXAMPLE -->
<refsect2 id="example1">
<informaltable frame="none">
<tgroup cols="1" align="left" colsep="0" rowsep="0">
<colspec colname="col1" colnum="1" />
Example goes here - it will be set in "code" type with white space preserved.
<!-- ================================ SPECIFICATION -->
<!-- Set the "uri" attribute in the <olink /> element to the "named destination" for the PDF page
<refsect1 id="specification"><title>Specification</title>
<imagedata fileref="pdficon_small1.gif" format="gif" />
<olink uri="clGetGLObjectInfo">OpenCL Specification</olink>
<!-- ================================ ALSO SEE -->
<refsect1 id="seealso"><title>Also see</title>
<!-- ============================== COPYRIGHT -->
<!-- Content included from -->
<refsect3 id="Copyright"><title></title>
<imagedata fileref="KhronosLogo.jpg" format="jpg" />
<para />
<!-- 24-Oct-2011 -->