<!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="Surface Reference Management [DEPRECATED]"></meta>
<meta name="abstract" content=""></meta>
<meta name="description" content=""></meta>
<meta name="DC.Format" content="XHTML"></meta>
<meta name="DC.Identifier" content="group__CUDART__SURFACE"></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 Runtime 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="//assets.adobedtm.com/b92787824f2e0e9b68dc2e993f9bd995339fe417/satelliteLib-7ba51e58dc61bcb0e9311aadd02a0108ab24cc6c.js"></script>
<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>
<script type="text/javascript" charset="utf-8" src="../common/formatting/jquery.scrollintoview.min.js"></script>
<script type="text/javascript" src="../search/htmlFileList.js"></script>
<script type="text/javascript" src="../search/htmlFileInfoList.js"></script>
<script type="text/javascript" src="../search/nwSearchFnt.min.js"></script>
<script type="text/javascript" src="../search/stemmers/en_stemmer.min.js"></script>
<script type="text/javascript" src="../search/index-1.js"></script>
<script type="text/javascript" src="../search/index-2.js"></script>
<script type="text/javascript" src="../search/index-3.js"></script>
<link rel="canonical" href="http://docs.nvidia.com/cuda/cuda-runtime-api/index.html"></link>
<link rel="stylesheet" type="text/css" href="../common/formatting/qwcode.highlight.css"></link>
</head>
<body>
<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>
<div id="site-content">
<nav id="site-nav">
<div class="category closed"><a href="../index.html" title="The root of the site.">CUDA Toolkit
v10.1.168</a></div>
<div class="category"><a href="index.html" title="CUDA Runtime API">CUDA Runtime API</a></div>
<ul>
<li>
<div class="section-link"><a href="driver-vs-runtime-api.html#driver-vs-runtime-api">1. Difference between the driver and runtime APIs </a></div>
</li>
<li>
<div class="section-link"><a href="api-sync-behavior.html#api-sync-behavior">2. API synchronization behavior </a></div>
</li>
<li>
<div class="section-link"><a href="stream-sync-behavior.html#stream-sync-behavior">3. Stream synchronization behavior</a></div>
</li>
<li>
<div class="section-link"><a href="graphs-thread-safety.html#graphs-thread-safety">4. Graph object thread safety</a></div>
</li>
<li>
<div class="section-link"><a href="modules.html#modules">5. Modules</a></div>
<ul>
<li>
<div class="section-link"><a href="group__CUDART__DEVICE.html#group__CUDART__DEVICE">5.1. Device Management</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__THREAD__DEPRECATED.html#group__CUDART__THREAD__DEPRECATED">5.2. Thread Management [DEPRECATED]</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__ERROR.html#group__CUDART__ERROR">5.3. Error Handling</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__STREAM.html#group__CUDART__STREAM">5.4. Stream Management</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__EVENT.html#group__CUDART__EVENT">5.5. Event Management</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__EXTRES__INTEROP.html#group__CUDART__EXTRES__INTEROP">5.6. External Resource Interoperability</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__EXECUTION.html#group__CUDART__EXECUTION">5.7. Execution Control</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__OCCUPANCY.html#group__CUDART__OCCUPANCY">5.8. Occupancy</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__MEMORY.html#group__CUDART__MEMORY">5.9. Memory Management</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__MEMORY__DEPRECATED.html#group__CUDART__MEMORY__DEPRECATED">5.10. Memory Management [DEPRECATED]</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__UNIFIED.html#group__CUDART__UNIFIED">5.11. Unified Addressing</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__PEER.html#group__CUDART__PEER">5.12. Peer Device Memory Access</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__OPENGL.html#group__CUDART__OPENGL">5.13. OpenGL Interoperability</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__OPENGL__DEPRECATED.html#group__CUDART__OPENGL__DEPRECATED">5.14. OpenGL Interoperability [DEPRECATED]</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__D3D9.html#group__CUDART__D3D9">5.15. Direct3D 9 Interoperability</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__D3D9__DEPRECATED.html#group__CUDART__D3D9__DEPRECATED">5.16. Direct3D 9 Interoperability [DEPRECATED]</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__D3D10.html#group__CUDART__D3D10">5.17. Direct3D 10 Interoperability</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__D3D10__DEPRECATED.html#group__CUDART__D3D10__DEPRECATED">5.18. Direct3D 10 Interoperability [DEPRECATED]</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__D3D11.html#group__CUDART__D3D11">5.19. Direct3D 11 Interoperability</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__D3D11__DEPRECATED.html#group__CUDART__D3D11__DEPRECATED">5.20. Direct3D 11 Interoperability [DEPRECATED]</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__VDPAU.html#group__CUDART__VDPAU">5.21. VDPAU Interoperability</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__EGL.html#group__CUDART__EGL">5.22. EGL Interoperability</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__INTEROP.html#group__CUDART__INTEROP">5.23. Graphics Interoperability</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__TEXTURE.html#group__CUDART__TEXTURE">5.24. Texture Reference Management [DEPRECATED]</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__SURFACE.html#group__CUDART__SURFACE">5.25. Surface Reference Management [DEPRECATED]</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__TEXTURE__OBJECT.html#group__CUDART__TEXTURE__OBJECT">5.26. Texture Object Management</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__SURFACE__OBJECT.html#group__CUDART__SURFACE__OBJECT">5.27. Surface Object Management</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART____VERSION.html#group__CUDART____VERSION">5.28. Version Management</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__GRAPH.html#group__CUDART__GRAPH">5.29. Graph Management</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__HIGHLEVEL.html#group__CUDART__HIGHLEVEL">5.30. C++ API Routines</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__DRIVER.html#group__CUDART__DRIVER">5.31. Interactions with the CUDA Driver API</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__PROFILER.html#group__CUDART__PROFILER">5.32. Profiler Control</a></div>
</li>
<li>
<div class="section-link"><a href="group__CUDART__TYPES.html#group__CUDART__TYPES">5.33. Data types used by CUDA Runtime</a></div>
</li>
</ul>
</li>
<li>
<div class="section-link"><a href="annotated.html#annotated">6. Data Structures</a></div>
<ul>
<li>
<div class="section-link"><a href="class____cudaOccupancyB2DHelper.html#class____cudaOccupancyB2DHelper">6.1. __cudaOccupancyB2DHelper</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaChannelFormatDesc.html#structcudaChannelFormatDesc">6.2. cudaChannelFormatDesc</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaDeviceProp.html#structcudaDeviceProp">6.3. cudaDeviceProp</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaEglFrame.html#structcudaEglFrame">6.4. cudaEglFrame</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaEglPlaneDesc.html#structcudaEglPlaneDesc">6.5. cudaEglPlaneDesc</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaExtent.html#structcudaExtent">6.6. cudaExtent</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaExternalMemoryBufferDesc.html#structcudaExternalMemoryBufferDesc">6.7. cudaExternalMemoryBufferDesc</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaExternalMemoryHandleDesc.html#structcudaExternalMemoryHandleDesc">6.8. cudaExternalMemoryHandleDesc</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaExternalMemoryMipmappedArrayDesc.html#structcudaExternalMemoryMipmappedArrayDesc">6.9. cudaExternalMemoryMipmappedArrayDesc</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaExternalSemaphoreHandleDesc.html#structcudaExternalSemaphoreHandleDesc">6.10. cudaExternalSemaphoreHandleDesc</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaExternalSemaphoreSignalParams.html#structcudaExternalSemaphoreSignalParams">6.11. cudaExternalSemaphoreSignalParams</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaExternalSemaphoreWaitParams.html#structcudaExternalSemaphoreWaitParams">6.12. cudaExternalSemaphoreWaitParams</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaFuncAttributes.html#structcudaFuncAttributes">6.13. cudaFuncAttributes</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaHostNodeParams.html#structcudaHostNodeParams">6.14. cudaHostNodeParams</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaIpcEventHandle__t.html#structcudaIpcEventHandle__t">6.15. cudaIpcEventHandle_t</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaIpcMemHandle__t.html#structcudaIpcMemHandle__t">6.16. cudaIpcMemHandle_t</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaKernelNodeParams.html#structcudaKernelNodeParams">6.17. cudaKernelNodeParams</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaLaunchParams.html#structcudaLaunchParams">6.18. cudaLaunchParams</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaMemcpy3DParms.html#structcudaMemcpy3DParms">6.19. cudaMemcpy3DParms</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaMemcpy3DPeerParms.html#structcudaMemcpy3DPeerParms">6.20. cudaMemcpy3DPeerParms</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaMemsetParams.html#structcudaMemsetParams">6.21. cudaMemsetParams</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaPitchedPtr.html#structcudaPitchedPtr">6.22. cudaPitchedPtr</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaPointerAttributes.html#structcudaPointerAttributes">6.23. cudaPointerAttributes</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaPos.html#structcudaPos">6.24. cudaPos</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaResourceDesc.html#structcudaResourceDesc">6.25. cudaResourceDesc</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaResourceViewDesc.html#structcudaResourceViewDesc">6.26. cudaResourceViewDesc</a></div>
</li>
<li>
<div class="section-link"><a href="structcudaTextureDesc.html#structcudaTextureDesc">6.27. cudaTextureDesc</a></div>
</li>
<li>
<div class="section-link"><a href="structCUuuid__st.html#structCUuuid__st">6.28. CUuuid_st</a></div>
</li>
<li>
<div class="section-link"><a href="structsurfaceReference.html#structsurfaceReference">6.29. surfaceReference</a></div>
</li>
<li>
<div class="section-link"><a href="structtextureReference.html#structtextureReference">6.30. textureReference</a></div>
</li>
</ul>
</li>
<li>
<div class="section-link"><a href="functions.html#functions">7. Data Fields</a></div>
</li>
<li>
<div class="section-link"><a href="deprecated.html#deprecated">8. Deprecated List</a></div>
</li>
<li>
<div class="section-link"><a href="notices-header.html#notices-header">Notices</a></div>
<ul></ul>
</li>
</ul>
</nav>
<div id="resize-nav"></div>
<nav id="search-results">
<h2>Search Results</h2>
<ol></ol>
</nav>
<div id="contents-container">
<div id="breadcrumbs-container">
<div id="breadcrumbs"><a href="group__CUDART__TEXTURE.html" shape="rect">< Previous</a> | <a href="group__CUDART__TEXTURE__OBJECT.html" shape="rect">Next ></a></div>
<div id="release-info">CUDA Runtime API
(<a href="../../pdf/CUDA_Runtime_API.pdf">PDF</a>)
-
v10.1.168
(<a href="https://developer.nvidia.com/cuda-toolkit-archive">older</a>)
-
Last updated April 24, 2019
-
<a href="mailto:CUDAIssues@nvidia.com?subject=CUDA Toolkit Documentation Feedback: CUDA Runtime API">Send Feedback</a></div>
</div>
<article id="contents">
<div class="topic reference apiRef apiPackage cppModule" id="group__CUDART__SURFACE"><a name="group__CUDART__SURFACE" shape="rect">
<!-- --></a><h2 class="topictitle2 cppModule">5.25. Surface Reference Management [DEPRECATED]</h2>
<div class="section">
<p>This section describes the low level surface reference management functions of the CUDA runtime application programming interface.</p>
<p class="p">Some functions have overloaded C++ API template versions documented separately in the <a class="xref" href="group__CUDART__HIGHLEVEL.html#group__CUDART__HIGHLEVEL" title="C++-style interface built on top of CUDA runtime API." shape="rect">C++ API Routines</a> module.
</p>
</div>
<h3 class="fake_sectiontitle member_header">Functions</h3>
<dl class="members">
<dt><span class="member_type"><span class="keyword keyword apiItemName">__host__</span>
<a href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gf599e5b8b829ce7db0f5216928f6ecb6" title="" shape="rect">cudaError_t</a> </span><span class="member_name"><a href="#group__CUDART__SURFACE_1g5e0bef28d00183561fdce85ad3cfbe59" shape="rect">cudaBindSurfaceToArray</a> ( const <a href="structsurfaceReference.html#structsurfaceReference" title="" shape="rect">surfaceReference</a>*<span> </span><span class="keyword keyword apiItemName">surfref</span>, <a href="group__CUDART__TYPES.html#group__CUDART__TYPES_1g1259f0b7bcff80ba46267c9117f9bb21" title="" shape="rect">cudaArray_const_t</a><span> </span><span class="keyword keyword apiItemName">array</span>, const <a href="structcudaChannelFormatDesc.html#structcudaChannelFormatDesc" title="" shape="rect">cudaChannelFormatDesc</a>*<span> </span><span class="keyword keyword apiItemName">desc</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Binds an array to a surface. </span></dd>
<dt><span class="member_type"><span class="keyword keyword apiItemName">__host__</span>
<a href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gf599e5b8b829ce7db0f5216928f6ecb6" title="" shape="rect">cudaError_t</a> </span><span class="member_name"><a href="#group__CUDART__SURFACE_1gda383a25ec6c2a6414ae202ff6377054" shape="rect">cudaGetSurfaceReference</a> ( const <a href="structsurfaceReference.html#structsurfaceReference" title="" shape="rect">surfaceReference</a>**<span> </span><span class="keyword keyword apiItemName">surfref</span>, const void*<span> </span><span class="keyword keyword apiItemName">symbol</span> ) </span></dt>
<dd class="shortdesc"><span></span><span class="desc">Get the surface reference associated with a symbol. </span></dd>
</dl>
<div class="description">
<h3 class="sectiontitle">Functions</h3>
<dl class="description">
<dt class="description"><a name="group__CUDART__SURFACE_1g5e0bef28d00183561fdce85ad3cfbe59" id="group__CUDART__SURFACE_1g5e0bef28d00183561fdce85ad3cfbe59" shape="rect">
<!-- --></a><span><span class="keyword keyword apiItemName">__host__</span>
<a href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gf599e5b8b829ce7db0f5216928f6ecb6" title="" shape="rect">cudaError_t</a> cudaBindSurfaceToArray ( const <a href="structsurfaceReference.html#structsurfaceReference" title="" shape="rect">surfaceReference</a>*<span> </span><span class="keyword keyword apiItemName">surfref</span>, <a href="group__CUDART__TYPES.html#group__CUDART__TYPES_1g1259f0b7bcff80ba46267c9117f9bb21" title="" shape="rect">cudaArray_const_t</a><span> </span><span class="keyword keyword apiItemName">array</span>, const <a href="structcudaChannelFormatDesc.html#structcudaChannelFormatDesc" title="" shape="rect">cudaChannelFormatDesc</a>*<span> </span><span class="keyword keyword apiItemName">desc</span> ) </span></dt>
<dd class="description">
<div class="section">Binds an array to a surface. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">surfref</span></tt></dt>
<dd>- Surface to bind </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">array</span></tt></dt>
<dd>- Memory array on device </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">desc</span></tt></dt>
<dd>- Channel format</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return"><a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e0038e355f04607d824883b4a50662830d591" shape="rect">cudaSuccess</a>, <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e00383e8aef5398ee38e28ed41e357b48917c" shape="rect">cudaErrorInvalidValue</a>, <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e0038aa711d1e9175231dc80eecb7b51936a3" shape="rect">cudaErrorInvalidSurface</a></p>
</div>
<div class="section">
<h6 class="deprecated_header"><a class="xref xrefsect-title" href="deprecated.html#deprecated__deprecated_1_deprecated000021" shape="rect">Deprecated</a></h6>
<p></p>
<h6 class="description_header">Description</h6>Binds the CUDA array <tt class="ph tt code">array</tt> to the surface reference <tt class="ph tt code">surfref</tt>. <tt class="ph tt code">desc</tt> describes how the memory is interpreted when fetching values from the surface. Any CUDA array previously bound to <tt class="ph tt code">surfref</tt> is unbound.
<p class="p"></p>
<p class="p"></p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><ul class="ul">
<li class="li">
<p class="p">Note that this function may also return error codes from previous, asynchronous launches. </p>
</li>
<li class="li">
<p class="p">Note that this function may also return <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e0038ce7993a88ecf2c57b8102d55d997a18c" shape="rect">cudaErrorInitializationError</a>, <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e0038f5e52d1774934b77ba55d2aa2c063067" shape="rect">cudaErrorInsufficientDriver</a> or <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e0038e942e4cbbd2bef6e92e293253f055613" shape="rect">cudaErrorNoDevice</a> if this call tries to initialize internal CUDA RT state.
</p>
</li>
<li class="li">
<p class="p">Note that as specified by <a class="xref" href="group__CUDART__STREAM.html#group__CUDART__STREAM_1g74aa9f4b1c2f12d994bf13876a5a2498" title="Add a callback to a compute stream." shape="rect">cudaStreamAddCallback</a> no CUDA function may be called from callback. <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e003867b6095ab719b21659a400b553963eb3" shape="rect">cudaErrorNotPermitted</a> may, but is not guaranteed to, be returned as a diagnostic in such case.
</p>
</li>
</ul>
</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__CUDART__HIGHLEVEL.html#group__CUDART__HIGHLEVEL_1g820a2c2ad2e6dbb5c05a624b735a5978" title="[C++ API] Binds an array to a surface" shape="rect">cudaBindSurfaceToArray ( C++ API)</a>, <a class="xref" href="group__CUDART__HIGHLEVEL.html#group__CUDART__HIGHLEVEL_1g80364c2c13250a3354953df4aa0b43d3" title="[C++ API] Binds an array to a surface" shape="rect">cudaBindSurfaceToArray ( C++ API, inherited channel descriptor)</a>, <a class="xref" href="group__CUDART__SURFACE.html#group__CUDART__SURFACE_1gda383a25ec6c2a6414ae202ff6377054" title="Get the surface reference associated with a symbol." shape="rect">cudaGetSurfaceReference</a>, <a class="xref" href="../cuda-driver-api/group__CUDA__SURFREF__DEPRECATED.html#group__CUDA__SURFREF__DEPRECATED_1g19e4cf8fc0cdcd914e01ecf12fdc5faf" target="_blank" shape="rect">cuSurfRefSetArray</a></p>
<p class="p"></p>
</div>
</dd>
<dt class="description"><a name="group__CUDART__SURFACE_1gda383a25ec6c2a6414ae202ff6377054" id="group__CUDART__SURFACE_1gda383a25ec6c2a6414ae202ff6377054" shape="rect">
<!-- --></a><span><span class="keyword keyword apiItemName">__host__</span>
<a href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gf599e5b8b829ce7db0f5216928f6ecb6" title="" shape="rect">cudaError_t</a> cudaGetSurfaceReference ( const <a href="structsurfaceReference.html#structsurfaceReference" title="" shape="rect">surfaceReference</a>**<span> </span><span class="keyword keyword apiItemName">surfref</span>, const void*<span> </span><span class="keyword keyword apiItemName">symbol</span> ) </span></dt>
<dd class="description">
<div class="section">Get the surface reference associated with a symbol. </div>
<div class="section">
<h6 class="parameter_header">
Parameters
</h6>
<dl class="table-display-params">
<dt><tt class="code"><span class="keyword keyword apiItemName">surfref</span></tt></dt>
<dd>- Surface reference associated with symbol </dd>
<dt><tt class="code"><span class="keyword keyword apiItemName">symbol</span></tt></dt>
<dd>- Surface to get reference for</dd>
</dl>
</div>
<div class="section">
<h6 class="return_header">Returns</h6>
<p class="return"><a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e0038e355f04607d824883b4a50662830d591" shape="rect">cudaSuccess</a>, <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e0038aa711d1e9175231dc80eecb7b51936a3" shape="rect">cudaErrorInvalidSurface</a></p>
</div>
<div class="section">
<h6 class="deprecated_header"><a class="xref xrefsect-title" href="deprecated.html#deprecated__deprecated_1_deprecated000022" shape="rect">Deprecated</a></h6>
<p></p>
<h6 class="description_header">Description</h6>Returns in <tt class="ph tt code">*surfref</tt> the structure associated to the surface reference defined by symbol <tt class="ph tt code">symbol</tt>.
<p class="p"></p>
<p class="p"></p>
<p class="p">
<div class="note note"><span class="notetitle">Note:</span><ul class="ul">
<li class="li">
<p class="p">Note that this function may also return error codes from previous, asynchronous launches. </p>
</li>
<li class="li">
<p class="p">Use of a string naming a variable as the <tt class="ph tt code">symbol</tt> parameter was removed in CUDA 5.0.
</p>
</li>
<li class="li">
<p class="p">Note that this function may also return <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e0038ce7993a88ecf2c57b8102d55d997a18c" shape="rect">cudaErrorInitializationError</a>, <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e0038f5e52d1774934b77ba55d2aa2c063067" shape="rect">cudaErrorInsufficientDriver</a> or <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e0038e942e4cbbd2bef6e92e293253f055613" shape="rect">cudaErrorNoDevice</a> if this call tries to initialize internal CUDA RT state.
</p>
</li>
<li class="li">
<p class="p">Note that as specified by <a class="xref" href="group__CUDART__STREAM.html#group__CUDART__STREAM_1g74aa9f4b1c2f12d994bf13876a5a2498" title="Add a callback to a compute stream." shape="rect">cudaStreamAddCallback</a> no CUDA function may be called from callback. <a class="xref" href="group__CUDART__TYPES.html#group__CUDART__TYPES_1gg3f51e3575c2178246db0a94a430e003867b6095ab719b21659a400b553963eb3" shape="rect">cudaErrorNotPermitted</a> may, but is not guaranteed to, be returned as a diagnostic in such case.
</p>
</li>
</ul>
</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__CUDART__SURFACE.html#group__CUDART__SURFACE_1g5e0bef28d00183561fdce85ad3cfbe59" title="Binds an array to a surface." shape="rect">cudaBindSurfaceToArray ( C API)</a>, <a class="xref" href="../cuda-driver-api/group__CUDA__MODULE.html#group__CUDA__MODULE_1g71c19dab9374e8481d8d8629a77377b1" target="_blank" shape="rect">cuModuleGetSurfRef</a></p>
<p class="p"></p>
</div>
</dd>
</dl>
</div>
</div>
<hr id="contents-end"></hr>
</article>
</div>
</div>
<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/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>
<script type="text/javascript">var switchTo5x=true;</script><script type="text/javascript" src="http://w.sharethis.com/button/buttons.js"></script><script type="text/javascript">stLight.options({publisher: "998dc202-a267-4d8e-bce9-14debadb8d92", doNotHash: false, doNotCopy: false, hashAddressBar: false});</script><script type="text/javascript">_satellite.pageBottom();</script></body>
</html>
distrib
>
Mageia
>
7
>
x86_64
>
media
>
nonfree-updates
>
by-pkgid
>
b86a85131cc739c1c53d0b55840a4328
>
files
>
1517
