2021-03-07 05:58:59 +01:00

39 lines
19 KiB
HTML

<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<head><meta charset="utf-8"/><link href="../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../jquery-1.9.1.min.js"></script><script src="../bootstrap/js/bootstrap.min.js"></script><script src="../bootstrap/js/bootstrap-select.min.js"></script><link href="../styles.css" rel="stylesheet"/><link href="../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../nav.js"></script><script type="text/javascript" src="../index.js"></script><link rel="icon" href="../favicon.ico" type="image/x-icon"></link><title>cpp.Pointer - API Reference</title></head><body><style>
a, code .type {
color: #24afc4;
}
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
background: #24afc4;
color: #ffffff;
text-shadow: 0 0 0 transparent;
}
.navbar .container {
width: 940px ;
}
@media (max-width: 767px) {
.navbar .container {
width: auto;
}
}
@media (max-width: 979px) and (min-width: 768px) {
.navbar .container {
width: 724px;
}
}
@media (min-width: 1200px) {
.navbar .container {
width: 1170px;
}
}
.navbar .container img {
margin: 5px 0 0 4px;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Pointer&lt;<span class="type">T</span>&gt;</h1><h4><small>package <a href="../cpp/index.html">cpp</a></small></h4><h4><small>extends <a class="type" title="" href="../cpp/ConstPointer.html">ConstPointer</a></small></h4> <p class="availability"><hr/><em>Available on Android, iOS, macOS, Linux, Windows</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p></p></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="ref"></a><h3><p><code><a href="../cpp/Pointer.html#ref"><span class="identifier">ref</span></a>:<a class="type" title="" href="../cpp/Reference.html">Reference</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="destroy"></a><h3><p><code><a href="#destroy"><span class="identifier">destroy</span></a> ():<a class="type" title="The standard Void type." href="../Void.html">Void</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="destroyArray"></a><h3><p><code><a href="#destroyArray"><span class="identifier">destroyArray</span></a> ():<a class="type" title="The standard Void type." href="../Void.html">Void</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="get_ref"></a><h3><p><code><a href="#get_ref"><span class="identifier">get_ref</span></a> ():<a class="type" title="" href="../cpp/Reference.html">Reference</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="postIncRef"></a><h3><p><code><a href="#postIncRef"><span class="identifier">postIncRef</span></a> ():<a class="type" title="" href="../cpp/Reference.html">Reference</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="setAt"></a><h3><p><code><a href="#setAt"><span class="identifier">setAt</span></a> (<span style="white-space:nowrap">inIndex:<a class="type" title="The standard Int type." href="../Int.html">Int</a>,</span> <span style="white-space:nowrap">value:<span class="type">T</span></span>):<a class="type" title="The standard Void type." href="../Void.html">Void</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="set_ref"></a><h3><p><code><a href="#set_ref"><span class="identifier">set_ref</span></a> (<span style="white-space:nowrap">t:<span class="type">T</span></span>):<a class="type" title="" href="../cpp/Reference.html">Reference</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="toUnmanagedArray"></a><h3><p><code><span class="label">inline</span> <a href="#toUnmanagedArray"><span class="identifier">toUnmanagedArray</span></a> (<span style="white-space:nowrap">elementCount:<a class="type" title="The standard Int type." href="../Int.html">Int</a></span>):<a class="type" title="An Array is a storage for values." href="../Array.html">Array</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="toUnmanagedVector"></a><h3><p><code><span class="label">inline</span> <a href="#toUnmanagedVector"><span class="identifier">toUnmanagedVector</span></a> (<span style="white-space:nowrap">elementCount:<a class="type" title="The standard Int type." href="../Int.html">Int</a></span>):<a class="type" title="A Vector is a storage of fixed size." href="../haxe/ds/Vector.html">Vector</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="addressOf"></a><h3><p><code><span class="label">static</span><a href="#addressOf"><span class="identifier">addressOf</span></a>&lt;<span class="type">T</span>&gt; (<span style="white-space:nowrap">inVariable:<a class="type" title="" href="../cpp/Reference.html">Reference</a>&lt;<span class="type">T</span>&gt;</span>):<a class="type" title="" href="../cpp/Pointer.html">Pointer</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="arrayElem"></a><h3><p><code><span class="label">static</span><span class="label">inline</span> <a href="#arrayElem"><span class="identifier">arrayElem</span></a>&lt;<span class="type">T</span>&gt; (<span style="white-space:nowrap">array:<a class="type" title="An Array is a storage for values." href="../Array.html">Array</a>&lt;<span class="type">T</span>&gt;,</span> <span style="white-space:nowrap">inElem:<a class="type" title="The standard Int type." href="../Int.html">Int</a></span>):<a class="type" title="" href="../cpp/Pointer.html">Pointer</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="endOf"></a><h3><p><code><span class="label">static</span><a href="#endOf"><span class="identifier">endOf</span></a>&lt;<span class="type">T</span>&gt; (<span style="white-space:nowrap">inVariable:<span class="type">T</span></span>):<a class="type" title="" href="../cpp/Pointer.html">Pointer</a>&lt;<a class="type" title="" href="../cpp/Void.html">Void</a>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="fromHandle"></a><h3><p><code><span class="label">static</span><span class="label">inline</span> <a href="#fromHandle"><span class="identifier">fromHandle</span></a>&lt;<span class="type">T</span>&gt; (<span style="white-space:nowrap">inHandle:<a class="type" title="Dynamic is a special type which is compatible with all other types." href="../Dynamic.html">Dynamic</a>,</span> <span style="white-space:nowrap">?inKind:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="" href="../cpp/Pointer.html">Pointer</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="fromPointer"></a><h3><p><code><span class="label">static</span><a href="#fromPointer"><span class="identifier">fromPointer</span></a>&lt;<span class="type">T</span>&gt; (<span style="white-space:nowrap">inNativePointer:<a class="type" title="Dynamic is a special type which is compatible with all other types." href="../Dynamic.html">Dynamic</a></span>):<a class="type" title="" href="../cpp/Pointer.html">Pointer</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="fromRaw"></a><h3><p><code><span class="label">static</span><a href="#fromRaw"><span class="identifier">fromRaw</span></a>&lt;<span class="type">T</span>&gt; (<span style="white-space:nowrap">ptr:<a class="type" title="" href="../cpp/RawPointer.html">RawPointer</a>&lt;<span class="type">T</span>&gt;</span>):<a class="type" title="" href="../cpp/Pointer.html">Pointer</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="nativeArrayElem"></a><h3><p><code><span class="label">static</span><a href="#nativeArrayElem"><span class="identifier">nativeArrayElem</span></a>&lt;<span class="type">T</span>&gt; (<span style="white-space:nowrap">array:<a class="type" title="An Array is a storage for values." href="../Array.html">Array</a>&lt;<span class="type">T</span>&gt;,</span> <span style="white-space:nowrap">inElem:<a class="type" title="The standard Int type." href="../Int.html">Int</a></span>):<a class="type" title="" href="../cpp/AutoCast.html">AutoCast</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="nativeFromHandle"></a><h3><p><code><span class="label">static</span><a href="#nativeFromHandle"><span class="identifier">nativeFromHandle</span></a>&lt;<span class="type">T</span>&gt; (<span style="white-space:nowrap">inHandle:<a class="type" title="Dynamic is a special type which is compatible with all other types." href="../Dynamic.html">Dynamic</a>,</span> <span style="white-space:nowrap">?inKind:<a class="type" title="The basic String class." href="../String.html">String</a></span>):<a class="type" title="" href="../cpp/AutoCast.html">AutoCast</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="nativeOfArray"></a><h3><p><code><span class="label">static</span><a href="#nativeOfArray"><span class="identifier">nativeOfArray</span></a>&lt;<span class="type">T</span>&gt; (<span style="white-space:nowrap">array:<a class="type" title="An Array is a storage for values." href="../Array.html">Array</a>&lt;<span class="type">T</span>&gt;</span>):<a class="type" title="" href="../cpp/AutoCast.html">AutoCast</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="ofArray"></a><h3><p><code><span class="label">static</span><span class="label">inline</span> <a href="#ofArray"><span class="identifier">ofArray</span></a>&lt;<span class="type">T</span>&gt; (<span style="white-space:nowrap">array:<a class="type" title="An Array is a storage for values." href="../Array.html">Array</a>&lt;<span class="type">T</span>&gt;</span>):<a class="type" title="" href="../cpp/Pointer.html">Pointer</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div></div> <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="" href="../cpp/ConstPointer.html">ConstPointer</a></h4><div style="display:none"><div class="field "><a name="constRaw"></a><h3><p><code><span class="label">read only</span><a href="../cpp/ConstPointer.html#constRaw"><span class="identifier">constRaw</span></a>:<a class="type" title="" href="../cpp/RawConstPointer.html">RawConstPointer</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="ptr"></a><h3><p><code><a href="../cpp/ConstPointer.html#ptr"><span class="identifier">ptr</span></a>:<a class="type" title="" href="../cpp/Star.html">Star</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="raw"></a><h3><p><code><span class="label">read only</span><a href="../cpp/ConstPointer.html#raw"><span class="identifier">raw</span></a>:<a class="type" title="" href="../cpp/RawPointer.html">RawPointer</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="value"></a><h3><p><code><span class="label">read only</span><a href="../cpp/ConstPointer.html#value"><span class="identifier">value</span></a>:<span class="type">T</span></code></p></h3><div class="doc"><p></p></div></div></div></div><h3 class="section">Inherited Methods</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="" href="../cpp/ConstPointer.html">ConstPointer</a></h4><div style="display:none"><div class="field "><a name="at"></a><h3><p><code><a href="#at"><span class="identifier">at</span></a> (<span style="white-space:nowrap">inIndex:<a class="type" title="The standard Int type." href="../Int.html">Int</a></span>):<a class="type" title="" href="../cpp/Reference.html">Reference</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="geq"></a><h3><p><code><a href="#geq"><span class="identifier">geq</span></a> (<span style="white-space:nowrap">inOther:<a class="type" title="" href="../cpp/ConstPointer.html">ConstPointer</a>&lt;<span class="type">T</span>&gt;</span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="get_constRaw"></a><h3><p><code><a href="#get_constRaw"><span class="identifier">get_constRaw</span></a> ():<a class="type" title="" href="../cpp/RawConstPointer.html">RawConstPointer</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="get_raw"></a><h3><p><code><a href="#get_raw"><span class="identifier">get_raw</span></a> ():<a class="type" title="" href="../cpp/RawPointer.html">RawPointer</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="get_value"></a><h3><p><code><a href="#get_value"><span class="identifier">get_value</span></a> ():<a class="type" title="" href="../cpp/Reference.html">Reference</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="gt"></a><h3><p><code><a href="#gt"><span class="identifier">gt</span></a> (<span style="white-space:nowrap">inOther:<a class="type" title="" href="../cpp/ConstPointer.html">ConstPointer</a>&lt;<span class="type">T</span>&gt;</span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="leq"></a><h3><p><code><a href="#leq"><span class="identifier">leq</span></a> (<span style="white-space:nowrap">inOther:<a class="type" title="" href="../cpp/ConstPointer.html">ConstPointer</a>&lt;<span class="type">T</span>&gt;</span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="lt"></a><h3><p><code><a href="#lt"><span class="identifier">lt</span></a> (<span style="white-space:nowrap">inOther:<a class="type" title="" href="../cpp/ConstPointer.html">ConstPointer</a>&lt;<span class="type">T</span>&gt;</span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../Bool.html">Bool</a></code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="postIncVal"></a><h3><p><code><a href="#postIncVal"><span class="identifier">postIncVal</span></a> ():<a class="type" title="" href="../cpp/Reference.html">Reference</a>&lt;<span class="type">T</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="rawCast"></a><h3><p><code><a href="#rawCast"><span class="identifier">rawCast</span></a>&lt;<span class="type">Other</span>&gt; ():<a class="type" title="" href="../cpp/RawPointer.html">RawPointer</a>&lt;<span class="type">Other</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="reinterpret"></a><h3><p><code><a href="#reinterpret"><span class="identifier">reinterpret</span></a>&lt;<span class="type">Other</span>&gt; ():<a class="type" title="" href="../cpp/Pointer.html">Pointer</a>&lt;<span class="type">Other</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="field "><a name="setRaw"></a><h3><p><code><a href="#setRaw"><span class="identifier">setRaw</span></a>&lt;<span class="type">O</span>&gt; (<span style="white-space:nowrap">ptr:<a class="type" title="" href="../cpp/RawPointer.html">RawPointer</a>&lt;<span class="type">O</span>&gt;</span>):<a class="type" title="The standard Void type." href="../Void.html">Void</a></code></p></h3><div class="doc"><p></p></div></div></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">&copy; 2017 &nbsp;<a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="..//highlighter.js"></script><link href="../highlighter.css" rel="stylesheet"/></body></html>