| <?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>clGetMemObjectInfo</title> | |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /> | |
| <meta name="keywords" content="clGetMemObjectInfo" /> | |
| </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="clGetMemObjectInfo"></a> | |
| <h1> | |
| clGetMemObjectInfo | |
| </h1> | |
| <p> | |
| Get information that is common to all memory objects (buffer and image objects). | |
| </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="scalarDataTypes.html" target="pagedisplay">cl_int</a> | |
| <strong class="fsfunc">clGetMemObjectInfo</strong> | |
| (</code> | |
| <td> | |
| <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_mem</a> | |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">memobj</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_info" target="pagedisplay">cl_mem_info</a> | |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_name</var> | |
| , </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td> | |
| <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a> | |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">param_value_size</var> | |
| , </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td> | |
| <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">void</a> | |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*param_value</var> | |
| , </td> | |
| </tr> | |
| <tr valign="top"> | |
| <td> </td> | |
| <td> | |
| <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">size_t</a> | |
| <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*param_value_size_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"> memobj </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the memory object being queried. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> param_name </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Specifies the information to query. The list of supported | |
| <code class="varname">param_name</code> types and the | |
| information returned in <code class="varname">param_value</code> by | |
| <code class="function">clGetMemObjectInfo</code> is described | |
| in the table below. | |
| </p> | |
| <div class="informaltable"> | |
| <table class="informaltable" border="1"> | |
| <colgroup> | |
| <col align="left" class="col1" /> | |
| <col align="left" class="col2" /> | |
| <col align="left" class="col3" /> | |
| </colgroup> | |
| <thead> | |
| <tr> | |
| <th align="left">cl_mem_info</th> | |
| <th align="left">Return Type</th> | |
| <th align="left">Info. returned in <code class="varname">param_value</code></th> | |
| </tr> | |
| </thead> | |
| <tbody> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_TYPE</code> | |
| </td> | |
| <td align="left">cl_mem_object_type</td> | |
| <td align="left"> | |
| Returns one of the following values: | |
| <p> | |
| <code class="constant">CL_MEM_OBJECT_BUFFER</code> | |
| if <code class="varname">memobj</code> is created with | |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a> | |
| or | |
| <a class="citerefentry" href="clCreateSubBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateSubBuffer</span></span></a>. | |
| </p> | |
| <p> | |
| cl_image_desc.image_type argument value if | |
| <code class="varname">memobj</code> is created with | |
| <a class="citerefentry" href="clCreateImage.html"><span class="citerefentry"><span class="refentrytitle">clCreateImage</span></span></a>. | |
| </p> | |
| <p> | |
| <code class="constant">CL_MEM_OBJECT_PIPE</code> if <code class="varname">memobj</code> is | |
| created with | |
| <a class="citerefentry" href="clCreatePipe.html"><span class="citerefentry"><span class="refentrytitle">clCreatePipe</span></span></a>. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_FLAGS</code> | |
| </td> | |
| <td align="left">cl_mem_flags</td> | |
| <td align="left"> | |
| Returns the <code class="varname">flags</code> argument value | |
| specified when <code class="varname">memobj</code> is created with | |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a>, | |
| <a class="citerefentry" href="clCreateSubBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateSubBuffer</span></span></a>, | |
| <a class="citerefentry" href="clCreateImage.html"><span class="citerefentry"><span class="refentrytitle">clCreateImage</span></span></a>. | |
| or | |
| <a class="citerefentry" href="clCreatePipe.html"><span class="citerefentry"><span class="refentrytitle">clCreatePipe</span></span></a>. | |
| If <code class="varname">memobj</code> is a sub-buffer the memory | |
| access qualifiers inherited from parent buffer is also | |
| returned. | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_SIZE</code> | |
| </td> | |
| <td align="left">size_t</td> | |
| <td align="left"> | |
| Return actual size of the data store associated with | |
| <code class="varname">memobj</code> in bytes. | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_HOST_PTR</code> | |
| </td> | |
| <td align="left">void *</td> | |
| <td align="left"> | |
| <p> | |
| If <code class="varname">memobj</code> is created with | |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a> | |
| or | |
| <a class="citerefentry" href="clCreateImage.html"><span class="citerefentry"><span class="refentrytitle">clCreateImage</span></span></a> | |
| and <code class="constant">CL_MEM_USE_HOST_PTR</code> is | |
| specified in <code class="varname">mem_flags</code>, return the | |
| <code class="varname">host_ptr</code> argument value specified when | |
| <code class="varname">memobj</code> is created. Otherwise a NULL | |
| value is returned. | |
| </p> | |
| <p> | |
| If <code class="varname">memobj</code> is created with | |
| <a class="citerefentry" href="clCreateSubBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateSubBuffer</span></span></a>, | |
| return the <code class="varname">host_ptr</code> | |
| + <code class="varname">origin</code> value | |
| specified when <code class="varname">memobj</code> | |
| is created. <code class="varname">host_ptr</code> | |
| is the argument value specified to | |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a> | |
| and <code class="constant">CL_MEM_USE_HOST_PTR</code> is specified | |
| in <code class="varname">mem_flags</code> for memory object from | |
| which <code class="varname">memobj</code> is created. Otherwise a | |
| NULL value is returned. | |
| </p> </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_MAP_COUNT</code> | |
| </td> | |
| <td align="left">cl_uint</td> | |
| <td align="left"> | |
| Map count. The map count returned should be considered immediately stale. It is | |
| unsuitable for general use in applications. This feature is provided for debugging. | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_REFERENCE_COUNT</code> | |
| </td> | |
| <td align="left">cl_uint</td> | |
| <td align="left"> | |
| Return <code class="varname">memobj</code> reference count. The reference count returned should | |
| be considered immediately stale. It is unsuitable for general use in | |
| applications. This feature is provided for identifying memory leaks. | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_CONTEXT</code> | |
| </td> | |
| <td align="left">cl_context</td> | |
| <td align="left"> | |
| Return context specified when memory object is created. | |
| If <code class="varname">memobj</code> is created using | |
| <a class="citerefentry" href="clCreateSubBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateSubBuffer</span></span></a>, the context | |
| associated with the memory object specified as the <code class="varname">buffer</code> argument to | |
| <a class="citerefentry" href="clCreateSubBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateSubBuffer</span></span></a> is returned. | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_ASSOCIATED_- | |
| MEMOBJECT</code> | |
| </td> | |
| <td align="left">cl_mem</td> | |
| <td align="left"> | |
| Return memory object from which <code class="varname">memobj</code> is created. | |
| <p> | |
| This returns the memory object specified | |
| as <code class="varname">buffer</code> argument to | |
| <a class="citerefentry" href="clCreateSubBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateSubBuffer</span></span></a> | |
| if <code class="varname">memobj</code> is a subbuffer object created using | |
| <a class="citerefentry" href="clCreateSubBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateSubBuffer</span></span></a>. | |
| </p> | |
| <p> | |
| This returns the <code class="varname">memobj</code> specified in | |
| <span class="type">cl_image_desc</span> if <code class="varname">memobj</code> is an image | |
| object. | |
| </p> | |
| <p> | |
| Otherwise a NULL value is returned. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_OFFSET</code> | |
| </td> | |
| <td align="left">size_t</td> | |
| <td align="left"> | |
| Return offset if <code class="varname">memobj</code> is a sub-buffer object created using | |
| <a class="citerefentry" href="clCreateSubBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateSubBuffer</span></span></a>. | |
| <p> | |
| This returns 0 if <code class="varname">memobj</code> is not a subbuffer object. | |
| </p> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_USES_SVM_POINTER</code> | |
| </td> | |
| <td align="left">cl_bool</td> | |
| <td align="left"> | |
| Return <code class="constant">CL_TRUE</code> if | |
| <code class="varname">memobj</code> is a buffer | |
| object that was created with | |
| <code class="constant">CL_MEM_USE_HOST_PTR</code> or is a | |
| subbuffer object of a buffer object that was | |
| created with <code class="constant">CL_MEM_USE_HOST_PTR</code> | |
| and the <code class="varname">host_ptr</code> specified when the | |
| buffer object was created is a SVM | |
| pointer; otherwise returns <code class="constant">CL_FALSE</code>. | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_D3D10_RESOURCE_KHR</code> | |
| </td> | |
| <td align="left">ID3D10Resource *</td> | |
| <td align="left"> | |
| If the | |
| <a class="citerefentry" href="cl_khr_d3d10_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_d3d10_sharing</span></span></a> | |
| extension is enabled, and if <code class="varname">memobj</code> was created using | |
| <a class="citerefentry" href="clCreateFromD3D10BufferKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10BufferKHR</span></span></a>, | |
| <a class="citerefentry" href="clCreateFromD3D10Texture2DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10Texture2DKHR</span></span></a>, | |
| or <a class="citerefentry" href="clCreateFromD3D10Texture3DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10Texture3DKHR</span></span></a>, | |
| returns the <code class="varname">resource</code> argument specified | |
| when <code class="varname">memobj</code> was created. | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_DX9_MEDIA_- | |
| ADAPTER_TYPE_KHR</code> | |
| </td> | |
| <td align="left">cl_dx9_media_- | |
| adapter_type_khr</td> | |
| <td align="left"> | |
| Returns the <code class="varname">cl_dx9_media_adapter_type_khr</code> argument | |
| value specified when <code class="varname">memobj</code> is created using | |
| <a class="citerefentry" href="clCreateFromDX9MediaSurfaceKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromDX9MediaSurfaceKHR</span></span></a> | |
| (If the <a class="citerefentry" href="cl_khr_dx9_media_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_dx9_media_sharing</span></span></a> | |
| extension is supported)</td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_DX9_MEDIA_- | |
| SURFACE_INFO_KHR</code> | |
| </td> | |
| <td align="left">cl_dx9_- | |
| surface_info_khr</td> | |
| <td align="left"> | |
| Returns the <code class="varname">cl_dx9_surface_info_khr</code> | |
| argument value specified when <code class="varname">memobj</code> is created using | |
| <a class="citerefentry" href="clCreateFromDX9MediaSurfaceKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromDX9MediaSurfaceKHR</span></span></a> | |
| (If the <a class="citerefentry" href="cl_khr_dx9_media_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_dx9_media_sharing</span></span></a> | |
| extension is supported) | |
| </td> | |
| </tr> | |
| <tr> | |
| <td align="left"> | |
| <code class="constant">CL_MEM_D3D11_RESOURCE_KHR</code> | |
| </td> | |
| <td align="left">ID3D11Resource *</td> | |
| <td align="left">If the <a class="citerefentry" href="cl_khr_d3d11_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_d3d11_sharing</span></span></a> | |
| extension is supported, | |
| if <code class="varname">memobj</code> was created using | |
| <a class="citerefentry" href="clCreateFromD3D11BufferKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11BufferKHR</span></span></a>, | |
| <a class="citerefentry" href="clCreateFromD3D11Texture2DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11Texture2DKHR</span></span></a>, or | |
| <a class="citerefentry" href="clCreateFromD3D11Texture3DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11Texture3DKHR</span></span></a>, | |
| returns the <code class="varname">resource</code> argument specified when <code class="varname">memobj</code> was created. | |
| </td> | |
| </tr> | |
| </tbody> | |
| </table> | |
| </div> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> param_value </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| A pointer to memory where the appropriate result being queried is returned. | |
| If <code class="varname">param_value</code> is NULL, it is ignored. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> param_value_size </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Used to specify the size in bytes of memory pointed to by <code class="varname">param_value</code>. | |
| This size must be ≥ size of return type as described in the table above. | |
| </p> | |
| </dd> | |
| <dt> | |
| <span class="term"> <code class="varname"> param_value_size_ret </code> </span> | |
| </dt> | |
| <dd> | |
| <p> | |
| Returns the actual size in bytes of data being queried by <code class="varname">param_value</code>. | |
| If <code class="varname">param_value_size_ret</code> is NULL, it is ignored. | |
| </p> | |
| </dd> | |
| </dl> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="errors"></a> | |
| <h2>Errors</h2> | |
| <p> | |
| Returns <span class="errorname">CL_SUCCESS</span> if the function is executed successfully. | |
| Otherwise, it returns one of the following errors: | |
| </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_VALUE</span> if <code class="varname">param_name</code> is not valid, or if size | |
| in bytes specified by <code class="varname">param_value_size</code> is < the size of return type as | |
| described in the table above and <code class="varname">param_value</code> is not NULL. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_MEM_OBJECT</span> if <code class="varname">memobj</code> | |
| is a not a valid memory 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> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_D3D10_RESOURCE_KHR</span> If the | |
| <a class="citerefentry" href="cl_khr_d3d10_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_d3d10_sharing</span></span></a> | |
| extension is enabled and if <code class="varname">param_name</code> | |
| is <code class="constant">CL_MEM_D3D10_RESOURCE_KHR</code> | |
| and <code class="varname">memobj</code> was not created by the function | |
| <a class="citerefentry" href="clCreateFromD3D10BufferKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10BufferKHR</span></span></a>, | |
| <a class="citerefentry" href="clCreateFromD3D10Texture2DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10Texture2DKHR</span></span></a>, | |
| or | |
| <a class="citerefentry" href="clCreateFromD3D10Texture3DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D10Texture3DKHR</span></span></a>. | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_DX9_MEDIA_SURFACE_KHR</span> | |
| if <code class="varname">param_name</code> is | |
| <code class="constant">CL_MEM_DX9_MEDIA_SURFACE_INFO_KHR</code> | |
| and <code class="varname">memobj</code> was not created by the function | |
| <a class="citerefentry" href="clCreateFromDX9MediaSurfaceKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromDX9MediaSurfaceKHR</span></span></a> | |
| from a Direct3D9 surface. (If the | |
| <a class="citerefentry" href="cl_khr_dx9_media_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_dx9_media_sharing</span></span></a> | |
| extension is supported) | |
| </li> | |
| <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_D3D11_RESOURCE_KHR</span> | |
| If the | |
| <a class="citerefentry" href="cl_khr_d3d11_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_d3d11_sharing</span></span></a> | |
| extension is supported, if | |
| <code class="varname">param_name</code> is <code class="constant">CL_MEM_D3D11_RESOURCE_KHR</code> | |
| and <code class="varname">memobj</code> was not created by the function | |
| <a class="citerefentry" href="clCreateFromD3D11BufferKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11BufferKHR</span></span></a>, | |
| <a class="citerefentry" href="clCreateFromD3D11Texture2DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11Texture2DKHR</span></span></a>, | |
| or | |
| <a class="citerefentry" href="clCreateFromD3D11Texture3DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11Texture3DKHR</span></span></a>." | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="specification"></a> | |
| <h2>Specification</h2> | |
| <p> | |
| <img src="pdficon_small1.gif" /> | |
| <a href="https://www.khronos.org/registry/cl/specs/opencl-2.1.pdf#page=170" target="OpenCL Spec">OpenCL Specification</a> | |
| </p> | |
| </div> | |
| <div class="refsect1"> | |
| <a id="seealso"></a> | |
| <h2>Also see</h2> | |
| <p> | |
| <a class="citerefentry" href="clGetImageInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetImageInfo</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-2015 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> |