TorqueEngine
/
Torque2D
зеркало из https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
							<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TorqueScript Reference: Windows Platform</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="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.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="projectalign">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Windows Platform<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad08310184aadd784eca477fa3cf7bae4" id="r_gad08310184aadd784eca477fa3cf7bae4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WindowsPlatform.html#gad08310184aadd784eca477fa3cf7bae4">enableWinConsole</a> (enable)</td></tr>
<tr class="separator:gad08310184aadd784eca477fa3cf7bae4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad8a11f7b98fc8c731237ca27276d2696" id="r_gad8a11f7b98fc8c731237ca27276d2696"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WindowsPlatform.html#gad8a11f7b98fc8c731237ca27276d2696">getWinNTVersion</a> ()</td></tr>
<tr class="separator:gad8a11f7b98fc8c731237ca27276d2696"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac64021511f8b9485b4f0a1538100ba08" id="r_gac64021511f8b9485b4f0a1538100ba08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WindowsPlatform.html#gac64021511f8b9485b4f0a1538100ba08">GLEnableLogging</a> (enable)</td></tr>
<tr class="separator:gac64021511f8b9485b4f0a1538100ba08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga21ea2cea896b6be781a1e0883647d346" id="r_ga21ea2cea896b6be781a1e0883647d346"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WindowsPlatform.html#ga21ea2cea896b6be781a1e0883647d346">GLEnableMetrics</a> (enable)</td></tr>
<tr class="separator:ga21ea2cea896b6be781a1e0883647d346"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga30e35b88579647e6a225baad8b0453a1" id="r_ga30e35b88579647e6a225baad8b0453a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WindowsPlatform.html#ga30e35b88579647e6a225baad8b0453a1">GLEnableOutline</a> (bool)</td></tr>
<tr class="separator:ga30e35b88579647e6a225baad8b0453a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9291558a3a28c778072fb08746a14fc6" id="r_ga9291558a3a28c778072fb08746a14fc6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WindowsPlatform.html#ga9291558a3a28c778072fb08746a14fc6">mathInit</a> (extension)</td></tr>
<tr class="separator:ga9291558a3a28c778072fb08746a14fc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d76de6f2f895f160850ee57f551fd65" id="r_ga4d76de6f2f895f160850ee57f551fd65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WindowsPlatform.html#ga4d76de6f2f895f160850ee57f551fd65">openFolder</a> (folder)</td></tr>
<tr class="separator:ga4d76de6f2f895f160850ee57f551fd65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae9fdb47094498699bfc774a4359ddfc0" id="r_gae9fdb47094498699bfc774a4359ddfc0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WindowsPlatform.html#gae9fdb47094498699bfc774a4359ddfc0">shellExecute</a> (executable, [args]?, [directory]?)</td></tr>
<tr class="separator:gae9fdb47094498699bfc774a4359ddfc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf1c6aefb8e094edb8b516b3522ca9486" id="r_gaf1c6aefb8e094edb8b516b3522ca9486"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WindowsPlatform.html#gaf1c6aefb8e094edb8b516b3522ca9486">shellExecuteBlocking</a> (executable, [args]?, [directory]?)</td></tr>
<tr class="separator:gaf1c6aefb8e094edb8b516b3522ca9486"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad08310184aadd784eca477fa3cf7bae4" name="gad08310184aadd784eca477fa3cf7bae4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad08310184aadd784eca477fa3cf7bae4">&#9670;&#160;</a></span>enableWinConsole()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> enableWinConsole </td>
          <td>(</td>
          <td class="paramtype">enable&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the enableWinConsole function to tell TGB to create an external console window, either as a separate DOS window or as a new window under OSX/Linux/*NIX. Subsequent calls to this function do nothing. Only one external console is allowed </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>A boolean. If this value is set to true, a new console window will be created. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>

</div>
</div>
<a id="gad8a11f7b98fc8c731237ca27276d2696" name="gad8a11f7b98fc8c731237ca27276d2696"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad8a11f7b98fc8c731237ca27276d2696">&#9670;&#160;</a></span>getWinNTVersion()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> getWinNTVersion </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="gac64021511f8b9485b4f0a1538100ba08" name="gac64021511f8b9485b4f0a1538100ba08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac64021511f8b9485b4f0a1538100ba08">&#9670;&#160;</a></span>GLEnableLogging()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> GLEnableLogging </td>
          <td>(</td>
          <td class="paramtype">enable&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the GLEnableLogging function to enable/disable the gathering of OpenGL metrics. For this to work, the engine must have been compiled with either TORQUE_DEBUG or INTERNAL_RELEASE defined. Always be sure to do a disable after an enable to flush the last log data to the log file. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>A boolean value. If set to true, the engine will gather various OpenGL metrics and dump them to a file named gl_log.txt. If set to false, logging is stopped, the last writes to the log are flushed, and the file is closed. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__WindowsPlatform.html#ga21ea2cea896b6be781a1e0883647d346">GLEnableMetrics</a>, metrics </dd></dl>

</div>
</div>
<a id="ga21ea2cea896b6be781a1e0883647d346" name="ga21ea2cea896b6be781a1e0883647d346"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga21ea2cea896b6be781a1e0883647d346">&#9670;&#160;</a></span>GLEnableMetrics()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> GLEnableMetrics </td>
          <td>(</td>
          <td class="paramtype">enable&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the GLEnableMetrics function to enable or disable logging of OpenGL texture and video metrics. For this to work, the engine must have been compiled with either TORQUE_DEBUG or INTERNAL_RELEASE defined. Use the metrics function to get at this information. Also, once this feature is enabled, the following globals will be available for inspection/examination: &lt;OpenGL::triCount0 ? Terrain triangles, OpenGL::triCount1? DIF triangles, OpenGL::triCount2 ? DTS triangles, OpenGL::triCount3 ? Uncategorized triangles, OpenGL::primCount0 - Terrain primitives, OpenGL::primCount1 ? DIF primitives, OpenGL::primCount2 ? DTS primitives, OpenGL::primCount3 ? Uncategorized primitives&gt; </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>A boolean value. When this is set to true, texture and video (triangles and primitives) logging is enabled and dumped as part of calls to certain metrics. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__WindowsPlatform.html#gac64021511f8b9485b4f0a1538100ba08">GLEnableLogging</a>, metrics </dd></dl>

</div>
</div>
<a id="ga30e35b88579647e6a225baad8b0453a1" name="ga30e35b88579647e6a225baad8b0453a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga30e35b88579647e6a225baad8b0453a1">&#9670;&#160;</a></span>GLEnableOutline()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> GLEnableOutline </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Enables outlines with OpenGL </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>Boolean value representing whether or not outlines should be enabled. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No Return Value. </dd></dl>

</div>
</div>
<a id="ga9291558a3a28c778072fb08746a14fc6" name="ga9291558a3a28c778072fb08746a14fc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9291558a3a28c778072fb08746a14fc6">&#9670;&#160;</a></span>mathInit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> mathInit </td>
          <td>(</td>
          <td class="paramtype">extension&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the MathInit function to install a specified math extensions, or to detect and enable all extensions. Generally speaking, the best extension choice is to used detect. This will automatically detected and enable all extensions supported by the current processor. It will also print out a list of the extension that were enabled to the console </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">extension</td><td>Can be any of these:detect ? Detect all supported extensions and enable.C - Enable standard C extensions.FPU - Enable floating-point-unit extensions.MMX - Enable Intel MMX extensions.3DNOW - Enable AMD 3DNOW extensions.SSE - Enable Intel SSE extensions. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>

</div>
</div>
<a id="ga4d76de6f2f895f160850ee57f551fd65" name="ga4d76de6f2f895f160850ee57f551fd65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d76de6f2f895f160850ee57f551fd65">&#9670;&#160;</a></span>openFolder()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> openFolder </td>
          <td>(</td>
          <td class="paramtype">folder&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Opens a folder of the platform </p>

</div>
</div>
<a id="gae9fdb47094498699bfc774a4359ddfc0" name="gae9fdb47094498699bfc774a4359ddfc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae9fdb47094498699bfc774a4359ddfc0">&#9670;&#160;</a></span>shellExecute()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> shellExecute </td>
          <td>(</td>
          <td class="paramtype">executable&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[args] ?&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[directory] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Executes a process </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">executable</td><td>The program to execute </td></tr>
    <tr><td class="paramname">args</td><td>Arguments to pass to the executable </td></tr>
    <tr><td class="paramname">directory</td><td>The directory in which the program is located </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise </dd></dl>

</div>
</div>
<a id="gaf1c6aefb8e094edb8b516b3522ca9486" name="gaf1c6aefb8e094edb8b516b3522ca9486"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf1c6aefb8e094edb8b516b3522ca9486">&#9670;&#160;</a></span>shellExecuteBlocking()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int shellExecuteBlocking </td>
          <td>(</td>
          <td class="paramtype">executable&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[args] ?&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[directory] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">executable</td><td>The program to execute </td></tr>
    <tr><td class="paramname">args</td><td>Arguments to pass to the executable </td></tr>
    <tr><td class="paramname">directory</td><td>The directory in which the program is located </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>