<!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.10"/>
<title>OpenSubdiv: BufferDescriptor Struct Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxy.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 id="projectlogo"><img alt="Logo" src="opensubdiv_logo_header.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OpenSubdiv
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<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 Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00003.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="a00239.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BufferDescriptor Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="a00003.html" title="BufferDescriptor is a struct which describes buffer elements in interleaved data buffers. Almost all Osd Evaluator APIs take BufferDescriptors along with device-specific buffer objects. ">BufferDescriptor</a> is a struct which describes buffer elements in interleaved data buffers. Almost all <a class="el" href="a00185.html">Osd</a> Evaluator APIs take BufferDescriptors along with device-specific buffer objects.
<a href="a00003.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00127_source.html">bufferDescriptor.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a446218762f5de8c77d06ee61e14b6b61"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a446218762f5de8c77d06ee61e14b6b61">BufferDescriptor</a> ()</td></tr>
<tr class="memdesc:a446218762f5de8c77d06ee61e14b6b61"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a446218762f5de8c77d06ee61e14b6b61">More...</a><br /></td></tr>
<tr class="separator:a446218762f5de8c77d06ee61e14b6b61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a958068066d1d10ae2a452ac57d9c0401"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a958068066d1d10ae2a452ac57d9c0401">BufferDescriptor</a> (int o, int l, int s)</td></tr>
<tr class="memdesc:a958068066d1d10ae2a452ac57d9c0401"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a958068066d1d10ae2a452ac57d9c0401">More...</a><br /></td></tr>
<tr class="separator:a958068066d1d10ae2a452ac57d9c0401"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7c679db979bf84e756321c5cef9f5e3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#aa7c679db979bf84e756321c5cef9f5e3">GetLocalOffset</a> () const </td></tr>
<tr class="memdesc:aa7c679db979bf84e756321c5cef9f5e3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the relative offset within a stride. <a href="#aa7c679db979bf84e756321c5cef9f5e3">More...</a><br /></td></tr>
<tr class="separator:aa7c679db979bf84e756321c5cef9f5e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa8720abaf6972d6dac22a8cd1a67225"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#afa8720abaf6972d6dac22a8cd1a67225">IsValid</a> () const </td></tr>
<tr class="memdesc:afa8720abaf6972d6dac22a8cd1a67225"><td class="mdescLeft"> </td><td class="mdescRight">True if the descriptor values are internally consistent. <a href="#afa8720abaf6972d6dac22a8cd1a67225">More...</a><br /></td></tr>
<tr class="separator:afa8720abaf6972d6dac22a8cd1a67225"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a372de693ad40b3f42839c8ec6ac845f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a372de693ad40b3f42839c8ec6ac845f4">Reset</a> ()</td></tr>
<tr class="memdesc:a372de693ad40b3f42839c8ec6ac845f4"><td class="mdescLeft"> </td><td class="mdescRight">Resets the descriptor to default. <a href="#a372de693ad40b3f42839c8ec6ac845f4">More...</a><br /></td></tr>
<tr class="separator:a372de693ad40b3f42839c8ec6ac845f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abef3da6554046c6a392e0b856c7ebe65"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#abef3da6554046c6a392e0b856c7ebe65">operator==</a> (<a class="el" href="a00003.html">BufferDescriptor</a> const &other) const </td></tr>
<tr class="memdesc:abef3da6554046c6a392e0b856c7ebe65"><td class="mdescLeft"> </td><td class="mdescRight">True if the descriptors are identical. <a href="#abef3da6554046c6a392e0b856c7ebe65">More...</a><br /></td></tr>
<tr class="separator:abef3da6554046c6a392e0b856c7ebe65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c9b35a84bd6447bc1933c01232da235"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a8c9b35a84bd6447bc1933c01232da235">operator!=</a> (<a class="el" href="a00003.html">BufferDescriptor</a> const &other) const </td></tr>
<tr class="memdesc:a8c9b35a84bd6447bc1933c01232da235"><td class="mdescLeft"> </td><td class="mdescRight">True if the descriptors are not identical. <a href="#a8c9b35a84bd6447bc1933c01232da235">More...</a><br /></td></tr>
<tr class="separator:a8c9b35a84bd6447bc1933c01232da235"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aed7ea92f45bd273dde380a45ddced592"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#aed7ea92f45bd273dde380a45ddced592">offset</a></td></tr>
<tr class="memdesc:aed7ea92f45bd273dde380a45ddced592"><td class="mdescLeft"> </td><td class="mdescRight">offset to desired element data <a href="#aed7ea92f45bd273dde380a45ddced592">More...</a><br /></td></tr>
<tr class="separator:aed7ea92f45bd273dde380a45ddced592"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f59b34b1f25fe00023291b678246bcc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a9f59b34b1f25fe00023291b678246bcc">length</a></td></tr>
<tr class="memdesc:a9f59b34b1f25fe00023291b678246bcc"><td class="mdescLeft"> </td><td class="mdescRight">number or length of the data <a href="#a9f59b34b1f25fe00023291b678246bcc">More...</a><br /></td></tr>
<tr class="separator:a9f59b34b1f25fe00023291b678246bcc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08f66a6870d87afcd5dc1b60d1019692"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a08f66a6870d87afcd5dc1b60d1019692">stride</a></td></tr>
<tr class="memdesc:a08f66a6870d87afcd5dc1b60d1019692"><td class="mdescLeft"> </td><td class="mdescRight">stride to the next element <a href="#a08f66a6870d87afcd5dc1b60d1019692">More...</a><br /></td></tr>
<tr class="separator:a08f66a6870d87afcd5dc1b60d1019692"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="a00003.html" title="BufferDescriptor is a struct which describes buffer elements in interleaved data buffers. Almost all Osd Evaluator APIs take BufferDescriptors along with device-specific buffer objects. ">BufferDescriptor</a> is a struct which describes buffer elements in interleaved data buffers. Almost all <a class="el" href="a00185.html">Osd</a> Evaluator APIs take BufferDescriptors along with device-specific buffer objects. </p>
<p>The offset of <a class="el" href="a00003.html" title="BufferDescriptor is a struct which describes buffer elements in interleaved data buffers. Almost all Osd Evaluator APIs take BufferDescriptors along with device-specific buffer objects. ">BufferDescriptor</a> can also be used to express a batching offset if the data buffer is combined across multiple objects together.</p>
<ul>
<li>Note that each element has the same data type (float) </li>
</ul>
<p>Definition at line <a class="el" href="a00127_source.html#l00061">61</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a446218762f5de8c77d06ee61e14b6b61"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00003.html">BufferDescriptor</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default Constructor. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00064">64</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a958068066d1d10ae2a452ac57d9c0401"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00003.html">BufferDescriptor</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>o</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>s</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00067">67</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa7c679db979bf84e756321c5cef9f5e3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int GetLocalOffset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the relative offset within a stride. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00070">70</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div>
</div>
<a class="anchor" id="afa8720abaf6972d6dac22a8cd1a67225"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool IsValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>True if the descriptor values are internally consistent. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00075">75</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8c9b35a84bd6447bc1933c01232da235"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00003.html">BufferDescriptor</a> const & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>True if the descriptors are not identical. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00093">93</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div>
</div>
<a class="anchor" id="abef3da6554046c6a392e0b856c7ebe65"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00003.html">BufferDescriptor</a> const & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>True if the descriptors are identical. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00086">86</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a372de693ad40b3f42839c8ec6ac845f4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the descriptor to default. </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00081">81</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a9f59b34b1f25fe00023291b678246bcc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int length</td>
</tr>
</table>
</div><div class="memdoc">
<p>number or length of the data </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00100">100</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div>
</div>
<a class="anchor" id="aed7ea92f45bd273dde380a45ddced592"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>offset to desired element data </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00098">98</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div>
</div>
<a class="anchor" id="a08f66a6870d87afcd5dc1b60d1019692"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stride</td>
</tr>
</table>
</div><div class="memdoc">
<p>stride to the next element </p>
<p>Definition at line <a class="el" href="a00127_source.html#l00102">102</a> of file <a class="el" href="a00127_source.html">bufferDescriptor.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>opensubdiv/osd/<a class="el" href="a00127_source.html">bufferDescriptor.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="a00180.html">OpenSubdiv</a></li><li class="navelem"><a class="el" href="a00181.html">OPENSUBDIV_VERSION</a></li><li class="navelem"><a class="el" href="a00185.html">Osd</a></li><li class="navelem"><a class="el" href="a00003.html">BufferDescriptor</a></li>
<li class="footer">Generated on Wed Sep 6 2023 17:36:01 for OpenSubdiv by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li>
</ul>
</div>
</body>
</html>
