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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578
							<!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: Video</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> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle"><div class="title">Video<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:ga58f078b3510384ef2d48e822bd3bc831" id="r_ga58f078b3510384ef2d48e822bd3bc831"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__VideoFunctions.html#ga58f078b3510384ef2d48e822bd3bc831">getDesktopResolution</a> ()</td></tr>
<tr class="separator:ga58f078b3510384ef2d48e822bd3bc831"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga65060b1793a5a5603ab877b73ddd5523" id="r_ga65060b1793a5a5603ab877b73ddd5523"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__VideoFunctions.html#ga65060b1793a5a5603ab877b73ddd5523">getDisplayDeviceList</a> ()</td></tr>
<tr class="separator:ga65060b1793a5a5603ab877b73ddd5523"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa5d0da3b94a5f25309b065ecbccedd51" id="r_gaa5d0da3b94a5f25309b065ecbccedd51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__VideoFunctions.html#gaa5d0da3b94a5f25309b065ecbccedd51">getRes</a> ()</td></tr>
<tr class="separator:gaa5d0da3b94a5f25309b065ecbccedd51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga798c806b15d9a5d39208a23f73be2a74" id="r_ga798c806b15d9a5d39208a23f73be2a74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__VideoFunctions.html#ga798c806b15d9a5d39208a23f73be2a74">getResolutionList</a> (devicename)</td></tr>
<tr class="separator:ga798c806b15d9a5d39208a23f73be2a74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaab71e1ac937c453b83fae0d7df17c028" id="r_gaab71e1ac937c453b83fae0d7df17c028"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__VideoFunctions.html#gaab71e1ac937c453b83fae0d7df17c028">getVideoDriverInfo</a> ()</td></tr>
<tr class="separator:gaab71e1ac937c453b83fae0d7df17c028"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga20c22aca4b0e3abb19a1305bb7339183" id="r_ga20c22aca4b0e3abb19a1305bb7339183"><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__VideoFunctions.html#ga20c22aca4b0e3abb19a1305bb7339183">isDeviceFullScreenOnly</a> (devicename)</td></tr>
<tr class="separator:ga20c22aca4b0e3abb19a1305bb7339183"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9806922c50384755de3f1336df1f34fe" id="r_ga9806922c50384755de3f1336df1f34fe"><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__VideoFunctions.html#ga9806922c50384755de3f1336df1f34fe">isFullScreen</a> ()</td></tr>
<tr class="separator:ga9806922c50384755de3f1336df1f34fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2fc9d85341efa4dc9414dbeceffb4ef0" id="r_ga2fc9d85341efa4dc9414dbeceffb4ef0"><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__VideoFunctions.html#ga2fc9d85341efa4dc9414dbeceffb4ef0">minimizeWindow</a> ()</td></tr>
<tr class="separator:ga2fc9d85341efa4dc9414dbeceffb4ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabcb80903aff5a566f57bc964eea70e07" id="r_gabcb80903aff5a566f57bc964eea70e07"><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__VideoFunctions.html#gabcb80903aff5a566f57bc964eea70e07">nextResolution</a> ()</td></tr>
<tr class="separator:gabcb80903aff5a566f57bc964eea70e07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga898ea00c293f6be45a2a1ee6dcd5c4f4" id="r_ga898ea00c293f6be45a2a1ee6dcd5c4f4"><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__VideoFunctions.html#ga898ea00c293f6be45a2a1ee6dcd5c4f4">prevResolution</a> ()</td></tr>
<tr class="separator:ga898ea00c293f6be45a2a1ee6dcd5c4f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae152d0f1e1c2357171eec4c89387dc3a" id="r_gae152d0f1e1c2357171eec4c89387dc3a"><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__VideoFunctions.html#gae152d0f1e1c2357171eec4c89387dc3a">restoreWindow</a> ()</td></tr>
<tr class="separator:gae152d0f1e1c2357171eec4c89387dc3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf14b03eb62b5505c56de10576b253abd" id="r_gaf14b03eb62b5505c56de10576b253abd"><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__VideoFunctions.html#gaf14b03eb62b5505c56de10576b253abd">setDisplayDevice</a> (deviceName, [width]?, [height]?, [bpp]?, [fullScreen]?)</td></tr>
<tr class="separator:gaf14b03eb62b5505c56de10576b253abd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga746402e9fc76f19e6aaf55615ec7ddab" id="r_ga746402e9fc76f19e6aaf55615ec7ddab"><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__VideoFunctions.html#ga746402e9fc76f19e6aaf55615ec7ddab">setRes</a> (width, height, bpp)</td></tr>
<tr class="separator:ga746402e9fc76f19e6aaf55615ec7ddab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7559b06ab9b2e04270e8ef3f2c70c4fa" id="r_ga7559b06ab9b2e04270e8ef3f2c70c4fa"><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__VideoFunctions.html#ga7559b06ab9b2e04270e8ef3f2c70c4fa">setScreenMode</a> (width, height, bpp, fullScreen)</td></tr>
<tr class="separator:ga7559b06ab9b2e04270e8ef3f2c70c4fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabdfb7edd26670dc943e86a866b75c9a7" id="r_gabdfb7edd26670dc943e86a866b75c9a7"><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__VideoFunctions.html#gabdfb7edd26670dc943e86a866b75c9a7">setVerticalSync</a> (enable)</td></tr>
<tr class="separator:gabdfb7edd26670dc943e86a866b75c9a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga243e167942f4b98c092c981545295f0e" id="r_ga243e167942f4b98c092c981545295f0e"><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__VideoFunctions.html#ga243e167942f4b98c092c981545295f0e">switchBitDepth</a> ()</td></tr>
<tr class="separator:ga243e167942f4b98c092c981545295f0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2600061433257d961bdc30e244998ff6" id="r_ga2600061433257d961bdc30e244998ff6"><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__VideoFunctions.html#ga2600061433257d961bdc30e244998ff6">toggleFullScreen</a> ()</td></tr>
<tr class="separator:ga2600061433257d961bdc30e244998ff6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga172eabb8a069572ecc88304c1d00fc68" id="r_ga172eabb8a069572ecc88304c1d00fc68"><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__VideoFunctions.html#ga172eabb8a069572ecc88304c1d00fc68">videoSetGammaCorrection</a> (gamma)</td></tr>
<tr class="separator:ga172eabb8a069572ecc88304c1d00fc68"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga1011e94405c748d382dc1edfedeca59d" id="r_ga1011e94405c748d382dc1edfedeca59d"><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__VideoFunctions.html#ga1011e94405c748d382dc1edfedeca59d">getVerticalSync</a></td></tr>
<tr class="separator:ga1011e94405c748d382dc1edfedeca59d"><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="ga58f078b3510384ef2d48e822bd3bc831" name="ga58f078b3510384ef2d48e822bd3bc831"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga58f078b3510384ef2d48e822bd3bc831">&#9670;&#160;</a></span>getDesktopResolution()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getDesktopResolution </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getDesktopResolution function to determine the current resolution of the desktop (not the application). To get the current resolution of a windowed display of the torque game engine, simply examine the global variable '$pref::Video::resolution'. </p><dl class="section return"><dt>Returns</dt><dd>Returns a string containing the current desktop resolution, including the width height and the current bits per pixel. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__VideoFunctions.html#ga65060b1793a5a5603ab877b73ddd5523">getDisplayDeviceList</a>, <a class="el" href="group__VideoFunctions.html#ga798c806b15d9a5d39208a23f73be2a74">getResolutionList</a>, <a class="el" href="group__VideoFunctions.html#gabcb80903aff5a566f57bc964eea70e07">nextResolution</a>, <a class="el" href="group__VideoFunctions.html#ga898ea00c293f6be45a2a1ee6dcd5c4f4">prevResolution</a>, <a class="el" href="group__VideoFunctions.html#gaf14b03eb62b5505c56de10576b253abd">setDisplayDevice</a>, <a class="el" href="group__VideoFunctions.html#ga746402e9fc76f19e6aaf55615ec7ddab">setRes</a>, <a class="el" href="group__VideoFunctions.html#ga7559b06ab9b2e04270e8ef3f2c70c4fa">setScreenMode</a>, <a class="el" href="group__VideoFunctions.html#ga243e167942f4b98c092c981545295f0e">switchBitDepth</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getDisplayDeviceList </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getDisplayDeviceList function to get a list of valid display devices. </p><dl class="section return"><dt>Returns</dt><dd>Returns a tab separated list of valid display devices. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__VideoFunctions.html#ga58f078b3510384ef2d48e822bd3bc831">getDesktopResolution</a>, <a class="el" href="group__VideoFunctions.html#ga798c806b15d9a5d39208a23f73be2a74">getResolutionList</a>, <a class="el" href="group__VideoFunctions.html#ga746402e9fc76f19e6aaf55615ec7ddab">setRes</a>, <a class="el" href="group__VideoFunctions.html#ga7559b06ab9b2e04270e8ef3f2c70c4fa">setScreenMode</a>, <a class="el" href="group__VideoFunctions.html#ga243e167942f4b98c092c981545295f0e">switchBitDepth</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getRes </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the width, height, and bitdepth of the screen. </p><dl class="section return"><dt>Returns</dt><dd>A string formatted as &lt;width&gt; &lt;height&gt; &lt;bitdepth&gt;\ </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getResolutionList </td>
          <td>(</td>
          <td class="paramtype">devicename&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getResolutionList function to get a semicolon separated list of legal resolutions for a specified device. Resolutions are always in the form: width height bpp, where width and height are in pixels and bpp is bits-per-pixel. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">deviceName</td><td>A string containing a supported display device. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a tab separated list of valid display resolutions for devicename. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__VideoFunctions.html#ga58f078b3510384ef2d48e822bd3bc831">getDesktopResolution</a>, <a class="el" href="group__VideoFunctions.html#ga65060b1793a5a5603ab877b73ddd5523">getDisplayDeviceList</a>, <a class="el" href="group__VideoFunctions.html#ga746402e9fc76f19e6aaf55615ec7ddab">setRes</a>, <a class="el" href="group__VideoFunctions.html#ga7559b06ab9b2e04270e8ef3f2c70c4fa">setScreenMode</a>, <a class="el" href="group__VideoFunctions.html#ga243e167942f4b98c092c981545295f0e">switchBitDepth</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getVideoDriverInfo </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getVideoDriverInfo function to dump information on the video driver to the console. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isDeviceFullScreenOnly </td>
          <td>(</td>
          <td class="paramtype">devicename&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the isDeviceFullScreenOnly function to determine if the device specified in devicename is for full screen display only, or whether it supports windowed mode too. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">deviceName</td><td>A string containing a supported display device. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the device can only display full scree, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__VideoFunctions.html#ga798c806b15d9a5d39208a23f73be2a74">getResolutionList</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isFullScreen </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the isFullScreen function to determine if the current application is displayed in full-screen mode. </p><dl class="section return"><dt>Returns</dt><dd>Returns true if the engine is currently displaying full-screen, otherwise returns false </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> minimizeWindow </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Minimize the game window </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> nextResolution </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the nextResolution function to switch to the next valid (higher) resolution for the current display device. </p><dl class="section return"><dt>Returns</dt><dd>Returns true if switch was successful, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__VideoFunctions.html#ga58f078b3510384ef2d48e822bd3bc831">getDesktopResolution</a>, <a class="el" href="group__VideoFunctions.html#ga898ea00c293f6be45a2a1ee6dcd5c4f4">prevResolution</a>, <a class="el" href="group__VideoFunctions.html#ga798c806b15d9a5d39208a23f73be2a74">getResolutionList</a>, <a class="el" href="group__VideoFunctions.html#ga746402e9fc76f19e6aaf55615ec7ddab">setRes</a>, <a class="el" href="group__VideoFunctions.html#ga7559b06ab9b2e04270e8ef3f2c70c4fa">setScreenMode</a>, <a class="el" href="group__VideoFunctions.html#ga243e167942f4b98c092c981545295f0e">switchBitDepth</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> prevResolution </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the prevResolution function to switch to the previous valid (lower) resolution for the current display device. </p><dl class="section return"><dt>Returns</dt><dd>Returns true if switch was successful, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__VideoFunctions.html#ga58f078b3510384ef2d48e822bd3bc831">getDesktopResolution</a>, <a class="el" href="group__VideoFunctions.html#gabcb80903aff5a566f57bc964eea70e07">nextResolution</a>, <a class="el" href="group__VideoFunctions.html#ga798c806b15d9a5d39208a23f73be2a74">getResolutionList</a>, <a class="el" href="group__VideoFunctions.html#ga746402e9fc76f19e6aaf55615ec7ddab">setRes</a>, <a class="el" href="group__VideoFunctions.html#ga7559b06ab9b2e04270e8ef3f2c70c4fa">setScreenMode</a>, <a class="el" href="group__VideoFunctions.html#ga243e167942f4b98c092c981545295f0e">switchBitDepth</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> restoreWindow </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Restore the game window </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setDisplayDevice </td>
          <td>(</td>
          <td class="paramtype">deviceName&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[width] ?&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[height] ?&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[bpp] ?&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[fullScreen] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the setDisplayDevice function to select a display device and to set the initial width, height and bits-per-pixel (bpp) setting, as well as whether the application is windowed or in fullScreen. If no resolution information is specified, the first legal resolution on this device's resolution list will be used. Furthermore, for each optional argument if the subsequent arguments are not specified, the first matching case will be used. Lastly, if the application is not told to display in full screen, but the device only supports windowed, the application will be forced into windowed mode. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">deviceName</td><td>A supported display device name. </td></tr>
    <tr><td class="paramname">width</td><td>Resolution width in pixels. </td></tr>
    <tr><td class="paramname">height</td><td>Resolution height in pixels. </td></tr>
    <tr><td class="paramname">bpp</td><td>Pixel resolution in bits-per-pixel (16 or 32). </td></tr>
    <tr><td class="paramname">fullScreen</td><td>A boolean value. If set to true, the application displays in full- screen mode, otherwise it will attempt to display in windowed mode. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__VideoFunctions.html#ga58f078b3510384ef2d48e822bd3bc831">getDesktopResolution</a>, <a class="el" href="group__VideoFunctions.html#ga65060b1793a5a5603ab877b73ddd5523">getDisplayDeviceList</a>, <a class="el" href="group__VideoFunctions.html#ga798c806b15d9a5d39208a23f73be2a74">getResolutionList</a>, <a class="el" href="group__VideoFunctions.html#gabcb80903aff5a566f57bc964eea70e07">nextResolution</a>, <a class="el" href="group__VideoFunctions.html#ga898ea00c293f6be45a2a1ee6dcd5c4f4">prevResolution</a>, <a class="el" href="group__VideoFunctions.html#ga746402e9fc76f19e6aaf55615ec7ddab">setRes</a>, <a class="el" href="group__VideoFunctions.html#ga7559b06ab9b2e04270e8ef3f2c70c4fa">setScreenMode</a>, <a class="el" href="group__VideoFunctions.html#ga243e167942f4b98c092c981545295f0e">switchBitDepth</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setRes </td>
          <td>(</td>
          <td class="paramtype">width&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">height&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bpp&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the setRes function to set the screen to the specified width, height, and bits-per-pixel (bpp). </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">width</td><td>Resolution width in pixels. </td></tr>
    <tr><td class="paramname">height</td><td>Resolution height in pixels. </td></tr>
    <tr><td class="paramname">bpp</td><td>Pixel resolution in bits-per-pixel (16 or 32). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if successful, otherwise false. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__VideoFunctions.html#ga58f078b3510384ef2d48e822bd3bc831">getDesktopResolution</a>, <a class="el" href="group__VideoFunctions.html#ga65060b1793a5a5603ab877b73ddd5523">getDisplayDeviceList</a>, <a class="el" href="group__VideoFunctions.html#ga798c806b15d9a5d39208a23f73be2a74">getResolutionList</a>, <a class="el" href="group__VideoFunctions.html#gabcb80903aff5a566f57bc964eea70e07">nextResolution</a>, <a class="el" href="group__VideoFunctions.html#ga898ea00c293f6be45a2a1ee6dcd5c4f4">prevResolution</a>, <a class="el" href="group__VideoFunctions.html#gaf14b03eb62b5505c56de10576b253abd">setDisplayDevice</a>, <a class="el" href="group__VideoFunctions.html#ga7559b06ab9b2e04270e8ef3f2c70c4fa">setScreenMode</a>, <a class="el" href="group__VideoFunctions.html#ga243e167942f4b98c092c981545295f0e">switchBitDepth</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setScreenMode </td>
          <td>(</td>
          <td class="paramtype">width&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">height&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bpp&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">fullScreen&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the setScreenMode function to set the screen to the specified width, height, and bits-per-pixel (bpp). Additionally, if fullScreen is set to true the engine will attempt to display the application in full-screen mode, otherwise it will attempt to used windowed mode. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">width</td><td>Resolution width in pixels. </td></tr>
    <tr><td class="paramname">height</td><td>Resolution height in pixels. </td></tr>
    <tr><td class="paramname">bpp</td><td>Pixel resolution in bits-per-pixel (16 or 32). </td></tr>
    <tr><td class="paramname">fullScreen</td><td>A boolean value. If set to true, the application displays in full- screen mode, otherwise it will attempt to display in windowed mode. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if successful, otherwise false. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__VideoFunctions.html#ga58f078b3510384ef2d48e822bd3bc831">getDesktopResolution</a>, <a class="el" href="group__VideoFunctions.html#ga65060b1793a5a5603ab877b73ddd5523">getDisplayDeviceList</a>, <a class="el" href="group__VideoFunctions.html#ga798c806b15d9a5d39208a23f73be2a74">getResolutionList</a>, <a class="el" href="group__VideoFunctions.html#gabcb80903aff5a566f57bc964eea70e07">nextResolution</a>, <a class="el" href="group__VideoFunctions.html#ga898ea00c293f6be45a2a1ee6dcd5c4f4">prevResolution</a>, <a class="el" href="group__VideoFunctions.html#gaf14b03eb62b5505c56de10576b253abd">setDisplayDevice</a>, <a class="el" href="group__VideoFunctions.html#ga746402e9fc76f19e6aaf55615ec7ddab">setRes</a>, <a class="el" href="group__VideoFunctions.html#ga243e167942f4b98c092c981545295f0e">switchBitDepth</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setVerticalSync </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 setVerticalSync function to force the framerate to sync up with the vertical refresh rate. This is used to reduce excessive swapping/rendering. There is generally no purpose in rendering any faster than the monitor will support. Those extra 'ergs' can be used for something else </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 only swap front and back buffers on or before a vertical refresh pass. </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="ga243e167942f4b98c092c981545295f0e" name="ga243e167942f4b98c092c981545295f0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga243e167942f4b98c092c981545295f0e">&#9670;&#160;</a></span>switchBitDepth()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> switchBitDepth </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the switchBitDepth function to toggle the bits-per-pixel (bpp) pixel resolution between 16 and 32. </p><dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__VideoFunctions.html#ga58f078b3510384ef2d48e822bd3bc831">getDesktopResolution</a>, <a class="el" href="group__VideoFunctions.html#ga65060b1793a5a5603ab877b73ddd5523">getDisplayDeviceList</a>, <a class="el" href="group__VideoFunctions.html#ga798c806b15d9a5d39208a23f73be2a74">getResolutionList</a>, <a class="el" href="group__VideoFunctions.html#gabcb80903aff5a566f57bc964eea70e07">nextResolution</a>, <a class="el" href="group__VideoFunctions.html#ga898ea00c293f6be45a2a1ee6dcd5c4f4">prevResolution</a>, <a class="el" href="group__VideoFunctions.html#gaf14b03eb62b5505c56de10576b253abd">setDisplayDevice</a>, <a class="el" href="group__VideoFunctions.html#ga746402e9fc76f19e6aaf55615ec7ddab">setRes</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> toggleFullScreen </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the toggleFullScreen function to switch from full-screen mode to windowed, or vice versa. </p><dl class="section return"><dt>Returns</dt><dd>Returns true on success, false otherwise </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> videoSetGammaCorrection </td>
          <td>(</td>
          <td class="paramtype">gamma&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the videoSetGammaCorrection function to adjust the gamma for the video card. The card will revert to it's default gamma setting as long as the application closes normally </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">gamma</td><td>A floating-point value between 0.0 and 1.0. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga1011e94405c748d382dc1edfedeca59d" name="ga1011e94405c748d382dc1edfedeca59d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1011e94405c748d382dc1edfedeca59d">&#9670;&#160;</a></span>getVerticalSync</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getVerticalSync</td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">{</div>
<div class="line">    <span class="keywordflow">return</span>(Video::getVerticalSync())</div>
</div><!-- fragment --><p>Use the getVerticalSync function to determine if the application's framerate is currently synchronized to the vertical refresh rate. </p><dl class="section return"><dt>Returns</dt><dd>Returns true if Vertical sync is enabled, 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>