deploy: eb8009e

Camera_8h_source.html

@@ -116,8 +116,8 @@
 <div class="ttc" id="aCamera_8h_html_ad3f9162bb1ad82c10544770145db45cf"><div class="ttname"><a href="Camera_8h.html#ad3f9162bb1ad82c10544770145db45cf">vk2dCameraUpdate</a></div><div class="ttdeci">void vk2dCameraUpdate(VK2DCameraIndex index, VK2DCameraSpec spec)</div><div class="ttdoc">Updates a camera with new positional data.</div></div>
 <div class="ttc" id="aStructs_8h_html"><div class="ttname"><a href="Structs_8h.html">Structs.h</a></div><div class="ttdoc">Forward declares struct typedefs.</div></div>
 <div class="ttc" id="aStructs_8h_html_a3e1eb4968ee0d488b484efdd3ba53436"><div class="ttname"><a href="Structs_8h.html#a3e1eb4968ee0d488b484efdd3ba53436">VK2DCameraState</a></div><div class="ttdeci">VK2DCameraState</div><div class="ttdoc">The state a camera is in.</div><div class="ttdef"><b>Definition:</b> Structs.h:85</div></div>
-<div class="ttc" id="aStructs_8h_html_a747c5f3b133f2eed2bf9af7db88e7ef8"><div class="ttname"><a href="Structs_8h.html#a747c5f3b133f2eed2bf9af7db88e7ef8">VK2DCameraIndex</a></div><div class="ttdeci">int32_t VK2DCameraIndex</div><div class="ttdoc">Type used for referencing cameras.</div><div class="ttdef"><b>Definition:</b> Structs.h:165</div></div>
-<div class="ttc" id="astructVK2DCameraSpec_html"><div class="ttname"><a href="structVK2DCameraSpec.html">VK2DCameraSpec</a></div><div class="ttdoc">Camera information.</div><div class="ttdef"><b>Definition:</b> Structs.h:239</div></div>
+<div class="ttc" id="aStructs_8h_html_a747c5f3b133f2eed2bf9af7db88e7ef8"><div class="ttname"><a href="Structs_8h.html#a747c5f3b133f2eed2bf9af7db88e7ef8">VK2DCameraIndex</a></div><div class="ttdeci">int32_t VK2DCameraIndex</div><div class="ttdoc">Type used for referencing cameras.</div><div class="ttdef"><b>Definition:</b> Structs.h:181</div></div>
+<div class="ttc" id="astructVK2DCameraSpec_html"><div class="ttname"><a href="structVK2DCameraSpec.html">VK2DCameraSpec</a></div><div class="ttdoc">Camera information.</div><div class="ttdef"><b>Definition:</b> Structs.h:255</div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

Model_8h_source.html

@@ -113,7 +113,7 @@
 <div class="ttc" id="aModel_8h_html_a9910e616e7d9eb4333026346cc291889"><div class="ttname"><a href="Model_8h.html#a9910e616e7d9eb4333026346cc291889">vk2dModelFrom</a></div><div class="ttdeci">VK2DModel vk2dModelFrom(const void *objFile, uint32_t objFileSize, VK2DTexture texture)</div><div class="ttdoc">Loads a .obj model from a binary buffer.</div></div>
 <div class="ttc" id="aModel_8h_html_ae2f20393781eec2011936b9c64d78591"><div class="ttname"><a href="Model_8h.html#ae2f20393781eec2011936b9c64d78591">vk2dModelLoad</a></div><div class="ttdeci">VK2DModel vk2dModelLoad(const char *objFile, VK2DTexture texture)</div><div class="ttdoc">Loads a model from a .obj file.</div></div>
 <div class="ttc" id="aStructs_8h_html"><div class="ttname"><a href="Structs_8h.html">Structs.h</a></div><div class="ttdoc">Forward declares struct typedefs.</div></div>
-<div class="ttc" id="astructVK2DVertex3D_html"><div class="ttname"><a href="structVK2DVertex3D.html">VK2DVertex3D</a></div><div class="ttdoc">Vertex data for 3D models.</div><div class="ttdef"><b>Definition:</b> Structs.h:174</div></div>
+<div class="ttc" id="astructVK2DVertex3D_html"><div class="ttname"><a href="structVK2DVertex3D.html">VK2DVertex3D</a></div><div class="ttdoc">Vertex data for 3D models.</div><div class="ttdef"><b>Definition:</b> Structs.h:190</div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

