Files
rocm-systems/docs/RuntimeAPI/html/group__Texture.html
T
Maneesh Gupta f052f43b3b Updated doxygen documentation
Change-Id: If04d1155173fba8d3e050f3259da8b3edc60e076
2016-12-19 04:04:06 +00:00

215 líneas
16 KiB
HTML

<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>HIP: Heterogenous-computing Interface for Portability: Texture Reference Management</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">HIP: Heterogenous-computing Interface for Portability
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Texture Reference Management<div class="ingroups"><a class="el" href="group__API.html">HIP API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac9b0ae733fa849842342fab6d42c7b6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Texture.html#gac9b0ae733fa849842342fab6d42c7b6f">hipCreateChannelDesc</a> (int x, int y, int z, int w, hipChannelFormatKind f)</td></tr>
<tr class="memdesc:gac9b0ae733fa849842342fab6d42c7b6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a channel descriptor using the specified format. <a href="#gac9b0ae733fa849842342fab6d42c7b6f">More...</a><br/></td></tr>
<tr class="separator:gac9b0ae733fa849842342fab6d42c7b6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf4dda8ee592d5e040915a2916d82c324"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaf4dda8ee592d5e040915a2916d82c324"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:gaf4dda8ee592d5e040915a2916d82c324"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>hipCreateChannelDesc</b> ()</td></tr>
<tr class="separator:gaf4dda8ee592d5e040915a2916d82c324"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e25b0f52c06c9e7b3bc48a8dbf1cbcb"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga9e25b0f52c06c9e7b3bc48a8dbf1cbcb"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:ga9e25b0f52c06c9e7b3bc48a8dbf1cbcb"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>hipCreateChannelDesc&lt; int &gt;</b> ()</td></tr>
<tr class="separator:ga9e25b0f52c06c9e7b3bc48a8dbf1cbcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac34e72999c77877acff76890330cf9d1"><td class="memTemplParams" colspan="2"><a class="anchor" id="gac34e72999c77877acff76890330cf9d1"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:gac34e72999c77877acff76890330cf9d1"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>hipCreateChannelDesc&lt; unsigned int &gt;</b> ()</td></tr>
<tr class="separator:gac34e72999c77877acff76890330cf9d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab96a636035161cf4c2c8b0a03a4ccc19"><td class="memTemplParams" colspan="2"><a class="anchor" id="gab96a636035161cf4c2c8b0a03a4ccc19"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:gab96a636035161cf4c2c8b0a03a4ccc19"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>hipCreateChannelDesc&lt; long &gt;</b> ()</td></tr>
<tr class="separator:gab96a636035161cf4c2c8b0a03a4ccc19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e2a3153c59019b2334d7a6703933654"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga6e2a3153c59019b2334d7a6703933654"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:ga6e2a3153c59019b2334d7a6703933654"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>hipCreateChannelDesc&lt; unsigned long &gt;</b> ()</td></tr>
<tr class="separator:ga6e2a3153c59019b2334d7a6703933654"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2adcc2a2a236ef68089e69fb4adff785"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga2adcc2a2a236ef68089e69fb4adff785"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:ga2adcc2a2a236ef68089e69fb4adff785"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>hipCreateChannelDesc&lt; float &gt;</b> ()</td></tr>
<tr class="separator:ga2adcc2a2a236ef68089e69fb4adff785"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4c7dc312ebd8d1f8badb7011860253a4"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga4c7dc312ebd8d1f8badb7011860253a4"></a>
template&lt;class T , int dim, enum hipTextureReadMode readMode&gt; </td></tr>
<tr class="memitem:ga4c7dc312ebd8d1f8badb7011860253a4"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>hipBindTexture</b> (size_t *offset, struct texture&lt; T, dim, readMode &gt; &amp;tex, const void *devPtr, const struct <a class="el" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> *desc, size_t size=UINT_MAX)</td></tr>
<tr class="separator:ga4c7dc312ebd8d1f8badb7011860253a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga45f3281e4c43752fcb4b48cfb335e343"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga45f3281e4c43752fcb4b48cfb335e343"></a>
template&lt;class T , int dim, enum hipTextureReadMode readMode&gt; </td></tr>
<tr class="memitem:ga45f3281e4c43752fcb4b48cfb335e343"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>hipBindTexture</b> (size_t *offset, struct texture&lt; T, dim, readMode &gt; &amp;tex, const void *devPtr, size_t size=UINT_MAX)</td></tr>
<tr class="separator:ga45f3281e4c43752fcb4b48cfb335e343"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4e4cf941dbfce417b8b3e4718cb09d76"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga4e4cf941dbfce417b8b3e4718cb09d76"></a>
template&lt;class T , int dim, enum hipTextureReadMode readMode&gt; </td></tr>
<tr class="memitem:ga4e4cf941dbfce417b8b3e4718cb09d76"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>hipBindTextureToArray</b> (struct texture&lt; T, dim, readMode &gt; &amp;tex, <a class="el" href="structhipArray.html">hipArray</a> *array)</td></tr>
<tr class="separator:ga4e4cf941dbfce417b8b3e4718cb09d76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa671035bac1c252f07a35ac7550fdb3f"><td class="memTemplParams" colspan="2"><a class="anchor" id="gaa671035bac1c252f07a35ac7550fdb3f"></a>
template&lt;class T , int dim, enum hipTextureReadMode readMode&gt; </td></tr>
<tr class="memitem:gaa671035bac1c252f07a35ac7550fdb3f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="group__GlobalDefs.html#gadf5010f6e140a53ecbdf949e73e87594">hipError_t</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><b>hipUnbindTexture</b> (struct texture&lt; T, dim, readMode &gt; &amp;tex)</td></tr>
<tr class="separator:gaa671035bac1c252f07a35ac7550fdb3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2>----------------------------------------------------------------------------------------------&mdash; </h2>
<dl class="section warning"><dt>Warning</dt><dd>The HIP texture API implements a small subset of full texture API. Known limitations include:<ul>
<li>Only point sampling is supported.</li>
<li>Only C++ APIs are provided.</li>
<li>Many APIs and modes are not implemented.</li>
</ul>
</dd></dl>
<p>The HIP texture support is intended to allow use of texture cache on hardware where this is beneficial.</p>
<p>The following CUDA APIs are not currently supported:</p>
<ul>
<li>cudaBindTexture2D</li>
<li>cudaBindTextureToArray</li>
<li>cudaBindTextureToMipmappedArray</li>
<li>cudaGetChannelDesc</li>
<li>cudaGetTextureReference </li>
</ul>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gac9b0ae733fa849842342fab6d42c7b6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structhipChannelFormatDesc.html">hipChannelFormatDesc</a> hipCreateChannelDesc </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>z</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">hipChannelFormatKind&#160;</td>
<td class="paramname"><em>f</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a channel descriptor using the specified format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>X component </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>Y component </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">z</td><td>Z component </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>W component </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">f</td><td>Channel format </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Channel descriptor with format f </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Dec 19 2016 04:03:44 for HIP: Heterogenous-computing Interface for Portability by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>