UNPKG

jsge

Version:

Javascript Game Engine

577 lines (119 loc) 7.78 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="expires" content="Wen, 05 Jun 2024 07:01:00 GMT"> <title>JSDoc: Class: RenderLoop</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="stage-title">Class: RenderLoop</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>RenderLoop</h2> <div class="class-description">Class represents the render loop, on each time stage start, a new RenderLoop class instance created, after stage stop, RenderLoop stops and its instance removed</div> </header> <article> <div class="container-overview"> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_RenderLoop.js.html">base/RenderLoop.js</a>, <a href="base_RenderLoop.js.html#line26">line 26</a> </li></ul></dd> <dt class="tag-see">See:</dt> <dd class="tag-see"> <ul> <li><a href="IRender.html">IRender</a> a part of iRender</li> </ul> </dd> </dl> </div> <!-- <h3 class="subsection-title">Classes</h3> <dl> <dt><a href="RenderLoop.html">RenderLoop</a></dt> <dd></dd> </dl> --> <h3 class="subsection-title">Members</h3> <h4 class="name" id="addEventListener"><span class="type-signature"></span>addEventListener<span class="type-signature"></span></h4> <!----> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_RenderLoop.js.html">base/RenderLoop.js</a>, <a href="base_RenderLoop.js.html#line218">line 218</a> </li></ul></dd> </dl> <h4 class="name" id="emit"><span class="type-signature"></span>emit<span class="type-signature"></span></h4> <!----> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_RenderLoop.js.html">base/RenderLoop.js</a>, <a href="base_RenderLoop.js.html#line237">line 237</a> </li></ul></dd> </dl> <h4 class="name" id="removeEventListener"><span class="type-signature"></span>removeEventListener<span class="type-signature"></span></h4> <!----> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_RenderLoop.js.html">base/RenderLoop.js</a>, <a href="base_RenderLoop.js.html#line228">line 228</a> </li></ul></dd> </dl> <h4 class="name" id="renderLoopDebug"><span class="type-signature"></span>renderLoopDebug<span class="type-signature"></span></h4> <!----> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_RenderLoop.js.html">base/RenderLoop.js</a>, <a href="base_RenderLoop.js.html#line81">line 81</a> </li></ul></dd> </dl> <h4 class="name" id="stageData"><span class="type-signature"></span>stageData<span class="type-signature"></span></h4> <!----> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_RenderLoop.js.html">base/RenderLoop.js</a>, <a href="base_RenderLoop.js.html#line74">line 74</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="render"><span class="type-signature">(async) </span>render<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="base_RenderLoop.js.html">base/RenderLoop.js</a>, <a href="base_RenderLoop.js.html#line164">line 164</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.&lt;void></span> </dd> </dl> </article> </section> </div> <nav> <div class="switcher"><ul><li class="active"><a href="/">1.5.9</a></li></div> <h2><a href="/">Home</a></h2><h3>Classes</h3><ul><li><a href="DrawCircleObject.html">DrawCircleObject</a></li><li><a href="DrawConusObject.html">DrawConusObject</a></li><li><a href="DrawImageObject.html">DrawImageObject</a></li><li><a href="DrawLineObject.html">DrawLineObject</a></li><li><a href="DrawObjectFactory.html">DrawObjectFactory</a></li><li><a href="DrawPolygonObject.html">DrawPolygonObject</a></li><li><a href="DrawRectObject.html">DrawRectObject</a></li><li><a href="DrawShapeObject.html">DrawShapeObject</a></li><li><a href="DrawTextObject.html">DrawTextObject</a></li><li><a href="DrawTiledLayer.html">DrawTiledLayer</a></li><li><a href="GameStage.html">GameStage</a></li><li><a href="GameStageData.html">GameStageData</a></li><li><a href="IExtension.html">IExtension</a></li><li><a href="INetwork.html">INetwork</a></li><li><a href="IRender.html">IRender</a></li><li><a href="ISystem.html">ISystem</a></li><li><a href="ISystemAudio.html">ISystemAudio</a></li><li><a href="RenderLoop.html">RenderLoop</a></li><li><a href="RenderLoopDebug.html">RenderLoopDebug</a></li><li><a href="System.html">System</a></li><li><a href="SystemSettings.html">SystemSettings</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-application_scheme.html">Application Scheme</a></li><li><a href="tutorial-assets_manager.html">Assets Manager</a></li><li><a href="tutorial-common_issues.html">Common Issues</a></li><li><a href="tutorial-how_to_add_and_use_audio.html">How to add and use audio</a></li><li><a href="tutorial-how_to_do_animations.html">How to Create Animations</a></li><li><a href="tutorial-how_to_load_and_use_tilemaps.html">How to Load and Use Tilemaps</a></li><li><a href="tutorial-quick_start.html">Quick Start</a></li><li><a href="tutorial-spine_animations.html">How to Add Spine Animations</a></li><li><a href="tutorial-stages_lifecycle.html">Stages Lifecycle</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Wed Jun 18 2025 06:53:54 GMT+0000 (Coordinated Universal Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>