Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
damn committed Sep 28, 2024
1 parent ad56825 commit bfc1bbc
Show file tree
Hide file tree
Showing 14 changed files with 79 additions and 56 deletions.
51 changes: 24 additions & 27 deletions docs/clojure.ctx.html

Large diffs are not rendered by default.

19 changes: 19 additions & 0 deletions docs/clojure.gdx.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>clojure.gdx documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Clojure.ctx</span> <span class="project-version">-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>clojure</span></div></div></li><li class="depth-2 branch"><a href="clojure.ctx.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ctx</span></div></a></li><li class="depth-2 current"><a href="clojure.gdx.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gdx</span></div></a></li><li class="depth-3"><a href="clojure.gdx.tiled.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tiled</span></div></a></li><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>core</span></div></div></li><li class="depth-2 branch"><a href="core.app.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>app</span></div></a></li><li class="depth-2 branch"><a href="core.creature.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>creature</span></div></a></li><li class="depth-2 branch"><a href="core.item.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>item</span></div></a></li><li class="depth-2 branch"><a href="core.projectile.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>projectile</span></div></a></li><li class="depth-2 branch"><a href="core.screens.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>screens</span></div></a></li><li class="depth-2 branch"><a href="core.skill.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>skill</span></div></a></li><li class="depth-2 branch"><a href="core.stat.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>stat</span></div></a></li><li class="depth-2"><a href="core.world.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>world</span></div></a></li><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree" style="top: -269px;"><span class="top" style="height: 278px;"></span><span class="bottom"></span></span><span>dev</span></div></div></li><li class="depth-2 branch"><a href="dev.experiment.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>experiment</span></div></a></li><li class="depth-2"><a href="dev.interactive.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>interactive</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="clojure.gdx.html#var--.3Ecolor"><div class="inner"><span>-&gt;color</span></div></a></li><li class="depth-1"><a href="clojure.gdx.html#var-button-just-pressed.3F"><div class="inner"><span>button-just-pressed?</span></div></a></li><li class="depth-1"><a href="clojure.gdx.html#var-delta-time"><div class="inner"><span>delta-time</span></div></a></li><li class="depth-1"><a href="clojure.gdx.html#var-exit-app.21"><div class="inner"><span>exit-app!</span></div></a></li><li class="depth-1"><a href="clojure.gdx.html#var-frames-per-second"><div class="inner"><span>frames-per-second</span></div></a></li><li class="depth-1"><a href="clojure.gdx.html#var-key-just-pressed.3F"><div class="inner"><span>key-just-pressed?</span></div></a></li><li class="depth-1"><a href="clojure.gdx.html#var-key-pressed.3F"><div class="inner"><span>key-pressed?</span></div></a></li><li class="depth-1"><a href="clojure.gdx.html#var-post-runnable.21"><div class="inner"><span>post-runnable!</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">clojure.gdx</h1><div class="doc"><div class="markdown"><p>API for <a href="https://libgdx.com/">libgdx</a></p>
</div><div class="markdown"><h4>Categories</h4><ul></ul><p>Other vars: <a href="clojure.gdx.html#var--.3Ecolor">-&gt;color</a> <a href="clojure.gdx.html#var-button-just-pressed.3F">button-just-pressed?</a> <a href="clojure.gdx.html#var-delta-time">delta-time</a> <a href="clojure.gdx.html#var-exit-app.21">exit-app!</a> <a href="clojure.gdx.html#var-frames-per-second">frames-per-second</a> <a href="clojure.gdx.html#var-key-just-pressed.3F">key-just-pressed?</a> <a href="clojure.gdx.html#var-key-pressed.3F">key-pressed?</a> <a href="clojure.gdx.html#var-post-runnable.21">post-runnable!</a></p></div></div><div class="public anchor" id="var--.3Ecolor"><h3>-&gt;color</h3><div class="usage"><code>(-&gt;color r g b)</code><code>(-&gt;color r g b a)</code></div><div class="doc"><div class="markdown"><p><a href="https://javadoc.io/static/com.badlogicgames.gdx/gdx/1.12.1/com/badlogic/gdx/graphics/Color.html#%3Cinit%3E(float,float,float,float)">javadoc</a></p>
</div></div><div class="src-link"><a href="https://github.com/damn/clojure.ctx/blob/main/src/clojure/gdx.clj#L41">view source</a></div></div><div class="public anchor" id="var-button-just-pressed.3F"><h3>button-just-pressed?</h3><div class="usage"><code>(button-just-pressed? b)</code></div><div class="doc"><div class="markdown"><p>:left, :right, :middle, :back or :forward.</p>
</div></div><div class="src-link"><a href="https://github.com/damn/clojure.ctx/blob/main/src/clojure/gdx.clj#L65">view source</a></div></div><div class="public anchor" id="var-delta-time"><h3>delta-time</h3><div class="usage"><code>(delta-time)</code></div><div class="doc"><div class="markdown"><p>the time span between the current frame and the last frame in seconds.</p>
<p><code>returns float</code></p>
<p><a href="https://javadoc.io/static/com.badlogicgames.gdx/gdx/1.12.1/com/badlogic/gdx/Graphics.html#getDeltaTime()">javadoc</a></p>
</div></div><div class="src-link"><a href="https://github.com/damn/clojure.ctx/blob/main/src/clojure/gdx.clj#L23">view source</a></div></div><div class="public anchor" id="var-exit-app.21"><h3>exit-app!</h3><div class="usage"><code>(exit-app!)</code></div><div class="doc"><div class="markdown"><p>Schedule an exit from the application. On android, this will cause a call to pause() and dispose() some time in the future, it will not immediately finish your application. On iOS this should be avoided in production as it breaks Apples guidelines</p>
<p><a href="https://javadoc.io/static/com.badlogicgames.gdx/gdx/1.12.1/com/badlogic/gdx/Application.html#exit()">javadoc</a></p>
</div></div><div class="src-link"><a href="https://github.com/damn/clojure.ctx/blob/main/src/clojure/gdx.clj#L7">view source</a></div></div><div class="public anchor" id="var-frames-per-second"><h3>frames-per-second</h3><div class="usage"><code>(frames-per-second)</code></div><div class="doc"><div class="markdown"><p>the average number of frames per second</p>
<p><code>returns int</code></p>
<p><a href="https://javadoc.io/static/com.badlogicgames.gdx/gdx/1.12.1/com/badlogic/gdx/Graphics.html#getFramesPerSecond()">javadoc</a></p>
</div></div><div class="src-link"><a href="https://github.com/damn/clojure.ctx/blob/main/src/clojure/gdx.clj#L32">view source</a></div></div><div class="public anchor" id="var-key-just-pressed.3F"><h3>key-just-pressed?</h3><div class="usage"><code>(key-just-pressed? k)</code></div><div class="doc"><div class="markdown"><p>See <a href="clojure.gdx.html#var-key-pressed.3F">key-pressed?</a>.</p>
</div></div><div class="src-link"><a href="https://github.com/damn/clojure.ctx/blob/main/src/clojure/gdx.clj#L70">view source</a></div></div><div class="public anchor" id="var-key-pressed.3F"><h3>key-pressed?</h3><div class="usage"><code>(key-pressed? k)</code></div><div class="doc"><div class="markdown"><p>For options see <a href="https://javadoc.io/doc/com.badlogicgames.gdx/gdx/latest/com/badlogic/gdx/Input.Keys.html">libgdx Input$Keys docs</a>. Keys are upper-cased and dashes replaced by underscores. For example Input$Keys/ALT_LEFT can be used with :alt-left. Numbers via :num-3, etc.</p>
</div></div><div class="src-link"><a href="https://github.com/damn/clojure.ctx/blob/main/src/clojure/gdx.clj#L75">view source</a></div></div><div class="public anchor" id="var-post-runnable.21"><h3>post-runnable!</h3><h4 class="type">macro</h4><div class="usage"><code>(post-runnable! &amp; exprs)</code></div><div class="doc"><div class="markdown"><p>Posts a Runnable on the main loop thread. In a multi-window application, the Gdx.graphics and Gdx.input values may be unpredictable at the time the Runnable is executed. If graphics or input are needed, they can be copied to a variable to be used in the Runnable. For example:</p>
<p>final Graphics graphics = Gdx.graphics;</p>
<p><a href="https://javadoc.io/static/com.badlogicgames.gdx/gdx/1.12.1/com/badlogic/gdx/Application.html#postRunnable(java.lang.Runnable)">javadoc</a></p>
</div></div><div class="src-link"><a href="https://github.com/damn/clojure.ctx/blob/main/src/clojure/gdx.clj#L14">view source</a></div></div></div></body></html>
Loading

0 comments on commit bfc1bbc

Please sign in to comment.