You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
784 lines
48 KiB
784 lines
48 KiB
<!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.5"/>
|
|
<title>Face Engine SDK: fsdk::Ref< T > Struct Template 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="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/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 id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Face Engine SDK
|
|
 <span id="projectnumber">5.8.0</span>
|
|
</div>
|
|
<div id="projectbrief">A face detection, recognition and tracking engine.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<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="modules.html"><span>Modules</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('structfsdk_1_1_ref.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)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </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="#pub-methods">Public Member Functions</a> |
|
|
<a href="structfsdk_1_1_ref-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fsdk::Ref< T > Struct Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Smart pointer for reference counted objects.
|
|
<a href="structfsdk_1_1_ref.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_ref_8h_source.html">Ref.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for fsdk::Ref< T >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="structfsdk_1_1_ref.png" usemap="#fsdk::Ref< T >_map" alt=""/>
|
|
<map id="fsdk::Ref< T >_map" name="fsdk::Ref< T >_map">
|
|
<area href="structfsdk_1_1_ref_base.html" title="Generic base class of a pointer for reference counted objects. " alt="fsdk::RefBase< T >" shape="rect" coords="0,0,119,24"/>
|
|
</map>
|
|
</div></div>
|
|
<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:a58e4acb99a8a874754a23e6e4f7b2251"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58e4acb99a8a874754a23e6e4f7b2251"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a58e4acb99a8a874754a23e6e4f7b2251">Ref</a> () noexcept=default</td></tr>
|
|
<tr class="memdesc:a58e4acb99a8a874754a23e6e4f7b2251"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. Initializes object pointer to nullptr. <br/></td></tr>
|
|
<tr class="separator:a58e4acb99a8a874754a23e6e4f7b2251"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b302d028bf41a3299ad1a75d3078b08"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b302d028bf41a3299ad1a75d3078b08"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a2b302d028bf41a3299ad1a75d3078b08">Ref</a> (std::nullptr_t) noexcept</td></tr>
|
|
<tr class="memdesc:a2b302d028bf41a3299ad1a75d3078b08"><td class="mdescLeft"> </td><td class="mdescRight">Initializes object pointer to nullptr. <br/></td></tr>
|
|
<tr class="separator:a2b302d028bf41a3299ad1a75d3078b08"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa7673c14c03a88a443a5497497af5146"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#aa7673c14c03a88a443a5497497af5146">Ref</a> (T *ptr) noexcept</td></tr>
|
|
<tr class="memdesc:aa7673c14c03a88a443a5497497af5146"><td class="mdescLeft"> </td><td class="mdescRight">Initializes object pointer with ptr and retains a reference. <a href="#aa7673c14c03a88a443a5497497af5146">More...</a><br/></td></tr>
|
|
<tr class="separator:aa7673c14c03a88a443a5497497af5146"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3fdf807e4c01d6f07e8d67f920537022"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a3fdf807e4c01d6f07e8d67f920537022">Ref</a> (const <a class="el" href="structfsdk_1_1_ref.html">Ref</a> &other)</td></tr>
|
|
<tr class="memdesc:a3fdf807e4c01d6f07e8d67f920537022"><td class="mdescLeft"> </td><td class="mdescRight">Initializes object pointer with other and retains a reference. <a href="#a3fdf807e4c01d6f07e8d67f920537022">More...</a><br/></td></tr>
|
|
<tr class="separator:a3fdf807e4c01d6f07e8d67f920537022"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a04c673df1f8297ed0330b56be72218f2"><td class="memTemplParams" colspan="2">template<class D , typename = typename std::enable_if<std::is_convertible<D*, T*>::value>::type> </td></tr>
|
|
<tr class="memitem:a04c673df1f8297ed0330b56be72218f2"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a04c673df1f8297ed0330b56be72218f2">Ref</a> (const <a class="el" href="structfsdk_1_1_ref.html">Ref</a>< D > &other)</td></tr>
|
|
<tr class="memdesc:a04c673df1f8297ed0330b56be72218f2"><td class="mdescLeft"> </td><td class="mdescRight">Initializes object pointer with other and retains a reference. <a href="#a04c673df1f8297ed0330b56be72218f2">More...</a><br/></td></tr>
|
|
<tr class="separator:a04c673df1f8297ed0330b56be72218f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa1d9bbc7d476649947142015f22fa7c7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1d9bbc7d476649947142015f22fa7c7"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#aa1d9bbc7d476649947142015f22fa7c7">~Ref</a> () noexcept</td></tr>
|
|
<tr class="memdesc:aa1d9bbc7d476649947142015f22fa7c7"><td class="mdescLeft"> </td><td class="mdescRight">Releases reference being held (if any). <br/></td></tr>
|
|
<tr class="separator:aa1d9bbc7d476649947142015f22fa7c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a672bfe4b1b07aa8200e0c179323ffc81"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a672bfe4b1b07aa8200e0c179323ffc81">operator-></a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a672bfe4b1b07aa8200e0c179323ffc81"><td class="mdescLeft"> </td><td class="mdescRight">Access pointer. <a href="#a672bfe4b1b07aa8200e0c179323ffc81">More...</a><br/></td></tr>
|
|
<tr class="separator:a672bfe4b1b07aa8200e0c179323ffc81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4481cd13013a52fe8ff42cf8cbd25075"><td class="memItemLeft" align="right" valign="top">T ** </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a4481cd13013a52fe8ff42cf8cbd25075">getInitReference</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a4481cd13013a52fe8ff42cf8cbd25075"><td class="mdescLeft"> </td><td class="mdescRight">Access pointer for initialization. <a href="#a4481cd13013a52fe8ff42cf8cbd25075">More...</a><br/></td></tr>
|
|
<tr class="separator:a4481cd13013a52fe8ff42cf8cbd25075"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70f2e2f6d93a448c088311e65c17e29f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a70f2e2f6d93a448c088311e65c17e29f">operator==</a> (const <a class="el" href="structfsdk_1_1_ref.html">Ref</a> &other) const noexcept</td></tr>
|
|
<tr class="memdesc:a70f2e2f6d93a448c088311e65c17e29f"><td class="mdescLeft"> </td><td class="mdescRight">Check if two refs are the same. <a href="#a70f2e2f6d93a448c088311e65c17e29f">More...</a><br/></td></tr>
|
|
<tr class="separator:a70f2e2f6d93a448c088311e65c17e29f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c64ce15d1f45608206576a704208a26"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a9c64ce15d1f45608206576a704208a26">operator!=</a> (const <a class="el" href="structfsdk_1_1_ref.html">Ref</a> &other) const noexcept</td></tr>
|
|
<tr class="memdesc:a9c64ce15d1f45608206576a704208a26"><td class="mdescLeft"> </td><td class="mdescRight">Check if two refs are not the same. <a href="#a9c64ce15d1f45608206576a704208a26">More...</a><br/></td></tr>
|
|
<tr class="separator:a9c64ce15d1f45608206576a704208a26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4828c89609b91ef396295d9338a3966a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_ref.html">Ref</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a4828c89609b91ef396295d9338a3966a">operator=</a> (const <a class="el" href="structfsdk_1_1_ref.html">Ref</a> &other) noexcept</td></tr>
|
|
<tr class="memdesc:a4828c89609b91ef396295d9338a3966a"><td class="mdescLeft"> </td><td class="mdescRight">Assign a strong reference. <a href="#a4828c89609b91ef396295d9338a3966a">More...</a><br/></td></tr>
|
|
<tr class="separator:a4828c89609b91ef396295d9338a3966a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a845904eb499a34c81fad27567bd284f2"><td class="memTemplParams" colspan="2">template<class D , typename = typename std::enable_if<std::is_convertible<D*, T*>::value>::type> </td></tr>
|
|
<tr class="memitem:a845904eb499a34c81fad27567bd284f2"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_ref.html">Ref</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a845904eb499a34c81fad27567bd284f2">operator=</a> (const <a class="el" href="structfsdk_1_1_ref.html">Ref</a>< D > &other) noexcept</td></tr>
|
|
<tr class="memdesc:a845904eb499a34c81fad27567bd284f2"><td class="mdescLeft"> </td><td class="mdescRight">Assign a strong reference. <a href="#a845904eb499a34c81fad27567bd284f2">More...</a><br/></td></tr>
|
|
<tr class="separator:a845904eb499a34c81fad27567bd284f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacf7b3a1eb1afe796743ef8c9390a41c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_ref.html">Ref</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#aacf7b3a1eb1afe796743ef8c9390a41c">operator=</a> (T *ptr) noexcept</td></tr>
|
|
<tr class="memdesc:aacf7b3a1eb1afe796743ef8c9390a41c"><td class="mdescLeft"> </td><td class="mdescRight">Assign a raw pointer. <a href="#aacf7b3a1eb1afe796743ef8c9390a41c">More...</a><br/></td></tr>
|
|
<tr class="separator:aacf7b3a1eb1afe796743ef8c9390a41c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7b437683b2898eb84a2eb12f900b641"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_ref.html">Ref</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#ac7b437683b2898eb84a2eb12f900b641">operator=</a> (std::nullptr_t) noexcept</td></tr>
|
|
<tr class="memdesc:ac7b437683b2898eb84a2eb12f900b641"><td class="mdescLeft"> </td><td class="mdescRight">Assign a nullptr_t. <a href="#ac7b437683b2898eb84a2eb12f900b641">More...</a><br/></td></tr>
|
|
<tr class="separator:ac7b437683b2898eb84a2eb12f900b641"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed37366a7149bed9a7d7c322bd7bef91"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_ref.html">Ref</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#aed37366a7149bed9a7d7c322bd7bef91">assign</a> (T *ptr) noexcept</td></tr>
|
|
<tr class="memdesc:aed37366a7149bed9a7d7c322bd7bef91"><td class="mdescLeft"> </td><td class="mdescRight">Assign an object. Presumes shared ownership, increases reference count. <a href="#aed37366a7149bed9a7d7c322bd7bef91">More...</a><br/></td></tr>
|
|
<tr class="separator:aed37366a7149bed9a7d7c322bd7bef91"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d1295bb45a634e8907e6f3ce891e93b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_ref.html">Ref</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a5d1295bb45a634e8907e6f3ce891e93b">acquire</a> (T *ptr) noexcept</td></tr>
|
|
<tr class="memdesc:a5d1295bb45a634e8907e6f3ce891e93b"><td class="mdescLeft"> </td><td class="mdescRight">Acquire ownership of the object. <a href="#a5d1295bb45a634e8907e6f3ce891e93b">More...</a><br/></td></tr>
|
|
<tr class="separator:a5d1295bb45a634e8907e6f3ce891e93b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46bde60641331c01f9804db22cad3ed9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_ref.html">Ref</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a46bde60641331c01f9804db22cad3ed9">make_ref</a> (T *ptr) noexcept</td></tr>
|
|
<tr class="memdesc:a46bde60641331c01f9804db22cad3ed9"><td class="mdescLeft"> </td><td class="mdescRight">Create ref without acquiring ownership. <a href="#a46bde60641331c01f9804db22cad3ed9">More...</a><br/></td></tr>
|
|
<tr class="separator:a46bde60641331c01f9804db22cad3ed9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a24015b4f52310246a88e40ffd1e81030"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24015b4f52310246a88e40ffd1e81030"></a>
|
|
T * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a24015b4f52310246a88e40ffd1e81030">reset</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a24015b4f52310246a88e40ffd1e81030"><td class="mdescLeft"> </td><td class="mdescRight">Reset reference counted object and assign nullptr to the pointer. <br/></td></tr>
|
|
<tr class="separator:a24015b4f52310246a88e40ffd1e81030"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a74485eedefcd2c2f032a61bce36a2492"><td class="memTemplParams" colspan="2">template<typename S > </td></tr>
|
|
<tr class="memitem:a74485eedefcd2c2f032a61bce36a2492"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_ref.html">Ref</a>< S > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref.html#a74485eedefcd2c2f032a61bce36a2492">as</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a74485eedefcd2c2f032a61bce36a2492"><td class="mdescLeft"> </td><td class="mdescRight">Make smart reference with relative type. <a href="#a74485eedefcd2c2f032a61bce36a2492">More...</a><br/></td></tr>
|
|
<tr class="separator:a74485eedefcd2c2f032a61bce36a2492"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_structfsdk_1_1_ref_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfsdk_1_1_ref_base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structfsdk_1_1_ref_base.html">fsdk::RefBase< T ></a></td></tr>
|
|
<tr class="memitem:a53e524dddc5f820708d0db6c99069d64 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53e524dddc5f820708d0db6c99069d64"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a53e524dddc5f820708d0db6c99069d64">RefBase</a> () noexcept=default</td></tr>
|
|
<tr class="memdesc:a53e524dddc5f820708d0db6c99069d64 inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Initializes object pointer to nullptr. <br/></td></tr>
|
|
<tr class="separator:a53e524dddc5f820708d0db6c99069d64 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac9bb6fcbf9b720a6b5e7a4907cc80c1 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#aac9bb6fcbf9b720a6b5e7a4907cc80c1">RefBase</a> (T *ptr) noexcept</td></tr>
|
|
<tr class="memdesc:aac9bb6fcbf9b720a6b5e7a4907cc80c1 inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Initializes object pointer with ptr. <a href="#aac9bb6fcbf9b720a6b5e7a4907cc80c1">More...</a><br/></td></tr>
|
|
<tr class="separator:aac9bb6fcbf9b720a6b5e7a4907cc80c1 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a87fa2d42cdd5da50ad56c9fcc056099b inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a87fa2d42cdd5da50ad56c9fcc056099b">operator T *</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a87fa2d42cdd5da50ad56c9fcc056099b inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Get raw object pointer. <a href="#a87fa2d42cdd5da50ad56c9fcc056099b">More...</a><br/></td></tr>
|
|
<tr class="separator:a87fa2d42cdd5da50ad56c9fcc056099b inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c132b113b08dc44bc8a9150fd007d19 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a3c132b113b08dc44bc8a9150fd007d19">operator*</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a3c132b113b08dc44bc8a9150fd007d19 inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Dereference operator. <a href="#a3c132b113b08dc44bc8a9150fd007d19">More...</a><br/></td></tr>
|
|
<tr class="separator:a3c132b113b08dc44bc8a9150fd007d19 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e3a0a80186484fe19eec757ab9546d9 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a7e3a0a80186484fe19eec757ab9546d9">operator bool</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a7e3a0a80186484fe19eec757ab9546d9 inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Implicit cast to bool. <a href="#a7e3a0a80186484fe19eec757ab9546d9">More...</a><br/></td></tr>
|
|
<tr class="separator:a7e3a0a80186484fe19eec757ab9546d9 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a7d5f145b0709c08a5faf1741fafbe4 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a8a7d5f145b0709c08a5faf1741fafbe4">operator==</a> (const <a class="el" href="structfsdk_1_1_ref_base.html">RefBase</a> &other) const noexcept</td></tr>
|
|
<tr class="memdesc:a8a7d5f145b0709c08a5faf1741fafbe4 inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Check if two refs are the same. <a href="#a8a7d5f145b0709c08a5faf1741fafbe4">More...</a><br/></td></tr>
|
|
<tr class="separator:a8a7d5f145b0709c08a5faf1741fafbe4 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f5a390a37bc52d7483049069ecc89a0 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a5f5a390a37bc52d7483049069ecc89a0">operator!=</a> (const <a class="el" href="structfsdk_1_1_ref_base.html">RefBase</a> &other) const noexcept</td></tr>
|
|
<tr class="memdesc:a5f5a390a37bc52d7483049069ecc89a0 inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Check if two refs are not the same. <a href="#a5f5a390a37bc52d7483049069ecc89a0">More...</a><br/></td></tr>
|
|
<tr class="separator:a5f5a390a37bc52d7483049069ecc89a0 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65eb00c69769063de70515387aaf7d71 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a65eb00c69769063de70515387aaf7d71">isNull</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a65eb00c69769063de70515387aaf7d71 inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Check for nullptr. <a href="#a65eb00c69769063de70515387aaf7d71">More...</a><br/></td></tr>
|
|
<tr class="separator:a65eb00c69769063de70515387aaf7d71 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b102e6ffd4ea5e393f283169f826f6f inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a7b102e6ffd4ea5e393f283169f826f6f">isExpired</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a7b102e6ffd4ea5e393f283169f826f6f inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Check is object is dead. <a href="#a7b102e6ffd4ea5e393f283169f826f6f">More...</a><br/></td></tr>
|
|
<tr class="separator:a7b102e6ffd4ea5e393f283169f826f6f inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f4e70a1252dce29ced35e396c0a1d87 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a1f4e70a1252dce29ced35e396c0a1d87">isUnique</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a1f4e70a1252dce29ced35e396c0a1d87 inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Check if object has only one strong reference. <a href="#a1f4e70a1252dce29ced35e396c0a1d87">More...</a><br/></td></tr>
|
|
<tr class="separator:a1f4e70a1252dce29ced35e396c0a1d87 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ea44dfe520bbe2ced2fe2c023809288 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a7ea44dfe520bbe2ced2fe2c023809288">get</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a7ea44dfe520bbe2ced2fe2c023809288 inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Get current raw object pointer. <a href="#a7ea44dfe520bbe2ced2fe2c023809288">More...</a><br/></td></tr>
|
|
<tr class="separator:a7ea44dfe520bbe2ced2fe2c023809288 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9baae9b19a0723e049bce5d641889662 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#a9baae9b19a0723e049bce5d641889662">set</a> (T *ptr) noexcept</td></tr>
|
|
<tr class="memdesc:a9baae9b19a0723e049bce5d641889662 inherit pub_methods_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Replace object pointer without any checks or reference management. <a href="#a9baae9b19a0723e049bce5d641889662">More...</a><br/></td></tr>
|
|
<tr class="separator:a9baae9b19a0723e049bce5d641889662 inherit pub_methods_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pro_attribs_structfsdk_1_1_ref_base"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_structfsdk_1_1_ref_base')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="structfsdk_1_1_ref_base.html">fsdk::RefBase< T ></a></td></tr>
|
|
<tr class="memitem:ab57bc3fc17e734e742c0b47ec60573ba inherit pro_attribs_structfsdk_1_1_ref_base"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab57bc3fc17e734e742c0b47ec60573ba"></a>
|
|
T * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_ref_base.html#ab57bc3fc17e734e742c0b47ec60573ba">m_ptr</a> {nullptr}</td></tr>
|
|
<tr class="memdesc:ab57bc3fc17e734e742c0b47ec60573ba inherit pro_attribs_structfsdk_1_1_ref_base"><td class="mdescLeft"> </td><td class="mdescRight">Raw pointer. <br/></td></tr>
|
|
<tr class="separator:ab57bc3fc17e734e742c0b47ec60573ba inherit pro_attribs_structfsdk_1_1_ref_base"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename T><br/>
|
|
struct fsdk::Ref< T ></h3>
|
|
|
|
<p>Smart pointer for reference counted objects. </p>
|
|
<p>Automatically calls retain/release and provides safety assertions.</p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>object interface (must be derived from <a class="el" href="structfsdk_1_1_i_ref_counted.html" title="Base strong reference counted object interface. ">IRefCounted</a>) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="aa7673c14c03a88a443a5497497af5146"></a>
|
|
<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="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::<a class="el" href="structfsdk_1_1_ref.html">Ref</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T * </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes object pointer with ptr and retains a reference. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>this shares ownership. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>raw pointer to initialize with. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3fdf807e4c01d6f07e8d67f920537022"></a>
|
|
<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="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::<a class="el" href="structfsdk_1_1_ref.html">Ref</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structfsdk_1_1_ref.html">Ref</a>< T > & </td>
|
|
<td class="paramname"><em>other</em></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>Initializes object pointer with other and retains a reference. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>this shares ownership. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>pointer to initialize with. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a04c673df1f8297ed0330b56be72218f2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<div class="memtemplate">
|
|
template<class D , typename = typename std::enable_if<std::is_convertible<D*, T*>::value>::type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::<a class="el" href="structfsdk_1_1_ref.html">Ref</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structfsdk_1_1_ref.html">Ref</a>< D > & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes object pointer with other and retains a reference. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>this shares ownership. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>pointer of derived template class to initialize with. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a5d1295bb45a634e8907e6f3ce891e93b"></a>
|
|
<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="structfsdk_1_1_ref.html">Ref</a>& <a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::acquire </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T * </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Acquire ownership of the object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>raw object pointer to acquire. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a74485eedefcd2c2f032a61bce36a2492"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<div class="memtemplate">
|
|
template<typename S > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfsdk_1_1_ref.html">Ref</a><S> <a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::as </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make smart reference with relative type. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">S</td><td>target interface (must be relative to T) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aed37366a7149bed9a7d7c322bd7bef91"></a>
|
|
<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="structfsdk_1_1_ref.html">Ref</a>& <a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::assign </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T * </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assign an object. Presumes shared ownership, increases reference count. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>raw object pointer to assign. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4481cd13013a52fe8ff42cf8cbd25075"></a>
|
|
<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">T** <a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::getInitReference </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access pointer for initialization. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>previously held pointer is released. </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>pointer to pointer to object. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a46bde60641331c01f9804db22cad3ed9"></a>
|
|
<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="structfsdk_1_1_ref.html">Ref</a>& <a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::make_ref </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T * </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create ref without acquiring ownership. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>raw object pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9c64ce15d1f45608206576a704208a26"></a>
|
|
<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="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::operator!= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structfsdk_1_1_ref.html">Ref</a>< T > & </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if two refs are not the same. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if two refs are not the same. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>ref to check against. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a672bfe4b1b07aa8200e0c179323ffc81"></a>
|
|
<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">T* <a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::operator-> </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access pointer. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>pointer is checked for null in runtime. </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>pointer to object. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4828c89609b91ef396295d9338a3966a"></a>
|
|
<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="structfsdk_1_1_ref.html">Ref</a>& <a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structfsdk_1_1_ref.html">Ref</a>< T > & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assign a strong reference. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>strong reference. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>reference. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a845904eb499a34c81fad27567bd284f2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<div class="memtemplate">
|
|
template<class D , typename = typename std::enable_if<std::is_convertible<D*, T*>::value>::type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfsdk_1_1_ref.html">Ref</a>& <a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structfsdk_1_1_ref.html">Ref</a>< D > & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assign a strong reference. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>strong reference of derived template class. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>reference. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aacf7b3a1eb1afe796743ef8c9390a41c"></a>
|
|
<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="structfsdk_1_1_ref.html">Ref</a>& <a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T * </td>
|
|
<td class="paramname"><em>ptr</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assign a raw pointer. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>this shares ownership. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>raw pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>reference. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac7b437683b2898eb84a2eb12f900b641"></a>
|
|
<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="structfsdk_1_1_ref.html">Ref</a>& <a class="el" href="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::nullptr_t </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Assign a nullptr_t. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>this releases previously held reference (if any). </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>reference. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a70f2e2f6d93a448c088311e65c17e29f"></a>
|
|
<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="structfsdk_1_1_ref.html">fsdk::Ref</a>< T >::operator== </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structfsdk_1_1_ref.html">Ref</a>< T > & </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 class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if two refs are the same. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if two refs are the same. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>ref to check against. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>include/fsdk/Types/<a class="el" href="_ref_8h_source.html">Ref.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="namespacefsdk.html">fsdk</a></li><li class="navelem"><a class="el" href="structfsdk_1_1_ref.html">Ref</a></li>
|
|
<li class="footer">Generated on Fri Jun 17 2022 12:19:44 for Face Engine SDK by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|