<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta>
<meta http-equiv="X-UA-Compatible" content="IE=edge"></meta>
<meta name="copyright" content="(C) Copyright 2005"></meta>
<meta name="DC.rights.owner" content="(C) Copyright 2005"></meta>
<meta name="DC.Type" content="cppModule"></meta>
<meta name="DC.Title" content="Direct3D 11 Interoperability"></meta>
<meta name="abstract" content=""></meta>
<meta name="description" content=""></meta>
<meta name="DC.Format" content="XHTML"></meta>
<meta name="DC.Identifier" content="group__CUDA__D3D11"></meta>
<link rel="stylesheet" type="text/css" href="../common/formatting/commonltr.css"></link>
<link rel="stylesheet" type="text/css" href="../common/formatting/site.css"></link>
<title>CUDA Driver API :: CUDA Toolkit Documentation</title>
<!--[if lt IE 9]>
<script src="../common/formatting/html5shiv-printshiv.min.js"></script>
<![endif]-->
<script type="text/javascript" charset="utf-8" src="../common/formatting/jquery.min.js"></script>
<script type="text/javascript" charset="utf-8" src="../common/formatting/jquery.ba-hashchange.min.js"></script>
<link rel="canonical" href="http://docs.nvidia.com/cuda/cuda-driver-api/index.html"></link>
<link rel="stylesheet" type="text/css" href="../common/formatting/qwcode.highlight.css"></link>
</head>
<body>
<article id="contents">
<div id="breadcrumbs"><a href="group__CUDA__D3D10__DEPRECATED.html" shape="rect">< Previous</a> | <a href="group__CUDA__D3D11__DEPRECATED.html" shape="rect">Next ></a></div>
<div id="release-info">CUDA Driver API
(<a href="../../pdf/CUDA_Driver_API.pdf">PDF</a>)
-
CUDA Toolkit v5.5
(<a href="https://developer.nvidia.com/cuda-toolkit-archive">older</a>)
-
Last updated
July 19, 2013
-
<a href="mailto:cudatools@nvidia.com?subject=CUDA Tools Documentation Feedback: cuda-driver-api">Send Feedback</a></div>
<div class="topic reference apiRef apiPackage cppModule" id="group__CUDA__D3D11"><a name="group__CUDA__D3D11" shape="rect">
<!-- --></a><h2 class="topictitle2 cppModule">2.26. Direct3D 11 Interoperability</h2>
<div class="section">
<p>This section describes the Direct3D 11 interoperability functions of the low-level CUDA driver application programming interface.
Note that mapping of Direct3D 11 resources is performed with the graphics API agnostic, resource mapping interface described
in <a class="xref" href="group__CUDA__GRAPHICS.html#group__CUDA__GRAPHICS" shape="rect">Graphics Interoperability</a>.
</p>
</div>
<h3 class="fake_sectiontitle member_header">Modules</h3>
<dl class="members">
<dt><span class="member_type"> </span><span class="member_name">
<div><a class="link" href="group__CUDA__D3D11__DEPRECATED.html#group__CUDA__D3D11__DEPRECATED" shape="rect">Direct3D 11 Interoperability [DEPRECATED]</a></div></span></dt>
<dd class="shortdesc"><span></span><span class="desc"></span><a href="group__CUDA__D3D11__DEPRECATED.html#group__CUDA__D3D11__DEPRECATED" class="link" title="" shape="rect"></a></dd>
</dl>
<h3 class="fake_sectiontitle member_header">Enumerations</h3>
<dl class="members">
<dt><span class="member_type">enum </span><span class="member_name"><a href="#group__CUDA__D3D11_1gf590094e914ab0d2c6a5385711496500" shape="rect">CUd3d11DeviceList</a></span></dt>
<dd class="shortdesc"><span></span><span class="desc"></span></dd>
</dl>
<h3 class="fake_sectiontitle member_header">Functions</h3>
<dl class="members">
<dt><span class="member_type"><a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gc6c391505e117393cc2558fff6bfc2e9" title="" shape="rect">CUresult</a> </span><span class="member_name"><a href="#group__CUDA__D3D11_1ga1f1648cdf3bd5aef7a55af6dc1f42cd" shape="rect">cuD3D11GetDevice</a> ( <a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gcd81b70eb9968392bb5cdf582af8eab4" title="" shape="rect">CUdevice</a>*<span> </span><span class="keyword keyword apiItemName">pCudaDevice</span>, IDXGIAdapter*<span> </span><span class="keyword keyword apiItemName">pAdapter</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Gets the CUDA device corresponding to a display adapter. </span></dd>
<dt><span class="member_type"><a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gc6c391505e117393cc2558fff6bfc2e9" title="" shape="rect">CUresult</a> </span><span class="member_name"><a href="#group__CUDA__D3D11_1g7fca109b0dba2050b58f6bac627ff441" shape="rect">cuD3D11GetDevices</a> ( unsigned int*<span> </span><span class="keyword keyword apiItemName">pCudaDeviceCount</span>, <a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gcd81b70eb9968392bb5cdf582af8eab4" title="" shape="rect">CUdevice</a>*<span> </span><span class="keyword keyword apiItemName">pCudaDevices</span>, unsigned int <span> </span><span class="keyword keyword apiItemName">cudaDeviceCount</span>, ID3D11Device*<span> </span><span class="keyword keyword apiItemName">pD3D11Device</span>, <a href="group__CUDA__D3D11.html#group__CUDA__D3D11_1gf590094e914ab0d2c6a5385711496500" title="" shape="rect">CUd3d11DeviceList</a><span> </span><span class="keyword keyword apiItemName">deviceList</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Gets the CUDA devices corresponding to a Direct3D 11 device. </span></dd>
<dt><span class="member_type"><a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gc6c391505e117393cc2558fff6bfc2e9" title="" shape="rect">CUresult</a> </span><span class="member_name"><a href="#group__CUDA__D3D11_1g4c02792aa87c3acc255b9de15b0509da" shape="rect">cuGraphicsD3D11RegisterResource</a> ( <a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gc0c4e1704647178d9c5ba3be46517dcd" title="" shape="rect">CUgraphicsResource</a>*<span> </span><span class="keyword keyword apiItemName">pCudaResource</span>, ID3D11Resource*<span> </span><span class="keyword keyword apiItemName">pD3DResource</span>, unsigned int <span> </span><span class="keyword keyword apiItemName">Flags</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Register a Direct3D 11 resource for access by CUDA. </span></dd>
</dl>
<div class="description">
<h3 class="sectiontitle">Enumerations</h3>
<dl class="description">
<dt class="description"><a name="group__CUDA__D3D11_1gf590094e914ab0d2c6a5385711496500" id="group__CUDA__D3D11_1gf590094e914ab0d2c6a5385711496500" shape="rect">
<!-- --></a><span>enum CUd3d11DeviceList</span></dt>
<dd class="description">
<div class="section">
<p>CUDA devices corresponding to a D3D11 device </p>
</div>
<div class="enum-members">
<h6 class="enumerator_header">
Values
</h6>
<dl class="enumerator">
<dt><span class="enum-member-name-def">CU_D3D11_DEVICE_LIST_ALL = <span class="ph ph apiData">0x01</span></span></dt>
<dd>The CUDA devices for all GPUs used by a D3D11 device </dd>
<dt><span class="enum-member-name-def">CU_D3D11_DEVICE_LIST_CURRENT_FRAME = <span class="ph ph apiData">0x02</span></span></dt>
<dd>The CUDA devices for the GPUs used by a D3D11 device in its currently rendering frame </dd>
<dt><span class="enum-member-name-def">CU_D3D11_DEVICE_LIST_NEXT_FRAME = <span class="ph ph apiData">0x03</span></span></dt>
<dd>The CUDA devices for the GPUs to be used by a D3D11 device in the next frame </dd>
</dl>
</div>
</dd>
</dl>
</div>
<div class="description">
<h3 class="sectiontitle">Functions</h3>
<dl class="description">
<dt class="description"><a name="group__CUDA__D3D11_1ga1f1648cdf3bd5aef7a55af6dc1f42cd" id="group__CUDA__D3D11_1ga1f1648cdf3bd5aef7a55af6dc1f42cd" shape="rect">
<!-- --></a><span><a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gc6c391505e117393cc2558fff6bfc2e9" title="" shape="rect">CUresult</a> cuD3D11GetDevice ( <a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gcd81b70eb9968392bb5cdf582af8eab4" title="" shape="rect">CUdevice</a>*<span> </span><span class="keyword keyword apiItemName">pCudaDevice</span>, IDXGIAdapter*<span> </span><span class="keyword keyword apiItemName">pAdapter</span> ) </span></dt>
<dd class="description">
<div class="section">Gets the CUDA device corresponding to a display adapter. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">pCudaDevice</span></tt></dt>
<dd>- Returned CUDA device corresponding to <tt class="ph tt code">pAdapter</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">pAdapter</span></tt></dt>
<dd>- Adapter to query for CUDA device</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return"><a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9a0eed720f8a87cd1c5fd1c453bc7a03d" shape="rect">CUDA_SUCCESS</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9acf52f132faf29b473cdda6061f0f44a" shape="rect">CUDA_ERROR_DEINITIALIZED</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e98feb999f0af99b4a25ab26b3866f4df8" shape="rect">CUDA_ERROR_NOT_INITIALIZED</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9761bea84083d384d4fb88d51d972aada" shape="rect">CUDA_ERROR_NO_DEVICE</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e990696c86fcee1f536a1ec7d25867feeb" shape="rect">CUDA_ERROR_INVALID_VALUE</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9af1cadbeb21d3a78115ca211ba44c053" shape="rect">CUDA_ERROR_NOT_FOUND</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9c5a6ab0245179d297f1fa56ed0097183" shape="rect">CUDA_ERROR_UNKNOWN</a></p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns in <tt class="ph tt code">*pCudaDevice</tt> the CUDA-compatible device corresponding to the adapter <tt class="ph tt code">pAdapter</tt> obtained from IDXGIFactory::EnumAdapters.
</p>
<p class="p">If no device on <tt class="ph tt code">pAdapter</tt> is CUDA-compatible the call will return <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9761bea84083d384d4fb88d51d972aada" shape="rect">CUDA_ERROR_NO_DEVICE</a>.
</p>
<p class="p"></p>
<p class="p"></p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p">Note that this function may also return error codes from previous, asynchronous launches.</p>
</div>
</p>
<p class="p"></p>
<p class="p apiDesc_subtitle"><strong class="ph b">See also:</strong></p>
<p class="p see_subsection"><a class="xref" href="group__CUDA__D3D11.html#group__CUDA__D3D11_1g7fca109b0dba2050b58f6bac627ff441" title="Gets the CUDA devices corresponding to a Direct3D 11 device." shape="rect">cuD3D11GetDevices</a></p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUDA__D3D11_1g7fca109b0dba2050b58f6bac627ff441" id="group__CUDA__D3D11_1g7fca109b0dba2050b58f6bac627ff441" shape="rect">
<!-- --></a><span><a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gc6c391505e117393cc2558fff6bfc2e9" title="" shape="rect">CUresult</a> cuD3D11GetDevices ( unsigned int*<span> </span><span class="keyword keyword apiItemName">pCudaDeviceCount</span>, <a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gcd81b70eb9968392bb5cdf582af8eab4" title="" shape="rect">CUdevice</a>*<span> </span><span class="keyword keyword apiItemName">pCudaDevices</span>, unsigned int <span> </span><span class="keyword keyword apiItemName">cudaDeviceCount</span>, ID3D11Device*<span> </span><span class="keyword keyword apiItemName">pD3D11Device</span>, <a href="group__CUDA__D3D11.html#group__CUDA__D3D11_1gf590094e914ab0d2c6a5385711496500" title="" shape="rect">CUd3d11DeviceList</a><span> </span><span class="keyword keyword apiItemName">deviceList</span> ) </span></dt>
<dd class="description">
<div class="section">Gets the CUDA devices corresponding to a Direct3D 11 device. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">pCudaDeviceCount</span></tt></dt>
<dd>- Returned number of CUDA devices corresponding to <tt class="ph tt code">pD3D11Device</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">pCudaDevices</span></tt></dt>
<dd>- Returned CUDA devices corresponding to <tt class="ph tt code">pD3D11Device</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">cudaDeviceCount</span></tt></dt>
<dd>- The size of the output device array <tt class="ph tt code">pCudaDevices</tt></dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">pD3D11Device</span></tt></dt>
<dd>- Direct3D 11 device to query for CUDA devices </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">deviceList</span></tt></dt>
<dd>- The set of devices to return. This set may be <a class="xref" href="group__CUDA__D3D11.html#group__CUDA__D3D11_1ggf590094e914ab0d2c6a5385711496500f6d10bf4ca0a08ec3a8638799a42f06d" shape="rect">CU_D3D11_DEVICE_LIST_ALL</a> for all devices, <a class="xref" href="group__CUDA__D3D11.html#group__CUDA__D3D11_1ggf590094e914ab0d2c6a5385711496500cf10944d19f95ddebf5e2a56b3313bb2" shape="rect">CU_D3D11_DEVICE_LIST_CURRENT_FRAME</a> for the devices used to render the current frame (in SLI), or <a class="xref" href="group__CUDA__D3D11.html#group__CUDA__D3D11_1ggf590094e914ab0d2c6a53857114965006f90591f1e5804a28848a8ce6654d986" shape="rect">CU_D3D11_DEVICE_LIST_NEXT_FRAME</a> for the devices used to render the next frame (in SLI).
</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return"><a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9a0eed720f8a87cd1c5fd1c453bc7a03d" shape="rect">CUDA_SUCCESS</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9acf52f132faf29b473cdda6061f0f44a" shape="rect">CUDA_ERROR_DEINITIALIZED</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e98feb999f0af99b4a25ab26b3866f4df8" shape="rect">CUDA_ERROR_NOT_INITIALIZED</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9761bea84083d384d4fb88d51d972aada" shape="rect">CUDA_ERROR_NO_DEVICE</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e990696c86fcee1f536a1ec7d25867feeb" shape="rect">CUDA_ERROR_INVALID_VALUE</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9af1cadbeb21d3a78115ca211ba44c053" shape="rect">CUDA_ERROR_NOT_FOUND</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9c5a6ab0245179d297f1fa56ed0097183" shape="rect">CUDA_ERROR_UNKNOWN</a></p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Returns in <tt class="ph tt code">*pCudaDeviceCount</tt> the number of CUDA-compatible device corresponding to the Direct3D 11 device <tt class="ph tt code">pD3D11Device</tt>. Also returns in <tt class="ph tt code">*pCudaDevices</tt> at most <tt class="ph tt code">cudaDeviceCount</tt> of the CUDA-compatible devices corresponding to the Direct3D 11 device <tt class="ph tt code">pD3D11Device</tt>.
</p>
<p class="p">If any of the GPUs being used to render <tt class="ph tt code">pDevice</tt> are not CUDA capable then the call will return <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9761bea84083d384d4fb88d51d972aada" shape="rect">CUDA_ERROR_NO_DEVICE</a>.
</p>
<p class="p"></p>
<p class="p"></p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p">Note that this function may also return error codes from previous, asynchronous launches.</p>
</div>
</p>
<p class="p"></p>
<p class="p apiDesc_subtitle"><strong class="ph b">See also:</strong></p>
<p class="p see_subsection"><a class="xref" href="group__CUDA__D3D11.html#group__CUDA__D3D11_1ga1f1648cdf3bd5aef7a55af6dc1f42cd" title="Gets the CUDA device corresponding to a display adapter." shape="rect">cuD3D11GetDevice</a></p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUDA__D3D11_1g4c02792aa87c3acc255b9de15b0509da" id="group__CUDA__D3D11_1g4c02792aa87c3acc255b9de15b0509da" shape="rect">
<!-- --></a><span><a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gc6c391505e117393cc2558fff6bfc2e9" title="" shape="rect">CUresult</a> cuGraphicsD3D11RegisterResource ( <a href="group__CUDA__TYPES.html#group__CUDA__TYPES_1gc0c4e1704647178d9c5ba3be46517dcd" title="" shape="rect">CUgraphicsResource</a>*<span> </span><span class="keyword keyword apiItemName">pCudaResource</span>, ID3D11Resource*<span> </span><span class="keyword keyword apiItemName">pD3DResource</span>, unsigned int <span> </span><span class="keyword keyword apiItemName">Flags</span> ) </span></dt>
<dd class="description">
<div class="section">Register a Direct3D 11 resource for access by CUDA. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">pCudaResource</span></tt></dt>
<dd>- Returned graphics resource handle </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">pD3DResource</span></tt></dt>
<dd>- Direct3D resource to register </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">Flags</span></tt></dt>
<dd>- Parameters for resource registration</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return"><a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9a0eed720f8a87cd1c5fd1c453bc7a03d" shape="rect">CUDA_SUCCESS</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9acf52f132faf29b473cdda6061f0f44a" shape="rect">CUDA_ERROR_DEINITIALIZED</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e98feb999f0af99b4a25ab26b3866f4df8" shape="rect">CUDA_ERROR_NOT_INITIALIZED</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9a484e9af32c1e9893ff21f0e0191a12d" shape="rect">CUDA_ERROR_INVALID_CONTEXT</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e990696c86fcee1f536a1ec7d25867feeb" shape="rect">CUDA_ERROR_INVALID_VALUE</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e90fd2e63260c6317ba943af0f7e4b8d21" shape="rect">CUDA_ERROR_INVALID_HANDLE</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9264c50688ed110e8476b591befe60c02" shape="rect">CUDA_ERROR_OUT_OF_MEMORY</a>, <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9c5a6ab0245179d297f1fa56ed0097183" shape="rect">CUDA_ERROR_UNKNOWN</a></p>
</div>
<div class="section">
<h6 class="description_header">Description</h6>
<p>Registers the Direct3D 11 resource <tt class="ph tt code">pD3DResource</tt> for access by CUDA and returns a CUDA handle to <tt class="ph tt code">pD3Dresource</tt> in <tt class="ph tt code">pCudaResource</tt>. The handle returned in <tt class="ph tt code">pCudaResource</tt> may be used to map and unmap this resource until it is unregistered. On success this call will increase the internal reference
count on <tt class="ph tt code">pD3DResource</tt>. This reference count will be decremented when this resource is unregistered through <a class="xref" href="group__CUDA__GRAPHICS.html#group__CUDA__GRAPHICS_1ga7e5e97b74eaa13dfa6582e853e4c96d" title="Unregisters a graphics resource for access by CUDA." shape="rect">cuGraphicsUnregisterResource()</a>.
</p>
<p class="p">This call is potentially high-overhead and should not be called every frame in interactive applications.</p>
<p class="p">The type of <tt class="ph tt code">pD3DResource</tt> must be one of the following.
<ul class="ul">
<li class="li">
<p class="p">ID3D11Buffer: may be accessed through a device pointer.</p>
</li>
<li class="li">
<p class="p">ID3D11Texture1D: individual subresources of the texture may be accessed via arrays</p>
</li>
<li class="li">
<p class="p">ID3D11Texture2D: individual subresources of the texture may be accessed via arrays</p>
</li>
<li class="li">
<p class="p">ID3D11Texture3D: individual subresources of the texture may be accessed via arrays</p>
</li>
</ul>
</p>
<p class="p">The <tt class="ph tt code">Flags</tt> argument may be used to specify additional parameters at register time. The valid values for this parameter are
<ul class="ul">
<li class="li">
<p class="p">CU_GRAPHICS_REGISTER_FLAGS_NONE: Specifies no hints about how this resource will be used.</p>
</li>
<li class="li">
<p class="p">CU_GRAPHICS_REGISTER_FLAGS_SURFACE_LDST: Specifies that CUDA will bind this resource to a surface reference.</p>
</li>
<li class="li">
<p class="p">CU_GRAPHICS_REGISTER_FLAGS_TEXTURE_GATHER: Specifies that CUDA will perform texture gather operations on this resource.</p>
</li>
</ul>
</p>
<p class="p">Not all Direct3D resources of the above types may be used for interoperability with CUDA. The following are some limitations.
<ul class="ul">
<li class="li">
<p class="p">The primary rendertarget may not be registered with CUDA.</p>
</li>
<li class="li">
<p class="p">Resources allocated as shared may not be registered with CUDA.</p>
</li>
<li class="li">
<p class="p">Textures which are not of a format which is 1, 2, or 4 channels of 8, 16, or 32-bit integer or floating-point data cannot
be shared.
</p>
</li>
<li class="li">
<p class="p">Surfaces of depth or stencil formats cannot be shared.</p>
</li>
</ul>
</p>
<p class="p">If <tt class="ph tt code">pD3DResource</tt> is of incorrect type or is already registered then <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e90fd2e63260c6317ba943af0f7e4b8d21" shape="rect">CUDA_ERROR_INVALID_HANDLE</a> is returned. If <tt class="ph tt code">pD3DResource</tt> cannot be registered then <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e9c5a6ab0245179d297f1fa56ed0097183" shape="rect">CUDA_ERROR_UNKNOWN</a> is returned. If <tt class="ph tt code">Flags</tt> is not one of the above specified value then <a class="xref" href="group__CUDA__TYPES.html#group__CUDA__TYPES_1ggc6c391505e117393cc2558fff6bfc2e990696c86fcee1f536a1ec7d25867feeb" shape="rect">CUDA_ERROR_INVALID_VALUE</a> is returned.
</p>
<p class="p"></p>
<p class="p"></p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><p class="p">Note that this function may also return error codes from previous, asynchronous launches.</p>
</div>
</p>
<p class="p"></p>
<p class="p apiDesc_subtitle"><strong class="ph b">See also:</strong></p>
<p class="p see_subsection"><a class="xref" href="group__CUDA__GRAPHICS.html#group__CUDA__GRAPHICS_1ga7e5e97b74eaa13dfa6582e853e4c96d" title="Unregisters a graphics resource for access by CUDA." shape="rect">cuGraphicsUnregisterResource</a>, <a class="xref" href="group__CUDA__GRAPHICS.html#group__CUDA__GRAPHICS_1gffcfd8e78d82cc4f6dd987e8bce4edb0" title="Map graphics resources for access by CUDA." shape="rect">cuGraphicsMapResources</a>, <a class="xref" href="group__CUDA__GRAPHICS.html#group__CUDA__GRAPHICS_1g61c55e987e54558cce547240d6123078" title="Get an array through which to access a subresource of a mapped graphics resource." shape="rect">cuGraphicsSubResourceGetMappedArray</a>, <a class="xref" href="group__CUDA__GRAPHICS.html#group__CUDA__GRAPHICS_1g8a634cf4150d399f0018061580592457" title="Get a device pointer through which to access a mapped graphics resource." shape="rect">cuGraphicsResourceGetMappedPointer</a></p>
<p class="p"></p>
</div>
</dd>
</dl>
</div>
<div class="topic reference apiRef apiPackage cppModule" id="inner_elem__group__CUDA__D3D11__DEPRECATED"><a name="inner_elem__group__CUDA__D3D11__DEPRECATED" shape="rect">
<!-- --></a><h3 class="topictitle3 cppModule">Direct3D 11 Interoperability [DEPRECATED]</h3>
<div class="section">
<p></p>
</div>
</div>
</div>
<hr id="contents-end"></hr>
<div id="breadcrumbs"><a href="group__CUDA__D3D10__DEPRECATED.html" shape="rect">< Previous</a> | <a href="group__CUDA__D3D11__DEPRECATED.html" shape="rect">Next ></a></div>
<div id="release-info">CUDA Driver API
(<a href="../../pdf/CUDA_Driver_API.pdf">PDF</a>)
-
CUDA Toolkit v5.5
(<a href="https://developer.nvidia.com/cuda-toolkit-archive">older</a>)
-
Last updated
July 19, 2013
-
<a href="mailto:cudatools@nvidia.com?subject=CUDA Tools Documentation Feedback: cuda-driver-api">Send Feedback</a></div>
</article>
<header id="header"><span id="company">NVIDIA</span><span id="site-title">CUDA Toolkit Documentation</span><form id="search" method="get" action="search">
<input type="text" name="search-text"></input><fieldset id="search-location">
<legend>Search In:</legend>
<label><input type="radio" name="search-type" value="site"></input>Entire Site</label>
<label><input type="radio" name="search-type" value="document"></input>Just This Document</label></fieldset>
<button type="reset">clear search</button>
<button id="submit" type="submit">search</button></form>
</header>
<nav id="site-nav">
<div class="category closed"><span class="twiddle">▷</span><a href="../index.html" title="The root of the site.">CUDA Toolkit</a></div>
<ul class="closed">
<li><a href="../cuda-toolkit-release-notes/index.html" title="The Release Notes for the CUDA Toolkit from v4.0 to today.">Release Notes</a></li>
<li><a href="../eula/index.html" title="The End User License Agreements for the NVIDIA CUDA Toolkit, the NVIDIA CUDA Samples, the NVIDIA Display Driver, and NVIDIA NSight (Visual Studio Edition).">EULA</a></li>
<li><a href="../cuda-getting-started-guide-for-linux/index.html" title="This guide discusses how to install and check for correct operation of the CUDA Development Tools on GNU/Linux systems.">Getting Started Linux</a></li>
<li><a href="../cuda-getting-started-guide-for-mac-os-x/index.html" title="This guide discusses how to install and check for correct operation of the CUDA Development Tools on Mac OS X systems.">Getting Started Mac OS X</a></li>
<li><a href="../cuda-getting-started-guide-for-microsoft-windows/index.html" title="This guide discusses how to install and check for correct operation of the CUDA Development Tools on Microsoft Windows systems.">Getting Started Windows</a></li>
<li><a href="../cuda-c-programming-guide/index.html" title="This guide provides a detailed discussion of the CUDA programming model and programming interface. It then describes the hardware implementation, and provides guidance on how to achieve maximum performance. The Appendixes include a list of all CUDA-enabled devices, detailed description of all extensions to the C language, listings of supported mathematical functions, C++ features supported in host and device code, details on texture fetching, technical specifications of various devices, and concludes by introducing the low-level driver API.">Programming Guide</a></li>
<li><a href="../cuda-c-best-practices-guide/index.html" title="This guide presents established parallelization and optimization techniques and explains coding metaphors and idioms that can greatly simplify programming for CUDA-capable GPU architectures. The intent is to provide guidelines for obtaining the best performance from NVIDIA GPUs using the CUDA Toolkit.">Best Practices Guide</a></li>
<li><a href="../kepler-compatibility-guide/index.html" title="This application note is intended to help developers ensure that their NVIDIA CUDA applications will run effectively on GPUs based on the NVIDIA Kepler Architecture. This document provides guidance to ensure that your software applications are compatible with Kepler.">Kepler Compatibility Guide</a></li>
<li><a href="../kepler-tuning-guide/index.html" title="Kepler is NVIDIA's next-generation architecture for CUDA compute applications. Applications that follow the best practices for the Fermi architecture should typically see speedups on the Kepler architecture without any code changes. This guide summarizes the ways that an application can be fine-tuned to gain additional speedups by leveraging Kepler architectural features.">Kepler Tuning Guide</a></li>
<li><a href="../parallel-thread-execution/index.html" title="This guide provides detailed instructions on the use of PTX, a low-level parallel thread execution virtual machine and instruction set architecture (ISA). PTX exposes the GPU as a data-parallel computing device.">PTX ISA</a></li>
<li><a href="../optimus-developer-guide/index.html" title="This document explains how CUDA APIs can be used to query for GPU capabilities in NVIDIA Optimus systems.">Developer Guide for Optimus</a></li>
<li><a href="../video-decoder/index.html" title="This document provides the video decoder API specification and the format conversion and display using DirectX or OpenGL following decode.">Video Decoder</a></li>
<li><a href="../video-encoder/index.html" title="This document provides the CUDA video encoder specifications, including the C-library API functions and encoder query parameters.">Video Encoder</a></li>
<li><a href="../inline-ptx-assembly/index.html" title="This document shows how to inline PTX (parallel thread execution) assembly language statements into CUDA code. It describes available assembler statement parameters and constraints, and the document also provides a list of some pitfalls that you may encounter.">Inline PTX Assembly</a></li>
<li><a href="../cuda-runtime-api/index.html" title="The CUDA runtime API.">CUDA Runtime API</a></li>
<li><a href="../cuda-driver-api/index.html" title="The CUDA driver API.">CUDA Driver API</a></li>
<li><a href="../cuda-math-api/index.html" title="The CUDA math API.">CUDA Math API</a></li>
<li><a href="../cublas/index.html" title="The CUBLAS library is an implementation of BLAS (Basic Linear Algebra Subprograms) on top of the NVIDIA CUDA runtime. It allows the user to access the computational resources of NVIDIA Graphical Processing Unit (GPU), but does not auto-parallelize across multiple GPUs.">CUBLAS</a></li>
<li><a href="../cufft/index.html" title="The CUFFT library user guide.">CUFFT</a></li>
<li><a href="../curand/index.html" title="The CURAND library user guide.">CURAND</a></li>
<li><a href="../cusparse/index.html" title="The CUSPARSE library user guide.">CUSPARSE</a></li>
<li><a href="../npp/index.html" title="NVIDIA NPP is a library of functions for performing CUDA accelerated processing. The initial set of functionality in the library focuses on imaging and video processing and is widely applicable for developers in these areas. NPP will evolve over time to encompass more of the compute heavy tasks in a variety of problem domains. The NPP library is written to maximize flexibility, while maintaining high performance.">NPP</a></li>
<li><a href="../thrust/index.html" title="The Thrust getting started guide.">Thrust</a></li>
<li><a href="../cuda-samples/index.html" title="This document contains a complete listing of the code samples that are included with the NVIDIA CUDA Toolkit. It describes each code sample, lists the minimum GPU specification, and provides links to the source code and white papers if available.">CUDA Samples</a></li>
<li><a href="../cuda-compiler-driver-nvcc/index.html" title="This document is a reference guide on the use of the CUDA compiler driver nvcc. Instead of being a specific CUDA compilation driver, nvcc mimics the behavior of the GNU compiler gcc, accepting a range of conventional compiler options, such as for defining macros and include/library paths, and for steering the compilation process.">NVCC</a></li>
<li><a href="../cuda-gdb/index.html" title="The NVIDIA tool for debugging CUDA applications running on Linux and Mac, providing developers with a mechanism for debugging CUDA applications running on actual hardware. CUDA-GDB is an extension to the x86-64 port of GDB, the GNU Project debugger.">CUDA-GDB</a></li>
<li><a href="../cuda-memcheck/index.html" title="CUDA-MEMCHECK is a suite of run time tools capable of precisely detecting out of bounds and misaligned memory access errors, checking device allocation leaks, reporting hardware errors and identifying shared memory data access hazards.">CUDA-MEMCHECK</a></li>
<li><a href="../nsight-eclipse-edition-getting-started-guide/index.html" title="Nsight Eclipse Edition getting started guide">Nsight Eclipse Edition</a></li>
<li><a href="../profiler-users-guide/index.html" title="This is the guide to the Profiler.">Profiler</a></li>
<li><a href="../cuda-binary-utilities/index.html" title="The application notes for cuobjdump and nvdisasm.">CUDA Binary Utilities</a></li>
<li><a href="../floating-point/index.html" title="A number of issues related to floating point accuracy and compliance are a frequent source of confusion on both CPUs and GPUs. The purpose of this white paper is to discuss the most common issues related to NVIDIA GPUs and to supplement the documentation in the CUDA C Programming Guide.">Floating Point and IEEE 754</a></li>
<li><a href="../incomplete-lu-cholesky/index.html" title="In this white paper we show how to use the CUSPARSE and CUBLAS libraries to achieve a 2x speedup over CPU in the incomplete-LU and Cholesky preconditioned iterative methods. We focus on the Bi-Conjugate Gradient Stabilized and Conjugate Gradient iterative methods, that can be used to solve large sparse nonsymmetric and symmetric positive definite linear systems, respectively. Also, we comment on the parallel sparse triangular solve, which is an essential building block in these algorithms.">Incomplete-LU and Cholesky Preconditioned Iterative Methods</a></li>
<li><a href="../libnvvm-api/index.html" title="The libNVVM API.">libNVVM API</a></li>
<li><a href="../libdevice-users-guide/index.html" title="The libdevice library is an LLVM bitcode library that implements common functions for GPU kernels.">libdevice User's Guide</a></li>
<li><a href="../nvvm-ir-spec/index.html" title="NVVM IR is a compiler IR (internal representation) based on the LLVM IR. The NVVM IR is designed to represent GPU compute kernels (for example, CUDA kernels). High-level language front-ends, like the CUDA C compiler front-end, can generate NVVM IR.">NVVM IR</a></li>
<li><a href="../cupti/index.html" title="The CUPTI API.">CUPTI</a></li>
<li><a href="../debugger-api/index.html" title="The CUDA debugger API.">Debugger API</a></li>
<li><a href="../gpudirect-rdma/index.html" title="A tool for Kepler-class GPUs and CUDA 5.0 enabling a direct path for communication between the GPU and a peer device on the PCI Express bus when the devices share the same upstream root complex using standard features of PCI Express. This document introduces the technology and describes the steps necessary to enable a RDMA for GPUDirect connection to NVIDIA GPUs within the Linux device driver model.">RDMA for GPUDirect</a></li>
</ul>
<div class="category"><span class="twiddle">▼</span><a href="index.html" title="CUDA Driver API">CUDA Driver API</a></div>
<ul>
<li><a href="api-sync-behavior.html#api-sync-behavior">1. API synchronization behavior </a></li>
<li><a href="modules.html#modules">2. Modules</a><ul>
<li><a href="group__CUDA__TYPES.html#group__CUDA__TYPES">2.1. Data types used by CUDA driver</a></li>
<li><a href="group__CUDA__INITIALIZE.html#group__CUDA__INITIALIZE">2.2. Initialization</a></li>
<li><a href="group__CUDA__VERSION.html#group__CUDA__VERSION">2.3. Version Management</a></li>
<li><a href="group__CUDA__DEVICE.html#group__CUDA__DEVICE">2.4. Device Management</a></li>
<li><a href="group__CUDA__DEVICE__DEPRECATED.html#group__CUDA__DEVICE__DEPRECATED">2.5. Device Management [DEPRECATED]</a></li>
<li><a href="group__CUDA__CTX.html#group__CUDA__CTX">2.6. Context Management</a></li>
<li><a href="group__CUDA__CTX__DEPRECATED.html#group__CUDA__CTX__DEPRECATED">2.7. Context Management [DEPRECATED]</a></li>
<li><a href="group__CUDA__MODULE.html#group__CUDA__MODULE">2.8. Module Management</a></li>
<li><a href="group__CUDA__MEM.html#group__CUDA__MEM">2.9. Memory Management</a></li>
<li><a href="group__CUDA__UNIFIED.html#group__CUDA__UNIFIED">2.10. Unified Addressing</a></li>
<li><a href="group__CUDA__STREAM.html#group__CUDA__STREAM">2.11. Stream Management</a></li>
<li><a href="group__CUDA__EVENT.html#group__CUDA__EVENT">2.12. Event Management</a></li>
<li><a href="group__CUDA__EXEC.html#group__CUDA__EXEC">2.13. Execution Control</a></li>
<li><a href="group__CUDA__EXEC__DEPRECATED.html#group__CUDA__EXEC__DEPRECATED">2.14. Execution Control [DEPRECATED]</a></li>
<li><a href="group__CUDA__TEXREF.html#group__CUDA__TEXREF">2.15. Texture Reference Management</a></li>
<li><a href="group__CUDA__TEXREF__DEPRECATED.html#group__CUDA__TEXREF__DEPRECATED">2.16. Texture Reference Management [DEPRECATED]</a></li>
<li><a href="group__CUDA__SURFREF.html#group__CUDA__SURFREF">2.17. Surface Reference Management</a></li>
<li><a href="group__CUDA__TEXOBJECT.html#group__CUDA__TEXOBJECT">2.18. Texture Object Management</a></li>
<li><a href="group__CUDA__SURFOBJECT.html#group__CUDA__SURFOBJECT">2.19. Surface Object Management</a></li>
<li><a href="group__CUDA__PEER__ACCESS.html#group__CUDA__PEER__ACCESS">2.20. Peer Context Memory Access</a></li>
<li><a href="group__CUDA__GRAPHICS.html#group__CUDA__GRAPHICS">2.21. Graphics Interoperability</a></li>
<li><a href="group__CUDA__PROFILER.html#group__CUDA__PROFILER">2.22. Profiler Control</a></li>
<li><a href="group__CUDA__GL.html#group__CUDA__GL">2.23. OpenGL Interoperability</a><ul>
<li><a href="group__CUDA__GL__DEPRECATED.html#group__CUDA__GL__DEPRECATED">2.23.1. OpenGL Interoperability [DEPRECATED]</a></li>
</ul>
</li>
<li><a href="group__CUDA__D3D9.html#group__CUDA__D3D9">2.24. Direct3D 9 Interoperability</a><ul>
<li><a href="group__CUDA__D3D9__DEPRECATED.html#group__CUDA__D3D9__DEPRECATED">2.24.1. Direct3D 9 Interoperability [DEPRECATED]</a></li>
</ul>
</li>
<li><a href="group__CUDA__D3D10.html#group__CUDA__D3D10">2.25. Direct3D 10 Interoperability</a><ul>
<li><a href="group__CUDA__D3D10__DEPRECATED.html#group__CUDA__D3D10__DEPRECATED">2.25.1. Direct3D 10 Interoperability [DEPRECATED]</a></li>
</ul>
</li>
<li><a href="group__CUDA__D3D11.html#group__CUDA__D3D11">2.26. Direct3D 11 Interoperability</a><ul>
<li><a href="group__CUDA__D3D11__DEPRECATED.html#group__CUDA__D3D11__DEPRECATED">2.26.1. Direct3D 11 Interoperability [DEPRECATED]</a></li>
</ul>
</li>
<li><a href="group__CUDA__VDPAU.html#group__CUDA__VDPAU">2.27. VDPAU Interoperability</a></li>
</ul>
</li>
<li><a href="annotated.html#annotated">3. Data Structures</a><ul>
<li><a href="structCUDA__ARRAY3D__DESCRIPTOR.html#structCUDA__ARRAY3D__DESCRIPTOR">3.1. CUDA_ARRAY3D_DESCRIPTOR</a></li>
<li><a href="structCUDA__ARRAY__DESCRIPTOR.html#structCUDA__ARRAY__DESCRIPTOR">3.2. CUDA_ARRAY_DESCRIPTOR</a></li>
<li><a href="structCUDA__MEMCPY2D.html#structCUDA__MEMCPY2D">3.3. CUDA_MEMCPY2D</a></li>
<li><a href="structCUDA__MEMCPY3D.html#structCUDA__MEMCPY3D">3.4. CUDA_MEMCPY3D</a></li>
<li><a href="structCUDA__MEMCPY3D__PEER.html#structCUDA__MEMCPY3D__PEER">3.5. CUDA_MEMCPY3D_PEER</a></li>
<li><a href="structCUDA__POINTER__ATTRIBUTE__P2P__TOKENS.html#structCUDA__POINTER__ATTRIBUTE__P2P__TOKENS">3.6. CUDA_POINTER_ATTRIBUTE_P2P_TOKENS</a></li>
<li><a href="structCUDA__RESOURCE__DESC.html#structCUDA__RESOURCE__DESC">3.7. CUDA_RESOURCE_DESC</a></li>
<li><a href="structCUDA__RESOURCE__VIEW__DESC.html#structCUDA__RESOURCE__VIEW__DESC">3.8. CUDA_RESOURCE_VIEW_DESC</a></li>
<li><a href="structCUDA__TEXTURE__DESC.html#structCUDA__TEXTURE__DESC">3.9. CUDA_TEXTURE_DESC</a></li>
<li><a href="structCUdevprop.html#structCUdevprop">3.10. CUdevprop</a></li>
<li><a href="structCUipcEventHandle.html#structCUipcEventHandle">3.11. CUipcEventHandle</a></li>
<li><a href="structCUipcMemHandle.html#structCUipcMemHandle">3.12. CUipcMemHandle</a></li>
</ul>
</li>
<li><a href="functions.html#functions">4. Data Fields</a></li>
<li><a href="deprecated.html#deprecated">5. Deprecated List</a></li>
<li><a href="notices-header.html#notices-header">Notices</a><ul></ul>
</li>
</ul>
</nav>
<nav id="search-results">
<h2>Search Results</h2>
<ol></ol>
</nav>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/formatting/common.min.js"></script>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/scripts/omniture/s_code_us_dev_aut1-nolinktrackin.js"></script>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/scripts/omniture/omniture.js"></script>
<noscript><a href="http://www.omniture.com" title="Web Analytics"><img src="http://omniture.nvidia.com/b/ss/nvidiacudadocs/1/H.17--NS/0" height="1" width="1" border="0" alt=""></img></a></noscript>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/scripts/google-analytics/google-analytics-write.js"></script>
<script language="JavaScript" type="text/javascript" charset="utf-8" src="../common/scripts/google-analytics/google-analytics-tracker.js"></script>
</body>
</html>