Polygon_8h_source.html

@@ -112,8 +112,8 @@
 <div class="ttc" id="aPolygon_8h_html_a3028cc91ab0ffef48ccd15a08651dd09"><div class="ttname"><a href="Polygon_8h.html#a3028cc91ab0ffef48ccd15a08651dd09">vk2dPolygonCreate</a></div><div class="ttdeci">VK2DPolygon vk2dPolygonCreate(vec2 *vertices, uint32_t vertexCount)</div><div class="ttdoc">Creates a polygon with specified vertices for drawing (use vk2dRendererSetColourMod to change colours...</div></div>
 <div class="ttc" id="aPolygon_8h_html_a45c6634abf96554bd78fa2aadf8f2a4c"><div class="ttname"><a href="Polygon_8h.html#a45c6634abf96554bd78fa2aadf8f2a4c">vk2dPolygonShapeCreateRaw</a></div><div class="ttdeci">VK2DPolygon vk2dPolygonShapeCreateRaw(VK2DVertexColour *vertexData, uint32_t vertexCount)</div><div class="ttdoc">Creates a polygon for the shapes pipeline (should be triangulated)</div></div>
 <div class="ttc" id="aStructs_8h_html"><div class="ttname"><a href="Structs_8h.html">Structs.h</a></div><div class="ttdoc">Forward declares struct typedefs.</div></div>
-<div class="ttc" id="aStructs_8h_html_a5edc995c0f7248db90aa314c4e98af6a"><div class="ttname"><a href="Structs_8h.html#a5edc995c0f7248db90aa314c4e98af6a">vec2</a></div><div class="ttdeci">float vec2[2]</div><div class="ttdoc">2D vector of floats</div><div class="ttdef"><b>Definition:</b> Structs.h:150</div></div>
-<div class="ttc" id="astructVK2DVertexColour_html"><div class="ttname"><a href="structVK2DVertexColour.html">VK2DVertexColour</a></div><div class="ttdoc">Vertex data for rendering shapes.</div><div class="ttdef"><b>Definition:</b> Structs.h:168</div></div>
+<div class="ttc" id="aStructs_8h_html_a5edc995c0f7248db90aa314c4e98af6a"><div class="ttname"><a href="Structs_8h.html#a5edc995c0f7248db90aa314c4e98af6a">vec2</a></div><div class="ttdeci">float vec2[2]</div><div class="ttdoc">2D vector of floats</div><div class="ttdef"><b>Definition:</b> Structs.h:166</div></div>
+<div class="ttc" id="astructVK2DVertexColour_html"><div class="ttname"><a href="structVK2DVertexColour.html">VK2DVertexColour</a></div><div class="ttdoc">Vertex data for rendering shapes.</div><div class="ttdef"><b>Definition:</b> Structs.h:184</div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

Renderer_8h.html

@@ -358,6 +358,18 @@
 <tr class="memitem:a58fd89a3f92e6edb6865ae4932d56a10"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Renderer_8h.html#a58fd89a3f92e6edb6865ae4932d56a10">vk2dSleep</a> (double seconds)</td></tr>
 <tr class="memdesc:a58fd89a3f92e6edb6865ae4932d56a10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combines busy loops and SDL_Delay for a more accurate sleep function.  <a href="Renderer_8h.html#a58fd89a3f92e6edb6865ae4932d56a10">More...</a><br /></td></tr>
 <tr class="separator:a58fd89a3f92e6edb6865ae4932d56a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae6182d5644eaa0985ccbeccfc7849063"><td class="memItemLeft" align="right" valign="top"><a class="el" href="Structs_8h.html#af9e490ad8613812918eb1a63a1cf24b8">VK2DStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Renderer_8h.html#ae6182d5644eaa0985ccbeccfc7849063">vk2dStatus</a> ()</td></tr>
+<tr class="memdesc:ae6182d5644eaa0985ccbeccfc7849063"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the renderer's current status code.  <a href="Renderer_8h.html#ae6182d5644eaa0985ccbeccfc7849063">More...</a><br /></td></tr>
+<tr class="separator:ae6182d5644eaa0985ccbeccfc7849063"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4ce46cb99871a73f14142f38383b5a79"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Renderer_8h.html#a4ce46cb99871a73f14142f38383b5a79">vk2dStatusFatal</a> ()</td></tr>
+<tr class="memdesc:a4ce46cb99871a73f14142f38383b5a79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the current status code should be considered fatal.  <a href="Renderer_8h.html#a4ce46cb99871a73f14142f38383b5a79">More...</a><br /></td></tr>
+<tr class="separator:a4ce46cb99871a73f14142f38383b5a79"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad199f09ce00cb06b878fe9dfded5be79"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Renderer_8h.html#ad199f09ce00cb06b878fe9dfded5be79">vk2dStatusMessage</a> ()</td></tr>
+<tr class="memdesc:ad199f09ce00cb06b878fe9dfded5be79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current renderer status message, generally use this if vk2dGetStatus() returns something other than VK2D_STATUS_NONE.  <a href="Renderer_8h.html#ad199f09ce00cb06b878fe9dfded5be79">More...</a><br /></td></tr>
+<tr class="separator:ad199f09ce00cb06b878fe9dfded5be79"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af0b39d04acd341f61960e3a38ae3a2f7"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="Renderer_8h.html#af0b39d04acd341f61960e3a38ae3a2f7">vk2dHostInformation</a> ()</td></tr>
+<tr class="memdesc:af0b39d04acd341f61960e3a38ae3a2f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string detailing information about the host machine.  <a href="Renderer_8h.html#af0b39d04acd341f61960e3a38ae3a2f7">More...</a><br /></td></tr>
+<tr class="separator:af0b39d04acd341f61960e3a38ae3a2f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>The main renderer that handles all rendering. </p>
@@ -1011,6 +1023,27 @@ <h2 class="memtitle"><span class="permalink"><a href="#aee3e036fb150542075841732
   </dd>
 </dl>
 
+</div>
+</div>
+<a id="af0b39d04acd341f61960e3a38ae3a2f7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af0b39d04acd341f61960e3a38ae3a2f7">&#9670;&nbsp;</a></span>vk2dHostInformation()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* vk2dHostInformation </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Returns a string detailing information about the host machine. </p>
+<dl class="section return"><dt>Returns</dt><dd>A string detailing information about the host machine </dd></dl>
+<dl class="section warning"><dt>Warning</dt><dd>Will simply return an empty string before VK2D is initialized </dd></dl>
+
 </div>
 </div>
 <a id="ae64d979bebe3632caa07e58526da77ab"></a>
@@ -2593,7 +2626,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a217c49f31fe2b9a7babdca3b
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>Returns a VK2DResult enum</dd></dl>
 <p>GPUs are not guaranteed to support certain screen modes and msaa levels (integrated gpus often don't support triple buffering, 32x msaa is not terribly common), so if you request something that isn't supported, the next best thing is used in its place.</p>
-<p><a class="el" href="structVK2DStartupOptions.html" title="Startup options that dictate some basic VK2D stuff.">VK2DStartupOptions</a> lets you control how some meta things in the renderer, such as whether or not to enable stdout logging or enable the Vulkan validation layers. Leave this null for options that would generally be fine for most things. </p>
+<p><a class="el" href="structVK2DStartupOptions.html" title="Startup options that dictate some basic VK2D stuff.">VK2DStartupOptions</a> lets you control how some meta things in the renderer, such as whether or not to enable stdout logging or enable the Vulkan validation layers. Leave this null for options that would generally be fine for most things.</p>
+<p>The following are default values for <a class="el" href="structVK2DStartupOptions.html" title="Startup options that dictate some basic VK2D stuff.">VK2DStartupOptions</a> if none are provided:</p>
+<p><code>enableDebug</code> defaults to <code>false</code> <code>stdoutLogging</code> defaults to <code>true</code> <code>quitOnError</code> defaults to <code>true</code> <code>errorFile</code> defaults to <code>"vk2derror.txt"</code> <code>loadCustomShaders</code> defaults to <code>false</code> <code>vramPageSize</code> defaults to <code>256 * 1000</code>, setting this to 0 also uses <code>256 * 1000</code> </p>
 
 </div>
 </div>
@@ -2876,6 +2911,68 @@ <h2 class="memtitle"><span class="permalink"><a href="#a58fd89a3f92e6edb6865ae49
 </dl>
 <p>This is a much more accurate sleep function that something like SDL_Delay without taxing the CPU as much as a simple busy loop. </p>
 
+</div>
+</div>
+<a id="ae6182d5644eaa0985ccbeccfc7849063"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae6182d5644eaa0985ccbeccfc7849063">&#9670;&nbsp;</a></span>vk2dStatus()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="Structs_8h.html#af9e490ad8613812918eb1a63a1cf24b8">VK2DStatus</a> vk2dStatus </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Gets the renderer's current status code. </p>
+<dl class="section return"><dt>Returns</dt><dd>Returns the most recent status code </dd></dl>
+
+</div>
+</div>
+<a id="a4ce46cb99871a73f14142f38383b5a79"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a4ce46cb99871a73f14142f38383b5a79">&#9670;&nbsp;</a></span>vk2dStatusFatal()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool vk2dStatusFatal </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Returns true if the current status code should be considered fatal. </p>
+<dl class="section return"><dt>Returns</dt><dd>Returns if the current renderer status is fatal.</dd></dl>
+<p>If you have <code><a class="el" href="structVK2DStartupOptions.html#a872cce9098c27c733189490c6400f65a" title="Crash the program when an error occurs.">VK2DStartupOptions.quitOnError</a></code> set to true (which is the default option) a fatal status would have already crashed the program before you can check this. You may, however, choose to disable crashing on an error and quit gracefully on your own in which case this is very helpful. Some status are not considered fatal, like if a texture file is missing so you should use this to check for critical errors and not <a class="el" href="Renderer_8h.html#ae6182d5644eaa0985ccbeccfc7849063" title="Gets the renderer&#39;s current status code.">vk2dStatus()</a>. </p>
+
+</div>
+</div>
+<a id="ad199f09ce00cb06b878fe9dfded5be79"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad199f09ce00cb06b878fe9dfded5be79">&#9670;&nbsp;</a></span>vk2dStatusMessage()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* vk2dStatusMessage </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Returns the current renderer status message, generally use this if vk2dGetStatus() returns something other than VK2D_STATUS_NONE. </p>
+<dl class="section return"><dt>Returns</dt><dd>Returns a message describing the most recent status code.</dd></dl>
+<p>Usually the status code is descriptive enough to figure out what happened but this can be helpful for a user facing error message. This is automatically put to a file if <code><a class="el" href="structVK2DStartupOptions.html#ace5e52e6cdb475598cb34a5c891346e5" title="The file to output errors to, or NULL to disable file output.">VK2DStartupOptions.errorFile</a></code> is a valid filename. </p>
+
 </div>
 </div>
 </div><!-- contents -->

Renderer_8h.js

@@ -29,6 +29,7 @@ var Renderer_8h =
     [ "vk2dColourHex", "Renderer_8h.html#a178031ff753290cdfe596ab0e8df8704", null ],
     [ "vk2dColourInt", "Renderer_8h.html#abfcde7cb2ff128172d69feb2800db90a", null ],
     [ "vk2dColourRGBA", "Renderer_8h.html#aee3e036fb150542075841732f0403459", null ],
+    [ "vk2dHostInformation", "Renderer_8h.html#af0b39d04acd341f61960e3a38ae3a2f7", null ],
     [ "vk2dInstanceSet", "Renderer_8h.html#ae64d979bebe3632caa07e58526da77ab", null ],
     [ "vk2dInstanceSetFast", "Renderer_8h.html#a398fdee3268427d1945533893aaff7a7", null ],
     [ "vk2dInstanceUpdate", "Renderer_8h.html#a451610e6a41015e2add86fd3b0f46f44", null ],
@@ -70,5 +71,8 @@ var Renderer_8h =
     [ "vk2dRendererStartFrame", "Renderer_8h.html#acd9e5db6b796040b3537c70b86f36dce", null ],
     [ "vk2dRendererUnlockCameras", "Renderer_8h.html#a099da58e901b3d04b8b01c3b71db8a57", null ],
     [ "vk2dRendererWait", "Renderer_8h.html#ad315ba5589fb95590e131ffe6ce890ed", null ],
-    [ "vk2dSleep", "Renderer_8h.html#a58fd89a3f92e6edb6865ae4932d56a10", null ]
+    [ "vk2dSleep", "Renderer_8h.html#a58fd89a3f92e6edb6865ae4932d56a10", null ],
+    [ "vk2dStatus", "Renderer_8h.html#ae6182d5644eaa0985ccbeccfc7849063", null ],
+    [ "vk2dStatusFatal", "Renderer_8h.html#a4ce46cb99871a73f14142f38383b5a79", null ],
+    [ "vk2dStatusMessage", "Renderer_8h.html#ad199f09ce00cb06b878fe9dfded5be79", null ]
 ];