blob: 481947dc16954136c6dd509f5c08f4ba17d6d5cb [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"" [
<!ENTITY gl_formatsInc SYSTEM "gl_formatsInc.xml">
<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="clCreateFromGLRenderbuffer">
Creates an OpenCL 2D image object from an OpenGL renderbuffer object.
<refsynopsisdiv xmlns:xlink=""><title></title>
<funcdef><link xlink:href="abstractDataTypes.html">cl_mem</link>
<paramdef><link xlink:href="abstractDataTypes.html">cl_context</link><parameter>context</parameter></paramdef>
<paramdef><link xlink:href="enums.html#cl_mem_flags">cl_mem_flags</link><parameter>flags</parameter></paramdef>
<paramdef><link xlink:href="scalarDataTypes.html">cl_int</link><parameter>* errcode_ret</parameter></paramdef>
<!-- ================================ PARAMETERS -->
<refsect1 id="parameters">
<term> <varname> context </varname> </term>
<para> <!-- parameter description -->
A valid OpenCL context created from an OpenGL context.
<term> <varname> flags </varname> </term>
<!-- parameter description --> A bit-field that is
used to specify usage information. Refer to the table at
for a description of <varname>flags</varname>. Only
<constant>CL_MEM_WRITE_ONLY</constant>, and
<constant>CL_MEM_READ_WRITE</constant> values specified in the table at
can be used.
<term> <varname> renderbuffer </varname> </term>
<!-- parameter description --> The name of a GL renderbuffer
object. The renderbuffer storage must be specified before the
image object can be created. The <varname>renderbuffer</varname>
format and dimensions defined by OpenGL will be used to create the
2D image object. Only GL renderbuffers with internal formats that
map to appropriate image channel order and data type specified in
the table of supported Image Channel Order Values <!-- table 5.5 -->
and the table of supported Image Channel Data Types <!-- table 5.6 --> for
can be used to create the 2D image object.
<term> <varname> errcode_ret </varname> </term>
<!-- parameter description --> Returns an appropriate error code as described
below. If <varname>errcode_ret</varname> is NULL, no error code is returned.
<!-- ================================ DESCRIPTION -->
<refsect1 id="description"><title>Description</title>
If the state of a GL renderbuffer object is modified through the GL API (i.e. changes
to the dimensions or format used to represent pixels of the GL renderbuffer using
appropriate GL API calls such as <function>glRenderbufferStorage</function>) while
there exists a corresponding CL image object, subsequent use of the CL image object
will result in undefined behavior.
The <citerefentry><refentrytitle>clRetainMemObject</refentrytitle></citerefentry>
and <citerefentry><refentrytitle>clReleaseMemObject</refentrytitle></citerefentry>
functions can be used to retain and release the image objects.
<!-- table 9.4 -->
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
Returns a valid non-zero OpenCL image object and <varname>errcode_ret</varname> is set
to CL_SUCCESS if the image object is created successfully. Otherwise, it returns a NULL
value with one of the following error values returned in <varname>errcode_ret</varname>:
<itemizedlist mark="disc">
<errorname>CL_INVALID_CONTEXT</errorname> if <varname>context</varname> is not
a valid context or was not created from a GL context.
<errorname>CL_INVALID_VALUE</errorname> if values specified in
<varname>flags</varname> are not valid.
<errorname>CL_INVALID_GL_OBJECT</errorname> if <varname>renderbuffer</varname> is not
a GL renderbuffer object or if the width or height of <varname>renderbuffer</varname>
is zero.
<errorname>CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</errorname> if the OpenGL renderbuffer
internal format does not map to a supported OpenCL image format.
<errorname>CL_INVALID_OPERATION</errorname> if <varname>renderbuffer</varname>
is a multi-sample GL renderbuffer object.
<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="clCreateFromGLRenderbuffer">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 -->