Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@damn
damn committed Dec 21, 2023
1 parent e2a67f5 commit 24709c6
Show file tree
Hide file tree
Showing 26 changed files with 44 additions and 44 deletions.
17 changes: 9 additions & 8 deletions docs/gdl.app.html
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>gdl.app 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">Gdl</span> <span class="project-version">main-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>gdl</span></div></div></li><li class="depth-2 branch current"><a href="gdl.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"><a href="gdl.context.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>context</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.assets.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>assets</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.gui-world-views.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gui-world-views</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.image-drawer-creator.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>image-drawer-creator</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.shape-drawer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>shape-drawer</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.sprite-batch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>sprite-batch</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.text-drawer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>text-drawer</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.ttf-generator.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ttf-generator</span></div></a></li><li class="depth-3"><a href="gdl.context.vis-ui.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>vis-ui</span></div></a></li><li class="depth-2 branch"><a href="gdl.default-context.html"><div class="inner"><span class="tree" style="top: -269px;"><span class="top" style="height: 278px;"></span><span class="bottom"></span></span><span>default-context</span></div></a></li><li class="depth-2 branch"><a href="gdl.dev.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>dev</span></div></a></li><li class="depth-2 branch"><a href="gdl.disposable.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>disposable</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>graphics</span></div></div></li><li class="depth-3 branch"><a href="gdl.graphics.animation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>animation</span></div></a></li><li class="depth-3 branch"><a href="gdl.graphics.camera.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>camera</span></div></a></li><li class="depth-3"><a href="gdl.graphics.color.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>color</span></div></a></li><li class="depth-2"><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>maps</span></div></div></li><li class="depth-3"><a href="gdl.maps.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-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>math</span></div></div></li><li class="depth-3 branch"><a href="gdl.math.geom.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>geom</span></div></a></li><li class="depth-3 branch"><a href="gdl.math.raycaster.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>raycaster</span></div></a></li><li class="depth-3"><a href="gdl.math.vector.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>vector</span></div></a></li><li class="depth-2"><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>scene2d</span></div></div></li><li class="depth-3 branch"><a href="gdl.scene2d.actor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>actor</span></div></a></li><li class="depth-3 branch"><a href="gdl.scene2d.stage.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>stage</span></div></a></li><li class="depth-3"><a href="gdl.scene2d.ui.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ui</span></div></a></li><li class="depth-2"><a href="gdl.screen.html"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>screen</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="gdl.app.html#var-start"><div class="inner"><span>start</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">gdl.app</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-start"><h3>start</h3><div class="usage"><code>(start config)</code></div><div class="doc"><pre class="plaintext">Example for required keys:
{:app {:title "gdl demo"
:width 800
:height 600
:full-screen? false}
:current-context current-context ; an atom
:create-context create-context ; function with no args creating the context
:first-screen :my-screen}</pre></div><div class="src-link"><a href="https://github.com/damn/gdl/blob/main/src/gdl/app.clj#L62">view source</a></div></div></div></body></html>
<html><head><meta charset="UTF-8" /><title>gdl.app 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">Gdl</span> <span class="project-version">main-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>gdl</span></div></div></li><li class="depth-2 branch current"><a href="gdl.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"><a href="gdl.context.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>context</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.assets.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>assets</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.gui-world-views.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gui-world-views</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.image-drawer-creator.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>image-drawer-creator</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.shape-drawer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>shape-drawer</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.sprite-batch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>sprite-batch</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.stage.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>stage</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.text-drawer.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>text-drawer</span></div></a></li><li class="depth-3 branch"><a href="gdl.context.ttf-generator.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ttf-generator</span></div></a></li><li class="depth-3"><a href="gdl.context.vis-ui.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>vis-ui</span></div></a></li><li class="depth-2 branch"><a href="gdl.dev.html"><div class="inner"><span class="tree" style="top: -300px;"><span class="top" style="height: 309px;"></span><span class="bottom"></span></span><span>dev</span></div></a></li><li class="depth-2 branch"><a href="gdl.disposable.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>disposable</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>graphics</span></div></div></li><li class="depth-3 branch"><a href="gdl.graphics.animation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>animation</span></div></a></li><li class="depth-3 branch"><a href="gdl.graphics.camera.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>camera</span></div></a></li><li class="depth-3"><a href="gdl.graphics.color.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>color</span></div></a></li><li class="depth-2"><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>maps</span></div></div></li><li class="depth-3"><a href="gdl.maps.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-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>math</span></div></div></li><li class="depth-3 branch"><a href="gdl.math.geom.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>geom</span></div></a></li><li class="depth-3 branch"><a href="gdl.math.raycaster.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>raycaster</span></div></a></li><li class="depth-3"><a href="gdl.math.vector.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>vector</span></div></a></li><li class="depth-2"><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>scene2d</span></div></div></li><li class="depth-3 branch"><a href="gdl.scene2d.actor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>actor</span></div></a></li><li class="depth-3"><a href="gdl.scene2d.ui.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ui</span></div></a></li><li class="depth-2"><a href="gdl.screen.html"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>screen</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="gdl.app.html#var-current-context"><div class="inner"><span>current-context</span></div></a></li><li class="depth-1"><a href="gdl.app.html#var-start"><div class="inner"><span>start</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">gdl.app</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-current-context"><h3>current-context</h3><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="src-link"><a href="https://github.com/damn/gdl/blob/main/src/gdl/app.clj#L55">view source</a></div></div><div class="public anchor" id="var-start"><h3>start</h3><div class="usage"><code>(start config)</code></div><div class="doc"><pre class="plaintext">Required keys:
{:app {:title "gdl demo"
:width 800
:height 600
:full-screen? false}
:create-context create-context ; function with one argument creating the context, getting the default-context.
:first-screen :my-screen}

Optionally you can pass :world-unit-scale for the world-view.</pre></div><div class="src-link"><a href="https://github.com/damn/gdl/blob/main/src/gdl/app.clj#L96">view source</a></div></div></div></body></html>
Loading

0 comments on commit 24709c6

Please sign in to comment.