94 lines
13 KiB
HTML
94 lines
13 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>haxe - 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"><h1>haxe </h1><!--
|
|
::if full == ""::
|
|
<h1>Haxe API documentation <small ::cond api.isDefined("version")::>version ::api.getValue('version')::</small></h1>
|
|
<p>Haxe is an open source toolkit based on a modern, high level, strictly typed programming language, a cross-compiler, a complete cross-platform standard library and ways to access each platform's native capabilities.</p>
|
|
<h3>Getting Started With Haxe</h3>
|
|
<ul>
|
|
<li>Take a look at our <a href="http://haxe.org/documentation/introduction/">introduction</a></li>
|
|
<li>Read through the <a href="http://haxe.org/manual/">Haxe Manual</a></li>
|
|
<li>Look at these <a href="http://haxe.org/use-cases/">use cases for Haxe</a></li>
|
|
<li>Find and install <a href="http://lib.haxe.org/t/all/">popular Haxe libraries</a></li>
|
|
<li>Learn by example with the <a href="http://code.haxe.org">Haxe Code Cookbook</a></li>
|
|
</ul>
|
|
<hr/>
|
|
<h3>Top Level</h3>
|
|
::elseif full.split(".").length==1::
|
|
<h1>Haxe/::full:: API documentation</h1>
|
|
<p>To get started with the Haxe ::full:: target:</p>
|
|
<ul>
|
|
<li>Read through the <a href="http://haxe.org/manual/">Haxe Manual</a></li>
|
|
<li ::cond full=="js"::>Read the <a href="http://haxe.org/manual/target-javascript.html">Haxe/JavaScript target details</a></li>
|
|
<li ::cond full=="flash"::>Read the <a href="http://haxe.org/manual/target-flash.html">Haxe/Flash target details</a></li>
|
|
<li ::cond full=="php"::>Read the <a href="http://haxe.org/manual/target-php.html">Haxe/PHP target details</a></li>
|
|
<li ::cond full=="cpp"::>Read the <a href="http://haxe.org/manual/target-cpp.html">Haxe/C++ target details</a></li>
|
|
<li ::cond full=="neko"::>Read the <a href="http://nekovm.org/doc">Neko documentation</a></li>
|
|
<li>Find and install <a href="http://lib.haxe.org/t/::full::/">popular Haxe/::full:: libraries</a></li>
|
|
<li>Learn by example with the <a href="http://code.haxe.org">Haxe Code Cookbook</a></li>
|
|
</ul>
|
|
<hr/>
|
|
<h1><small class="directive">package</small> ::full::</h1>
|
|
::else::
|
|
<h1><small class="directive">package</small> ::full::</h1>
|
|
::end::
|
|
-->
|
|
<table class="table table-condensed"><tbody><tr><th width="200"><i class="fa fa-folder-o"></i><a href="../index.html" title="">..</a></th><td></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/crypto/index.html" title="haxe.crypto">crypto</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/ds/index.html" title="haxe.ds">ds</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/extern/index.html" title="haxe.extern">extern</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/format/index.html" title="haxe.format">format</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/io/index.html" title="haxe.io">io</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/macro/index.html" title="haxe.macro">macro</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/remoting/index.html" title="haxe.remoting">remoting</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/rtti/index.html" title="haxe.rtti">rtti</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/unit/index.html" title="haxe.unit">unit</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/web/index.html" title="haxe.web">web</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/xml/index.html" title="haxe.xml">xml</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="../haxe/zip/index.html" title="haxe.zip">zip</a></td></tr><tr class="class"><td width="200"><a href="../haxe/CallStack.html" title="haxe.CallStack">CallStack</a></td><td><p>Get informations about the call stack.</p></td></tr><tr class="abstract"><td width="200"><a href="../haxe/Constructible.html" title="haxe.Constructible">Constructible</a></td><td><p>This type unifies with any instance of classes that have a constructor
|
|
which</p></td></tr><tr class="abstract"><td width="200"><a href="../haxe/DynamicAccess.html" title="haxe.DynamicAccess">DynamicAccess</a></td><td><p>DynamicAccess is an abstract type for working with anonymous structures
|
|
that are intended to hold collections of objects by the string key.</p></td></tr><tr class="abstract"><td width="200"><a href="../haxe/EnumFlags.html" title="haxe.EnumFlags">EnumFlags</a></td><td><p>A typed interface for bit flags. This is not a real object, only a typed
|
|
interface for an actual Int. Each flag can be tested/set with the
|
|
corresponding enum instance. Up to 32 flags can be stored that way.</p></td></tr><tr class="class"><td width="200"><a href="../haxe/EnumTools.html" title="haxe.EnumTools">EnumTools</a></td><td><p>This class provides advanced methods on enums. It is ideally used with
|
|
<code>using <a href="../haxe/EnumTools.html">EnumTools</a></code> and then acts as an
|
|
<a href="https://haxe.org/manual/lf-static-extension.html">extension</a> to the
|
|
<code>enum</code> types.</p></td></tr><tr class="class"><td width="200"><a href="../haxe/EnumValueTools.html" title="haxe.EnumValueTools">EnumValueTools</a></td><td><p>This class provides advanced methods on enum values. It is ideally used with
|
|
<code>using <a href="../haxe/EnumValueTools.html">EnumValueTools</a></code> and then acts as an
|
|
<a href="https://haxe.org/manual/lf-static-extension.html">extension</a> to the
|
|
<code><a href="../EnumValue.html">EnumValue</a></code> types.</p></td></tr><tr class="abstract"><td width="200"><a href="../haxe/FlatEnum.html" title="haxe.FlatEnum">FlatEnum</a></td><td><p>This type unifies with an enum instance if all constructors of the enum
|
|
require no arguments.</p></td></tr><tr class="abstract"><td width="200"><a href="../haxe/Function.html" title="haxe.Function">Function</a></td><td><p>This type unifies with any function type.</p></td></tr><tr class="class"><td width="200"><a href="../haxe/IMap.html" title="haxe.IMap">IMap</a></td><td><p></p></td></tr><tr class="abstract"><td width="200"><a href="../haxe/Int32.html" title="haxe.Int32">Int32</a></td><td><p>Int32 provides a 32-bit integer with consistent overflow behavior across
|
|
all platforms.</p></td></tr><tr class="abstract"><td width="200"><a href="../haxe/Int64.html" title="haxe.Int64">Int64</a></td><td><p>A cross-platform signed 64-bit integer.
|
|
Int64 instances can be created from two 32-bit words using <code><a href="../haxe/Int64.html#make">Int64.make</a>()</code>.</p></td></tr><tr class="class"><td width="200"><a href="../haxe/Json.html" title="haxe.Json">Json</a></td><td><p>Cross-platform JSON API: it will automatically use the optimized native API if available.
|
|
Use <code>-D haxeJSON</code> to force usage of the Haxe implementation even if a native API is found:
|
|
This will provide extra encoding features such as enums (replaced by their index) and StringMaps.</p></td></tr><tr class="class"><td width="200"><a href="../haxe/Log.html" title="haxe.Log">Log</a></td><td><p>Log primarily provides the <code>trace()</code> method, which is invoked upon a call to
|
|
<code>trace()</code> in Haxe code.</p></td></tr><tr class="type"><td width="200"><a href="../haxe/PosInfos.html" title="haxe.PosInfos">PosInfos</a></td><td><p>PosInfos is a magic type which can be used to generate position information
|
|
into the output for debugging use.</p></td></tr><tr class="class"><td width="200"><a href="../haxe/Serializer.html" title="haxe.Serializer">Serializer</a></td><td><p>The Serializer class can be used to encode values and objects into a <code><a href="../String.html">String</a></code>,
|
|
from which the <code><a href="../haxe/Unserializer.html">Unserializer</a></code> class can recreate the original representation.</p></td></tr><tr class="enum"><td width="200"><a href="../haxe/StackItem.html" title="haxe.StackItem">StackItem</a></td><td><p>Elements return by <code><a href="../haxe/CallStack.html">CallStack</a></code> methods.</p></td></tr><tr class="class"><td width="200"><a href="../haxe/Template.html" title="haxe.Template">Template</a></td><td><p>Template provides a basic templating mechanism to replace values in a source
|
|
String, and to have some basic logic.</p></td></tr><tr class="class"><td width="200"><a href="../haxe/Timer.html" title="haxe.Timer">Timer</a></td><td><p>The Timer class allows you to create asynchronous timers on platforms that
|
|
support events.</p></td></tr><tr class="abstract"><td width="200"><a href="../haxe/Ucs2.html" title="haxe.Ucs2">Ucs2</a></td><td><p>Cross platform UCS2 string API.</p></td></tr><tr class="class"><td width="200"><a href="../haxe/Unserializer.html" title="haxe.Unserializer">Unserializer</a></td><td><p>The <code><a href="../haxe/Unserializer.html">Unserializer</a></code> class is the complement to the <code><a href="../haxe/Serializer.html">Serializer</a></code> class. It parses
|
|
a serialization <code><a href="../String.html">String</a></code> and creates objects from the contained data.</p></td></tr><tr class="class"><td width="200"><a href="../haxe/Utf8.html" title="haxe.Utf8">Utf8</a></td><td><p>Since not all platforms guarantee that <code><a href="../String.html">String</a></code> always uses UTF-8 encoding, you
|
|
can use this cross-platform API to perform operations on such strings.</p></td></tr></tbody></table></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">© 2017 <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> |