-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 1b935de
Showing
258 changed files
with
24,564 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> | ||
<head> | ||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
<meta http-equiv="X-UA-Compatible" content="IE=11"/> | ||
<meta name="generator" content="Doxygen 1.12.0"/> | ||
<meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
<title>Topaz: Member List</title> | ||
<link rel="icon" href="tz.png" type="image/x-icon" /> | ||
<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> | ||
<script type="text/javascript" src="clipboard.js"></script> | ||
<link href="navtree.css" rel="stylesheet" type="text/css"/> | ||
<script type="text/javascript" src="resize.js"></script> | ||
<script type="text/javascript" src="cookie.js"></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> | ||
<link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
<link href="doxygen-awesome.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 id="projectrow"> | ||
<td id="projectlogo"><img alt="Logo" src="tz.png"/></td> | ||
<td id="projectalign"> | ||
<div id="projectname">Topaz<span id="projectnumber"> 5.0</span> | ||
</div> | ||
<div id="projectbrief">Topaz Game Engine</div> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
</div> | ||
<!-- end header part --> | ||
<!-- Generated by Doxygen 1.12.0 --> | ||
<script type="text/javascript"> | ||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
var searchBox = new SearchBox("searchBox", "search/",'.html'); | ||
/* @license-end */ | ||
</script> | ||
<script type="text/javascript"> | ||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
$(function() { codefold.init(0); }); | ||
/* @license-end */ | ||
</script> | ||
<script type="text/javascript" src="menudata.js"></script> | ||
<script type="text/javascript" src="menu.js"></script> | ||
<script type="text/javascript"> | ||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
$(function() { | ||
initMenu('',true,false,'search.php','Search',false); | ||
$(function() { init_search(); }); | ||
}); | ||
/* @license-end */ | ||
</script> | ||
<div id="main-nav"></div> | ||
<script type="text/javascript"> | ||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
$(function(){ initResizable(false); }); | ||
/* @license-end */ | ||
</script> | ||
<!-- 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"> | ||
<div id="MSearchResults"> | ||
<div class="SRPage"> | ||
<div id="SRIndex"> | ||
<div id="SRResults"></div> | ||
<div class="SRStatus" id="Loading">Loading...</div> | ||
<div class="SRStatus" id="Searching">Searching...</div> | ||
<div class="SRStatus" id="NoMatches">No Matches</div> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
|
||
<div id="nav-path" class="navpath"> | ||
<ul> | ||
<li class="navelem"><b>tz</b></li><li class="navelem"><a class="el" href="classtz_1_1handle.html">handle</a></li> </ul> | ||
</div> | ||
</div><!-- top --> | ||
<div id="doc-content"> | ||
<div class="header"> | ||
<div class="headertitle"><div class="title">tz::handle< T > Member List</div></div> | ||
</div><!--header--> | ||
<div class="contents"> | ||
|
||
<p>This is the complete list of members for <a class="el" href="classtz_1_1handle.html">tz::handle< T ></a>, including all inherited members.</p> | ||
<table class="directory"> | ||
<tr class="even"><td class="entry"><a class="el" href="classtz_1_1handle.html#a71752e38ec8a8632d75b46476c816cff">operator!=</a>(nullhand_t) const</td><td class="entry"><a class="el" href="classtz_1_1handle.html">tz::handle< T ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | ||
<tr class="odd"><td class="entry"><a class="el" href="classtz_1_1handle.html#a31c4c8bcef24c167ce10939f50b7d5fa">operator=</a>(hanval value)</td><td class="entry"><a class="el" href="classtz_1_1handle.html">tz::handle< T ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | ||
<tr class="even"><td class="entry"><a class="el" href="classtz_1_1handle.html#a922e0f8da5720e1333027a37bab49d82">operator==</a>(nullhand_t) const</td><td class="entry"><a class="el" href="classtz_1_1handle.html">tz::handle< T ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | ||
<tr class="odd"><td class="entry"><a class="el" href="classtz_1_1handle.html#a5879b25f824f3282e5922569fdb669f2">peek</a>() const</td><td class="entry"><a class="el" href="classtz_1_1handle.html">tz::handle< T ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> | ||
</table></div><!-- contents --> | ||
<!-- start footer part --> | ||
<hr class="footer"/><address class="footer"><small> | ||
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 | ||
</small></address> | ||
</div><!-- doc-content --> | ||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,247 @@ | ||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> | ||
<head> | ||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
<meta http-equiv="X-UA-Compatible" content="IE=11"/> | ||
<meta name="generator" content="Doxygen 1.12.0"/> | ||
<meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
<title>Topaz: tz::handle< T > Class Template Reference</title> | ||
<link rel="icon" href="tz.png" type="image/x-icon" /> | ||
<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> | ||
<script type="text/javascript" src="clipboard.js"></script> | ||
<link href="navtree.css" rel="stylesheet" type="text/css"/> | ||
<script type="text/javascript" src="resize.js"></script> | ||
<script type="text/javascript" src="cookie.js"></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> | ||
<link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
<link href="doxygen-awesome.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 id="projectrow"> | ||
<td id="projectlogo"><img alt="Logo" src="tz.png"/></td> | ||
<td id="projectalign"> | ||
<div id="projectname">Topaz<span id="projectnumber"> 5.0</span> | ||
</div> | ||
<div id="projectbrief">Topaz Game Engine</div> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
</div> | ||
<!-- end header part --> | ||
<!-- Generated by Doxygen 1.12.0 --> | ||
<script type="text/javascript"> | ||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
var searchBox = new SearchBox("searchBox", "search/",'.html'); | ||
/* @license-end */ | ||
</script> | ||
<script type="text/javascript"> | ||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
$(function() { codefold.init(0); }); | ||
/* @license-end */ | ||
</script> | ||
<script type="text/javascript" src="menudata.js"></script> | ||
<script type="text/javascript" src="menu.js"></script> | ||
<script type="text/javascript"> | ||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
$(function() { | ||
initMenu('',true,false,'search.php','Search',false); | ||
$(function() { init_search(); }); | ||
}); | ||
/* @license-end */ | ||
</script> | ||
<div id="main-nav"></div> | ||
<script type="text/javascript"> | ||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
$(function(){ initResizable(false); }); | ||
/* @license-end */ | ||
</script> | ||
<!-- 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"> | ||
<div id="MSearchResults"> | ||
<div class="SRPage"> | ||
<div id="SRIndex"> | ||
<div id="SRResults"></div> | ||
<div class="SRStatus" id="Loading">Loading...</div> | ||
<div class="SRStatus" id="Searching">Searching...</div> | ||
<div class="SRStatus" id="NoMatches">No Matches</div> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
|
||
<div id="nav-path" class="navpath"> | ||
<ul> | ||
<li class="navelem"><b>tz</b></li><li class="navelem"><a class="el" href="classtz_1_1handle.html">handle</a></li> </ul> | ||
</div> | ||
</div><!-- top --> | ||
<div id="doc-content"> | ||
<div class="header"> | ||
<div class="summary"> | ||
<a href="#pub-methods">Public Member Functions</a> | | ||
<a href="classtz_1_1handle-members.html">List of all members</a> </div> | ||
<div class="headertitle"><div class="title">tz::handle< T > Class Template Reference<div class="ingroups"><a class="el" href="group__tz.html">API Reference</a> » <a class="el" href="group__tz__core.html">Core Libraries</a></div></div></div> | ||
</div><!--header--> | ||
<div class="contents"> | ||
<a name="details" id="details"></a><h2 class="groupheader">Description</h2> | ||
<div class="textblock"><div class="compoundTemplParams">template<typename T><br /> | ||
class tz::handle< T ></div><p>Represents a generic opaque handle. </p> | ||
<p>To create your own opaque handle types, simply create a type alias for a <code>handle<T></code> where <code>T</code> is any unique type identifier. </p> | ||
</div> | ||
<p><code>#include "<a class="el" href="handle_8hpp_source.html">handle.hpp</a>"</code></p> | ||
<table class="memberdecls"> | ||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> | ||
Public Member Functions</h2></td></tr> | ||
<tr class="memitem:a5879b25f824f3282e5922569fdb669f2" id="r_a5879b25f824f3282e5922569fdb669f2"><td class="memItemLeft" align="right" valign="top">std::underlying_type_t< hanval > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5879b25f824f3282e5922569fdb669f2">peek</a> () const</td></tr> | ||
<tr class="memdesc:a5879b25f824f3282e5922569fdb669f2"><td class="mdescLeft"> </td><td class="mdescRight">Disregard the concept of "opaqueness" of an opaque handle by peeking at the underlying value. You should avoid the use of this outside of debug tools. <br /></td></tr> | ||
<tr class="separator:a5879b25f824f3282e5922569fdb669f2"><td class="memSeparator" colspan="2"> </td></tr> | ||
<tr class="memitem:a31c4c8bcef24c167ce10939f50b7d5fa" id="r_a31c4c8bcef24c167ce10939f50b7d5fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtz_1_1handle.html">handle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a31c4c8bcef24c167ce10939f50b7d5fa">operator=</a> (hanval value)</td></tr> | ||
<tr class="memdesc:a31c4c8bcef24c167ce10939f50b7d5fa"><td class="mdescLeft"> </td><td class="mdescRight">Assign a handle to the null handle, meaning it is now invalid. <br /></td></tr> | ||
<tr class="separator:a31c4c8bcef24c167ce10939f50b7d5fa"><td class="memSeparator" colspan="2"> </td></tr> | ||
<tr class="memitem:a922e0f8da5720e1333027a37bab49d82" id="r_a922e0f8da5720e1333027a37bab49d82"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a922e0f8da5720e1333027a37bab49d82">operator==</a> (nullhand_t) const</td></tr> | ||
<tr class="memdesc:a922e0f8da5720e1333027a37bab49d82"><td class="mdescLeft"> </td><td class="mdescRight">Compare a handle to the null handle. This comparison will return false if the handle is valid. <br /></td></tr> | ||
<tr class="separator:a922e0f8da5720e1333027a37bab49d82"><td class="memSeparator" colspan="2"> </td></tr> | ||
<tr class="memitem:a71752e38ec8a8632d75b46476c816cff" id="r_a71752e38ec8a8632d75b46476c816cff"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a71752e38ec8a8632d75b46476c816cff">operator!=</a> (nullhand_t) const</td></tr> | ||
<tr class="memdesc:a71752e38ec8a8632d75b46476c816cff"><td class="mdescLeft"> </td><td class="mdescRight">Compare a handle to the null handle. This comparison will return true if the handle is valid. <br /></td></tr> | ||
<tr class="separator:a71752e38ec8a8632d75b46476c816cff"><td class="memSeparator" colspan="2"> </td></tr> | ||
</table> | ||
<h2 class="groupheader">Member Function Documentation</h2> | ||
<a id="a5879b25f824f3282e5922569fdb669f2" name="a5879b25f824f3282e5922569fdb669f2"></a> | ||
<h2 class="memtitle"><span class="permalink"><a href="#a5879b25f824f3282e5922569fdb669f2">◆ </a></span>peek()</h2> | ||
|
||
<div class="memitem"> | ||
<div class="memproto"> | ||
<div class="memtemplate"> | ||
template<typename T > </div> | ||
<table class="mlabels"> | ||
<tr> | ||
<td class="mlabels-left"> | ||
<table class="memname"> | ||
<tr> | ||
<td class="memname">std::underlying_type_t< hanval > <a class="el" href="classtz_1_1handle.html">tz::handle</a>< T >::peek </td> | ||
<td>(</td> | ||
<td class="paramname"><span class="paramname"><em></em></span></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>Disregard the concept of "opaqueness" of an opaque handle by peeking at the underlying value. You should avoid the use of this outside of debug tools. </p> | ||
|
||
</div> | ||
</div> | ||
<a id="a31c4c8bcef24c167ce10939f50b7d5fa" name="a31c4c8bcef24c167ce10939f50b7d5fa"></a> | ||
<h2 class="memtitle"><span class="permalink"><a href="#a31c4c8bcef24c167ce10939f50b7d5fa">◆ </a></span>operator=()</h2> | ||
|
||
<div class="memitem"> | ||
<div class="memproto"> | ||
<div class="memtemplate"> | ||
template<typename T > </div> | ||
<table class="mlabels"> | ||
<tr> | ||
<td class="mlabels-left"> | ||
<table class="memname"> | ||
<tr> | ||
<td class="memname"><a class="el" href="classtz_1_1handle.html">handle</a> & <a class="el" href="classtz_1_1handle.html">tz::handle</a>< T >::operator= </td> | ||
<td>(</td> | ||
<td class="paramtype">hanval</td> <td class="paramname"><span class="paramname"><em>value</em></span></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>Assign a handle to the null handle, meaning it is now invalid. </p> | ||
|
||
</div> | ||
</div> | ||
<a id="a922e0f8da5720e1333027a37bab49d82" name="a922e0f8da5720e1333027a37bab49d82"></a> | ||
<h2 class="memtitle"><span class="permalink"><a href="#a922e0f8da5720e1333027a37bab49d82">◆ </a></span>operator==()</h2> | ||
|
||
<div class="memitem"> | ||
<div class="memproto"> | ||
<div class="memtemplate"> | ||
template<typename T > </div> | ||
<table class="mlabels"> | ||
<tr> | ||
<td class="mlabels-left"> | ||
<table class="memname"> | ||
<tr> | ||
<td class="memname">bool <a class="el" href="classtz_1_1handle.html">tz::handle</a>< T >::operator== </td> | ||
<td>(</td> | ||
<td class="paramtype">nullhand_t</td> <td class="paramname"><span class="paramname"><em></em></span></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>Compare a handle to the null handle. This comparison will return false if the handle is valid. </p> | ||
|
||
</div> | ||
</div> | ||
<a id="a71752e38ec8a8632d75b46476c816cff" name="a71752e38ec8a8632d75b46476c816cff"></a> | ||
<h2 class="memtitle"><span class="permalink"><a href="#a71752e38ec8a8632d75b46476c816cff">◆ </a></span>operator!=()</h2> | ||
|
||
<div class="memitem"> | ||
<div class="memproto"> | ||
<div class="memtemplate"> | ||
template<typename T > </div> | ||
<table class="mlabels"> | ||
<tr> | ||
<td class="mlabels-left"> | ||
<table class="memname"> | ||
<tr> | ||
<td class="memname">bool <a class="el" href="classtz_1_1handle.html">tz::handle</a>< T >::operator!= </td> | ||
<td>(</td> | ||
<td class="paramtype">nullhand_t</td> <td class="paramname"><span class="paramname"><em></em></span></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>Compare a handle to the null handle. This comparison will return true if the handle is valid. </p> | ||
|
||
</div> | ||
</div> | ||
</div><!-- contents --> | ||
<!-- start footer part --> | ||
<hr class="footer"/><address class="footer"><small> | ||
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 | ||
</small></address> | ||
</div><!-- doc-content --> | ||
</body> | ||
</html> |
Oops, something went wrong.