| <?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
| <!-- saved from url=(0013)about:internet --> | |
| <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | |
| <style xmlns="" type="text/css"> | |
| /* This style sets a margin around the entire page */ | |
| html, body { | |
| margin: 10px; | |
| } | |
| p { | |
| font: normal 16px verdana, sans-serif; | |
| margin: 0; | |
| padding-bottom:12px; | |
| } | |
| h1 { | |
| font: bold 25px verdana, sans-serif; | |
| margin-top: 0; | |
| margin-bottom: 3px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| h2 { | |
| font: bold 19px verdana, sans-serif; | |
| margin-top: 28px; | |
| margin-bottom: 3px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| h3 { | |
| font: bold 19px verdana, sans-serif !important; | |
| margin-top: 28px; | |
| margin-bottom: 3px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| li { | |
| font: normal 16px verdana, sans-serif; | |
| margin-top: 0; | |
| margin-bottom: 18px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| .pdparam { | |
| font: italic 16px verdana, sans-serif; | |
| } | |
| .term { | |
| font: italic 16px verdana, sans-serif; | |
| font-weight: normal; | |
| } | |
| .type { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| .parameter { | |
| font-style: italic; | |
| } | |
| a:link, a:visited { | |
| color: blue; | |
| text-decoration: none; | |
| font: normal 16px; | |
| } | |
| a:hover { | |
| background-color: #FFFF99; | |
| font: normal 16px; | |
| } | |
| div.funcsynopsis { | |
| text-align: left; | |
| background-color: #e6e6e6; | |
| font: normal 16px verdana, sans-serif; | |
| padding-top: 10px; | |
| padding-bottom: 10px; | |
| } | |
| div.funcsynopsis table { | |
| border-collapse: separate; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.funcsynopsis td { | |
| background-color: #e6e6e6; | |
| border: 0 solid #000; | |
| padding: 1px; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.refsect1 { | |
| font-family: verdana, sans-serif; | |
| font-size: 16px; | |
| } | |
| code.constant { | |
| font: normal 16px courier new, monospace !important; | |
| } | |
| span.errorname { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| code.function { | |
| font: bold 16px verdana, sans-serif !important; | |
| } | |
| b.fsfunc { | |
| font: bold 16px verdana, sans-serif !important; | |
| } | |
| code.varname { | |
| font: italic 16px verdana, sans-serif; | |
| } | |
| code.replaceable { | |
| font: italic 16px courier new, monospace; | |
| } | |
| code.funcdef { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| .citerefentry { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| .parameter { | |
| font-style: italic; | |
| } | |
| code.fsfunc { | |
| font: normal 16px verdana, sans-serif !important; | |
| } | |
| /* PARAMETER: This style controls spacing between the terms in Parameter section */ | |
| dt { | |
| margin-top: 15px; | |
| } | |
| /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */ | |
| div.refsect1 table { | |
| width: 100%; | |
| margin-top: 10px; | |
| background-color: #FFF; | |
| border-collapse: collapse; | |
| border-color: #000; | |
| border-width: 1px; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.refsect1 th { | |
| border-collapse: collapse; | |
| border-color: #000; | |
| border-width: 1px; | |
| font: bold 16px verdana, sans-serif; | |
| } | |
| div.refsect1 td { | |
| background-color: #FFF; | |
| padding: 5px; | |
| vertical-align: text-top; | |
| border-collapse: collapse; | |
| border-color: #000; | |
| border-width: 1px; | |
| font: normal 16px verdana, sans-serif; | |
| } | |
| div.refsect1 p{ | |
| font: normal 16px verdana, sans-serif; | |
| margin-top: 8px; | |
| margin-bottom: 8px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| /* EXAMPLE: These styles apply only to the Example section */ | |
| div.refsect2 { | |
| font: normal 16px courier new, monospace !important; | |
| } | |
| div.refsect2 table { | |
| margin-top: 0; | |
| background-color: #e6e6e6; | |
| width: 100%; | |
| border: 0 solid #000; | |
| padding: 2px; | |
| font: normal 16px courier new, monospace !important; | |
| } | |
| div.refsect2 td { | |
| background-color: #e6e6e6; | |
| font: normal 16px courier new, monospace !important; | |
| white-space:pre; | |
| } | |
| /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */ | |
| div.refsect3 { | |
| font: normal 11px verdana, sans-serif; | |
| margin-top: 50px; | |
| margin-bottom: 20px; | |
| padding-top: 0; | |
| padding-bottom: 0; | |
| } | |
| </style> | |
| <title>clCreateFromGLRenderbuffer</title> | |
| <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /> | |
| <meta name="keywords" content="clCreateFromGLRenderbuffer" /> | |
| </head> | |
| <body> | |
| <div class="refentry"> | |
| <a id="id-1"></a> | |
| <div class="titlepage"></div> | |
| <div xmlns="" class="refnamediv"> | |
| <a xmlns="http://www.w3.org/1999/xhtml" id="clCreateFromGLRenderbuffer"></a> | |
| <h1>clCreateFromGLRenderbuffer</h1> | |
| <p> | |
| Creates an OpenCL 2D image object from an OpenGL renderbuffer object. | |
| </p> | |
| </div> | |
| <div class="refsynopsisdiv"> | |
| <h2></h2> | |
| <div class="funcsynopsis"> | |
| <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> | |
| <tr valign="bottom"> | |
| <td> | |
| <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef"><a class="link" href="abstractDataTypes.html" target="pagedisplay">cl_mem</a> | |
| <strong class="fsfunc"> | |
| clCreateFromGLRenderbuffer | |
| </strong> | |
| (</code> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_context</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var>, </td> | |
| </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_mem_flags" target="pagedisplay">cl_mem_flags</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">flags</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td>GLuint <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">renderbuffer</var>, </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">* errcode_ret</var><code>)</code></td> | |
| </tr> | |
| </table> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="parameters"></a> | |
| <h2>Parameters</h2> | |
| <div class="variablelist"> | |
| <dl class="variablelist"> | |
| <dt> | |
| <span class="term"> <code class="varname"> context </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A valid OpenCL context created from an OpenGL context. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> flags </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A bit-field that is | |
| used to specify usage information. Refer to the table at | |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a> | |
| for a description of <code class="varname">flags</code>. Only | |
| <code class="constant">CL_MEM_READ_ONLY</code>, | |
| <code class="constant">CL_MEM_WRITE_ONLY</code>, and | |
| <code class="constant">CL_MEM_READ_WRITE</code> values specified in the table at | |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a> | |
| can be used. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> renderbuffer </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| The name of a GL renderbuffer | |
| object. The renderbuffer storage must be specified before the | |
| image object can be created. The <code class="varname">renderbuffer</code> | |
| 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 | |
| and the table of supported Image Channel Data Types for | |
| <span class="type"><a class="citerefentry" href="cl_image_format.html"><span class="citerefentry"><span class="refentrytitle">cl_image_format</span></span></a></span> | |
| can be used to create the 2D image object. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> errcode_ret </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Returns an appropriate error code as described | |
| below. If <code class="varname">errcode_ret</code> is NULL, no error code is returned. | |
| </p> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="description"></a> | |
| <h2>Description</h2> | |
| <p> | |
| 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 <code class="function">glRenderbufferStorage</code>) while | |
| there exists a corresponding CL image object, subsequent use of the CL image object | |
| will result in undefined behavior. | |
| </p> | |
| <p> | |
| The <a class="citerefentry" href="clRetainMemObject.html"><span class="citerefentry"><span class="refentrytitle">clRetainMemObject</span></span></a> | |
| and <a class="citerefentry" href="clReleaseMemObject.html"><span class="citerefentry"><span class="refentrytitle">clReleaseMemObject</span></span></a> | |
| functions can be used to retain and release the image objects. | |
| </p> | |
| <p> | |
| The table below (Table 9.4) describes | |
| the list of GL texture internal formats and the corresponding CL image formats. If a GL | |
| texture object with an internal format from the table below is successfully created by | |
| OpenGL, then there is guaranteed to be a mapping to one of the corresponding CL image | |
| format(s) in that table. Texture objects created with other OpenGL internal formats may | |
| (but are not guaranteed to) have a mapping to a CL image format; if such mappings exist, | |
| they are guaranteed to preserve all color components, data types, and at least the number | |
| of bits/component actually allocated by OpenGL for that format. | |
| </p> | |
| <div class="informaltable"> | |
| <table border="1"> | |
| <colgroup> | |
| <col align="center" class="col1" /> | |
| <col align="center" class="col2" /> | |
| </colgroup> | |
| <thead> | |
| <tr> | |
| <th align="center">GL internal format</th> | |
| <th align="center">CL image format (channel order, channel data type)</th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">GL_RGBA8</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_UNORM_INT8 or CL_BGRA, CL_UNORM_INT8</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"><code class="constant">GL_RGBA</code>, <code class="constant">GL_UNSIGNED_INT_8_8_8_8_REV</code></td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_UNORM_INT8</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"><code class="constant">GL_BGRA</code>, <code class="constant">GL_UNSIGNED_INT_8_8_8_8_REV</code></td> | |
| <td align="center"> | |
| <code class="constant">CL_BGRA, CL_UNORM_INT8</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">GL_RGBA16</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_UNORM_INT16</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">GL_RGBA8I, GL_RGBA8I_EXT</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_SIGNED_INT8</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">GL_RGBA16I, GL_RGBA16I_EXT</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_SIGNED_INT16</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">GL_RGBA32I, GL_RGBA32I_EXT</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_SIGNED_INT32</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">GL_RGBA8UI, GL_RGBA8UI_EXT</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_UNSIGNED_INT8</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">GL_RGBA16UI, GL_RGBA16UI_EXT</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_UNSIGNED_INT16</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">GL_RGBA32UI, GL_RGBA32UI_EXT</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_UNSIGNED_INT32</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">GL_RGBA16F, GL_RGBA16F_ARB</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_HALF_FLOAT</code> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="center"> | |
| <code class="constant">GL_RGBA32F, GL_RGBA32F_ARB</code> | |
| </td> | |
| <td align="center"> | |
| <code class="constant">CL_RGBA, CL_FLOAT</code> | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="errors"></a> | |
| <h2>Errors</h2> | |
| <p> | |
| Returns a valid non-zero OpenCL image object and <code class="varname">errcode_ret</code> 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 <code class="varname">errcode_ret</code>: | |
| </p> | |
| <div class="itemizedlist"> | |
| <ul class="itemizedlist" style="list-style-type: disc; "> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_CONTEXT</span> if <code class="varname">context</code> is not | |
| a valid context or was not created from a GL context. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if values specified in | |
| <code class="varname">flags</code> are not valid. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_GL_OBJECT</span> if <code class="varname">renderbuffer</code> is not | |
| a GL renderbuffer object or if the width or height of <code class="varname">renderbuffer</code> | |
| is zero. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_IMAGE_FORMAT_DESCRIPTOR</span> if the OpenGL renderbuffer | |
| internal format does not map to a supported OpenCL image format. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_OPERATION</span> if <code class="varname">renderbuffer</code> | |
| is a multi-sample GL renderbuffer object. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate | |
| resources required by the OpenCL implementation on the device. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate | |
| resources required by the OpenCL implementation on the host. | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="specification"></a> | |
| <h2>Specification</h2> | |
| <p> | |
| <img src="pdficon_small1.gif" /> | |
| <a href="http://www.khronos.org/registry/cl/specs/opencl-1.2-extensions.pdf#page=53" target="OpenCL Spec">OpenCL Specification</a> | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="seealso"></a> | |
| <h2>Also see</h2> | |
| <p> | |
| <a class="citerefentry" href="cl_khr_gl_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_gl_sharing</span></span></a>, | |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a>, | |
| <a class="citerefentry" href="cl_image_format.html"><span class="citerefentry"><span class="refentrytitle">cl_image_format</span></span></a>, | |
| <a class="citerefentry" href="clRetainMemObject.html"><span class="citerefentry"><span class="refentrytitle">clRetainMemObject</span></span></a>, | |
| <a class="citerefentry" href="clReleaseMemObject.html"><span class="citerefentry"><span class="refentrytitle">clReleaseMemObject</span></span></a> | |
| </p> | |
| </div> | |
| <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>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. | |
| </div> | |
| </div> | |
| </body> | |
| </html> |