diff options
Diffstat (limited to 'namespaceyage.html')
| -rw-r--r-- | namespaceyage.html | 94 |
1 files changed, 46 insertions, 48 deletions
diff --git a/namespaceyage.html b/namespaceyage.html index c7c94fb1..b71bb9c9 100644 --- a/namespaceyage.html +++ b/namespaceyage.html @@ -8,13 +8,6 @@ <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="navtree.css" rel="stylesheet" type="text/css"/> -<script type="text/javascript" src="resize.js"></script> -<script type="text/javascript" src="navtree.js"></script> -<script type="text/javascript"> - $(document).ready(initResizable); - $(window).load(resizeHeight); -</script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> @@ -28,6 +21,7 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> + <td id="projectlogo"><img alt="Logo" src="yage.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">YAGE  <span id="projectnumber">v0.1.4.0</span> @@ -74,21 +68,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <li><a href="namespacemembers.html"><span>Namespace Members</span></a></li> </ul> </div> -</div><!-- top --> -<div id="side-nav" class="ui-resizable side-nav-resizable"> - <div id="nav-tree"> - <div id="nav-tree-contents"> - <div id="nav-sync" class="sync"></div> - </div> - </div> - <div id="splitbar" style="-moz-user-select:none;" - class="ui-resizable-handle"> - </div> -</div> -<script type="text/javascript"> -$(document).ready(function(){initNavTree('namespaceyage.html','');}); -</script> -<div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" @@ -103,6 +82,7 @@ $(document).ready(function(){initNavTree('namespaceyage.html','');}); </iframe> </div> +</div><!-- top --> <div class="header"> <div class="summary"> <a href="#namespaces">Namespaces</a> | @@ -115,7 +95,7 @@ $(document).ready(function(){initNavTree('namespaceyage.html','');}); </div><!--header--> <div class="contents"> -<p>Project namespace. +<p>Core includes. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> @@ -135,8 +115,6 @@ Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1IoManager.html">IoManager</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Logger.html">Logger</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><h2><a class="el" href="classyage_1_1Logger.html" title="Logger">Logger</a></h2> - <a href="classyage_1_1Logger.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1LogMessage.html">LogMessage</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> @@ -160,6 +138,21 @@ Classes</h2></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structyage_1_1Vertex.html">Vertex</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Engine.html">Engine</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Main engine class that contains a systems, the main loop and the update function that updates all the systems. <a href="classyage_1_1Engine.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Entity.html">Entity</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classyage_1_1Entity.html" title="Entity convenience class. ">Entity</a> convenience class. <a href="classyage_1_1Entity.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1EntityManager.html">EntityManager</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Manages entities in a space. <a href="classyage_1_1EntityManager.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Space.html">Space</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classyage_1_1Space.html" title="Space that keeps track of all the entities, componenets and runs the systems on the data to update th...">Space</a> that keeps track of all the entities, componenets and runs the systems on the data to update them. <a href="classyage_1_1Space.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1System.html">System</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classyage_1_1System.html" title="System interface for the different systems in the engine. ">System</a> interface for the different systems in the engine. <a href="classyage_1_1System.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Matrix.html">Matrix</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base <a class="el" href="classyage_1_1Matrix.html" title="Base Matrix class used by other similar classes. ">Matrix</a> class used by other similar classes. <a href="classyage_1_1Matrix.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> @@ -241,6 +234,7 @@ Enumerations</h2></td></tr>   <a class="el" href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788a19da7170bea36556dde582519795f3fc">LogLevel::FATAL</a> <br/> }</td></tr> +<tr class="memdesc:a4ac616fa26af17775ed558a4c08e4788"><td class="mdescLeft"> </td><td class="mdescRight">Different log levels that can be assigned to each message sent to the Logger. <a href="namespaceyage.html#a4ac616fa26af17775ed558a4c08e4788">More...</a><br/></td></tr> <tr class="separator:a4ac616fa26af17775ed558a4c08e4788"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a09d41deeced5fca5df9dc680c9e77c38"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceyage.html#a09d41deeced5fca5df9dc680c9e77c38">WindowFlags</a> : unsigned { <a class="el" href="namespaceyage.html#a09d41deeced5fca5df9dc680c9e77c38a7c4273d3feb1dc60a55a74c37c3fddd6">SHOWN</a> = 0x1, <a class="el" href="namespaceyage.html#a09d41deeced5fca5df9dc680c9e77c38af7a4d995b268c416a6e01b8dc1555648">HIDDEN</a> = 0x2, @@ -446,20 +440,21 @@ Functions</h2></td></tr> <tr class="memitem:a7ed614bc9d3e8b9f3f8d32b6a7ff28eb"><td class="memTemplParams" colspan="2">template<int M, int N, class T > </td></tr> <tr class="memitem:a7ed614bc9d3e8b9f3f8d32b6a7ff28eb"><td class="memTemplItemLeft" align="right" valign="top">std::ostream & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceyage.html#a7ed614bc9d3e8b9f3f8d32b6a7ff28eb">operator<<</a> (std::ostream &os, const <a class="el" href="classyage_1_1Matrix.html">Matrix</a>< M, N, T > &mat)</td></tr> <tr class="separator:a7ed614bc9d3e8b9f3f8d32b6a7ff28eb"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a0bd2fedcbe862fdea1ea54b6b7d49bec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceyage.html#a0bd2fedcbe862fdea1ea54b6b7d49bec">glfwErrorCallback</a> (int, const char *description)</td></tr> -<tr class="separator:a0bd2fedcbe862fdea1ea54b6b7d49bec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae53246342d5b0371f300336cbc6595a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceyage.html#ae53246342d5b0371f300336cbc6595a3">glfwErrorCallback</a> (int, const char *)</td></tr> +<tr class="separator:ae53246342d5b0371f300336cbc6595a3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4fc8b4d2a19d4c7f7f1bd42a788827ce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceyage.html#a4fc8b4d2a19d4c7f7f1bd42a788827ce">init</a> ()</td></tr> -<tr class="memdesc:a4fc8b4d2a19d4c7f7f1bd42a788827ce"><td class="mdescLeft"> </td><td class="mdescRight">Initializes yage. <a href="#a4fc8b4d2a19d4c7f7f1bd42a788827ce">More...</a><br/></td></tr> +<tr class="memdesc:a4fc8b4d2a19d4c7f7f1bd42a788827ce"><td class="mdescLeft"> </td><td class="mdescRight">Initializes YAGE. <a href="#a4fc8b4d2a19d4c7f7f1bd42a788827ce">More...</a><br/></td></tr> <tr class="separator:a4fc8b4d2a19d4c7f7f1bd42a788827ce"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac9d8c7327204686b3c86f4ab48672618"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceyage.html#ac9d8c7327204686b3c86f4ab48672618">quit</a> ()</td></tr> -<tr class="memdesc:ac9d8c7327204686b3c86f4ab48672618"><td class="mdescLeft"> </td><td class="mdescRight">Quit and cleanup yage. <a href="#ac9d8c7327204686b3c86f4ab48672618">More...</a><br/></td></tr> +<tr class="memdesc:ac9d8c7327204686b3c86f4ab48672618"><td class="mdescLeft"> </td><td class="mdescRight">Quit and cleanup YAGE. <a href="#ac9d8c7327204686b3c86f4ab48672618">More...</a><br/></td></tr> <tr class="separator:ac9d8c7327204686b3c86f4ab48672618"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>Project namespace. </p> -<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>remove the include to make compilation faster </dd></dl> -<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd>think of removing this, by, for example, using a pointer This could be more efficient when copying the texture out of the spritesheet.</dd></dl> -<p>Avoids collision as all the classes and global functions are wrapped in. it. </p> +<div class="textblock"><p>Core includes. </p> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>remove the include to make compilation faster </dd></dl> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>think of removing this, by, for example, using a pointer This could be more efficient when copying the texture out of the spritesheet.</dd></dl> +<p>Data structues useful for the game engine and games developed by it Math templated implementation of matrices and operations on them. Physics implementation however, Box2D Rendering implementations for spritebatching and default shapes. <a class="el" href="classyage_1_1Engine.html" title="Main engine class that contains a systems, the main loop and the update function that updates all the...">Engine</a> that includes a <a class="el" href="classyage_1_1Entity.html" title="Entity convenience class. ">Entity</a> <a class="el" href="classComponent.html">Component</a> <a class="el" href="classyage_1_1System.html" title="System interface for the different systems in the engine. ">System</a> to organize the data and make it more flexible and efficient. Project namespace.</p> +<p>Avoids collision as all the classes and global functions are wrapped in. </p> </div><h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="a23eef341099a6b2816cf0c63f8ffe898"></a> <div class="memitem"> @@ -859,16 +854,24 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> + +<p>Different log levels that can be assigned to each message sent to the <a class="el" href="classyage_1_1Logger.html">Logger</a>. </p> +<p>The logger then outputs the message if it is above the minimum log level, or does not process it. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a4ac616fa26af17775ed558a4c08e4788adc30ec20708ef7b0f641ef78b7880a15"></a>DEBUG</em> </td><td class="fielddoc"> +<p>Lowest log level. This is used by the game engine to output debugging information but is turned off in the logger by default. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a4ac616fa26af17775ed558a4c08e4788a551b723eafd6a31d444fcb2f5920fbd3"></a>INFO</em> </td><td class="fielddoc"> +<p>Information message. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a4ac616fa26af17775ed558a4c08e4788a059e9861e0400dfbe05c98a841f3f96b"></a>WARNING</em> </td><td class="fielddoc"> +<p>Warning message. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a4ac616fa26af17775ed558a4c08e4788abb1ca97ec761fc37101737ba0aa2e7c5"></a>ERROR</em> </td><td class="fielddoc"> +<p>Error message. </p> </td></tr> <tr><td class="fieldname"><em><a class="anchor" id="a4ac616fa26af17775ed558a4c08e4788a19da7170bea36556dde582519795f3fc"></a>FATAL</em> </td><td class="fielddoc"> +<p>Fatal message that should be output when the game crashes. </p> </td></tr> </table> @@ -897,7 +900,7 @@ Functions</h2></td></tr> </div> </div> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="a0bd2fedcbe862fdea1ea54b6b7d49bec"></a> +<a class="anchor" id="ae53246342d5b0371f300336cbc6595a3"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -936,9 +939,8 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Initializes yage. </p> -<p>This is only there to initialize glfw.</p> -<dl class="section return"><dt>Returns</dt><dd>Returns true if the initialization was successful. </dd></dl> +<p>Initializes YAGE. </p> +<p>This is there to initialize GLFW, which is the current window manager that is used with OpenGL. </p> </div> </div> @@ -1310,21 +1312,17 @@ template<int M, int N, class T > </div> </table> </div><div class="memdoc"> -<p>Quit and cleanup yage. </p> -<p>glfw needs to clean itself up. </p> +<p>Quit and cleanup YAGE. </p> +<p>This also cleans up GLFW after it was initialized. </p> </div> </div> </div><!-- contents --> -</div><!-- doc-content --> <!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="navelem"><a class="el" href="namespaceyage.html">yage</a></li> - <li class="footer">Generated on Sat Jan 6 2018 21:19:57 for YAGE by - <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> - </ul> -</div> +<hr class="footer"/><address class="footer"><small> +Generated on Wed Jan 10 2018 18:44:07 for YAGE by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> </body> </html> |