| <?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>clCreateFromD3D11BufferKHR</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /> |
| <meta name="keywords" content="clCreateFromD3D11BufferKHR" /> |
| </head> |
| <body> |
| <div class="refentry"> |
| <a id="idm5750560"></a> |
| <div class="titlepage"></div> |
| <div xmlns="" class="refnamediv"> |
| <a xmlns="http://www.w3.org/1999/xhtml" id="clCreateFromD3D11BufferKHR"></a> |
| <h1>clCreateFromD3D11BufferKHR</h1> |
| <p>Creates an OpenCL buffer object from a Direct3D 11 buffer.</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">clCreateFromD3D11BufferKHR</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>ID3D11Buffer <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*resource</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> |
| <dt> |
| <span class="term"> |
| <code class="varname">context</code> |
| </span> |
| </dt> |
| <dd> |
| <p> |
| A valid OpenCL context created from a Direct3D 11 device. |
| </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. |
| May be <code class="constant">CL_MEM_READ_ONLY</code>, <code class="constant">CL_MEM_WRITE_ONLY</code>, or |
| <code class="constant">CL_MEM_READ_WRITE</code>. (See the table for |
| <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a> |
| for more information.) |
| </p> |
| </dd> |
| <dt> |
| <span class="term"> |
| <code class="varname">resource</code> |
| </span> |
| </dt> |
| <dd> |
| <p> |
| A pointer to the Direct3D 11 buffer to share. |
| </p> |
| </dd> |
| <dt> |
| <span class="term"> |
| <code class="varname">errcode_ret</code> |
| </span> |
| </dt> |
| <dd> |
| <p> |
| An appropriate error code. If <code class="varname">errcode_ret</code> is NULL, no error code is returned. |
| </p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a id="notes"></a> |
| <h2>Notes</h2> |
| <p> |
| The size of the returned OpenCL buffer object is the same as the size |
| of <code class="varname">resource</code>. This call will increment the internal Direct3D |
| reference count on <code class="varname">resource</code>. The internal Direct3D reference count |
| on resource will be decremented when the OpenCL reference count on the returned OpenCL |
| memory object drops to zero. |
| </p> |
| <p> |
| General information about sharing memory objects with Direct3D 11 follows. |
| </p> |
| <p> |
| The goal of this extension is to provide |
| interoperability between OpenCL and Direct3D 11. This is designed to function analogously |
| to the OpenGL interoperability. If this extension is |
| supported by an implementation, the string |
| <a class="citerefentry" href="cl_khr_d3d11_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_d3d11_sharing</span></span></a> |
| will be present in the |
| <code class="constant">CL_PLATFORM_EXTENSIONS</code> or <code class="constant">CL_DEVICE_EXTENSIONS</code> |
| string described in the table of allowed |
| values for <code class="varname">param_name</code> for |
| <a class="citerefentry" href="clGetDeviceInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceInfo</span></span></a>. |
| |
| </p> |
| <p> |
| As currently proposed the interfaces for this extension would be provided in |
| <code class="code">cl_d3d11.h</code>. |
| </p> |
| <p> |
| This section discusses OpenCL functions that allow |
| applications to use Direct3D 11 resources as OpenCL memory objects. This allows efficient |
| sharing of data between OpenCL and Direct3D 11. The OpenCL API may be used to execute |
| kernels that read and/or write memory objects that are also Direct3D 11 resources. An |
| OpenCL image object may be created from a Direct3D 11 texture resource. An OpenCL buffer |
| object may be created from a Direct3D 11 buffer resource. OpenCL memory objects may be |
| created from Direct3D 11 objects if and only if the OpenCL context has been created from |
| a Direct3D 11 device. |
| </p> |
| <p> |
| An OpenCL memory object created from a |
| Direct3D 11 resource remains valid as long as the corresponding Direct3D 11 resource has |
| not been deleted. If the Direct3D 11 resource is deleted through the Direct3D 11 API, |
| subsequent use of the OpenCL memory object will result in undefined behavior, including |
| but not limited to possible OpenCL errors, data corruption, and program termination. |
| </p> |
| <p> |
| The successful creation of a |
| cl_context against a Direct3D 11 device specified via the context create parameter |
| <code class="constant">CL_CONTEXT_D3D11_DEVICE_KHR</code> will increment the internal Direct3D |
| reference count on the specified Direct3D 11 device. The internal Direct3D reference |
| count on that Direct3D 11 device will be decremented when the OpenCL reference count on |
| the returned OpenCL context drops to zero. |
| </p> |
| <p> |
| The OpenCL context and corresponding command-queues are dependent on the |
| existence of the Direct3D 11 device from which the OpenCL context was created. If the |
| Direct3D 11 device is deleted through the Direct3D 11 API, subsequent use of the OpenCL |
| context will result in undefined behavior, including but not limited to possible OpenCL |
| errors, data corruption, and program termination. |
| </p> |
| <p> |
| Properties of Direct3D 11 objects may be queried |
| using <a class="citerefentry" href="clGetMemObjectInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetMemObjectInfo</span></span></a> |
| and <a class="citerefentry" href="clGetImageInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetImageInfo</span></span></a> |
| with <code class="varname">param_name</code> <code class="constant">CL_MEM_D3D11_RESOURCE_KHR</code> and |
| <code class="constant">CL_IMAGE_D3D11_SUBRESOURCE_KHR</code> as described for <a class="citerefentry" href="clGetImageInfo.html"><span class="citerefentry"><span class="refentrytitle">clGetImageInfo</span></span></a> and in the information |
| below about accessing mapped regions of a memory object. |
| </p> |
| <h4><a id="idp5645312"></a>Accessing mapped regions of a memory object</h4> |
| <p> |
| This section describes the behavior of OpenCL commands that access |
| mapped regions of a memory object. |
| </p> |
| <p> |
| The contents of the region of a memory object and associated memory objects |
| (sub-buffer objects or 1D image buffer objects that overlap this region) mapped |
| for writing (i.e. <code class="constant">CL_MAP_WRITE</code> or |
| <code class="constant">CL_MAP_WRITE_INVALIDATE_REGION</code> is set in <code class="varname">map_flags</code> |
| argument to <a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a> |
| or <a class="citerefentry" href="clEnqueueMapImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapImage</span></span></a>) are |
| considered to be undefined until this region is unmapped. |
| </p> |
| <p> |
| Multiple commands in command-queues can map a region or overlapping regions of a memory |
| object and associated memory objects (sub-buffer objects or 1D image buffer objects that |
| overlap this region) for reading (i.e. <code class="varname">map_flags</code> = <code class="constant">CL_MAP_READ</code>). |
| The contents of the regions of a memory object mapped for reading can also be read by kernels |
| and other OpenCL commands (such as |
| <a class="citerefentry" href="clEnqueueCopyBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueCopyBuffer</span></span></a>) executing on a device(s). |
| </p> |
| <p> |
| Mapping (and unmapping) overlapped regions in a memory object and/or associated memory |
| objects (sub-buffer objects or 1D image buffer objects that overlap this region) for writing |
| is an error and will result in <code class="constant">CL_INVALID_OPERATION</code> error returned by |
| <a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a> |
| or <a class="citerefentry" href="clEnqueueMapImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapImage</span></span></a>. |
| </p> |
| <p> |
| If a memory object is currently mapped for writing, the application must ensure that the memory |
| object is unmapped before any enqueued kernels or commands that read from or write to this |
| memory object or any of its associated memory objects (sub-buffer or 1D image buffer objects) |
| or its parent object (if the memory object is a sub-buffer or 1D image buffer object) begin |
| execution; otherwise the behavior is undefined. |
| </p> |
| <p> |
| If a memory object is currently mapped for reading, the application must ensure that the memory |
| object is unmapped before any enqueued kernels or commands that write to this memory object |
| or any of its associated memory objects (sub-buffer or 1D image buffer objects) or its parent |
| object (if the memory object is a sub-buffer or 1D image buffer object) begin execution; |
| otherwise the behavior is undefined. |
| </p> |
| <p> |
| Accessing the contents of the memory region referred to by the mapped pointer that has |
| been unmapped is undefined. |
| </p> |
| <p> |
| The mapped pointer returned by |
| <a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a> |
| or <a class="citerefentry" href="clEnqueueMapImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapImage</span></span></a> can be used as |
| <code class="varname">ptr</code> argument value to |
| <a class="citerefentry" href="clEnqueueReadBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReadBuffer</span></span></a>, |
| <a class="citerefentry" href="clEnqueueWriteBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueWriteBuffer</span></span></a>, |
| <a class="citerefentry" href="clEnqueueReadBufferRect.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReadBufferRect</span></span></a>, |
| <a class="citerefentry" href="clEnqueueWriteBufferRect.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueWriteBufferRect</span></span></a>, |
| <a class="citerefentry" href="clEnqueueReadImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReadImage</span></span></a>, and |
| <a class="citerefentry" href="clEnqueueWriteImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueWriteImage</span></span></a>, |
| provided the rules described above are adhered to. |
| </p> |
| </div> |
| <div class="refsect1"> |
| <a id="errors"></a> |
| <h2>Errors</h2> |
| <p> |
| Returns <span class="errorname">CL_SUCCESS</span> returns a valid non-zero OpenCL buffer |
| object and <code class="varname">errcode_ret</code> is set to <span class="errorname">CL_SUCCESS</span> |
| if the buffer 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" 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. |
| </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_D3D11_RESOURCE_KHR</span> if <code class="varname">resource</code> |
| is not a Direct3D 11 buffer resource, if <code class="varname">resource</code> was created with |
| the <code class="constant">D3D11_USAGE</code> flag <code class="constant">D3D11_USAGE_IMMUTABLE</code>, |
| if a <span class="type">cl_mem</span> from <code class="varname">resource</code> has already |
| been created using <code class="function">clCreateFromD3D11BufferKHR</code>, or if |
| <code class="varname">context</code> was not created against the same Direct3D 11 device |
| from which <code class="varname">resource</code> was created. |
| </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=104" 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_d3d11_sharing.html"><span class="citerefentry"><span class="refentrytitle">cl_khr_d3d11_sharing</span></span></a>, |
| <a class="citerefentry" href="clGetDeviceIDsFromD3D11KHR.html"><span class="citerefentry"><span class="refentrytitle">clGetDeviceIDsFromD3D11KHR</span></span></a>, |
| <a class="citerefentry" href="clCreateFromD3D11Texture2DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11Texture2DKHR</span></span></a>, |
| <a class="citerefentry" href="clCreateFromD3D11Texture3DKHR.html"><span class="citerefentry"><span class="refentrytitle">clCreateFromD3D11Texture3DKHR</span></span></a>, |
| <a class="citerefentry" href="clEnqueueAcquireD3D11ObjectsKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueAcquireD3D11ObjectsKHR</span></span></a>, |
| <a class="citerefentry" href="clEnqueueReleaseD3D11ObjectsKHR.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueReleaseD3D11ObjectsKHR</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> |
