blob: 0dc83d0467df7e845a85296bdfc7138e8c7d4778 [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="clCreateFromGLBuffer">
Creates an OpenCL buffer object from an OpenGL buffer 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 for
table 5.3 --> for a description of <varname>flags</varname>. Only
<constant>CL_MEM_READ_ONLY</constant>, <constant>CL_MEM_WRITE_ONLY</constant>
and <constant>CL_MEM_READ_WRITE</constant> values specified in the table at
<!-- table 5.3 --> can be used.
<term> <varname> bufobj </varname> </term>
<!-- parameter description --> The name of a GL buffer object. The data
store of the GL buffer object must have have been previously created by
calling OpenGL function <function>glBufferData</function>, although its
contents need not be initialized. The size of the data store will be used
to determine the size of the CL buffer 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>
The size of the GL buffer object data store at the time
<function>clCreateFromGLBuffer</function> is called will be used as the size of buffer
object returned by <function>clCreateFromGLBuffer</function>. If the state of a GL
buffer object is modified through the GL API (e.g. <function>glBufferData</function>)
while there exists a corresponding CL buffer object, subsequent use of the CL buffer
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 buffer object.
The CL buffer object created using <function>clCreateFromGLBuffer</function> can also
be used to create a CL 1D image buffer object
<!-- ================================ ERRORS -->
<refsect1 id="errors"><title>Errors</title>
Returns a valid non-zero OpenCL buffer object and <varname>errcode_ret</varname> is set
to CL_SUCCESS if the buffer 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>bufobj</varname> is not
a GL buffer object or is a GL buffer object but does not have an existing data
store e or the size of the buffer is 0. .
<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="clCreateFromGLBuffer">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 -->