From fadbf72b725cd3e3d2c179473063a87061663e4c Mon Sep 17 00:00:00 2001 From: Michael Sappler Date: Wed, 13 Dec 2023 13:37:42 +0100 Subject: [PATCH] Update docs --- docs/gdl.app.html | 2 +- docs/gdl.dev-loop.html | 2 +- docs/gdl.draw.html | 3 +++ docs/gdl.geom.html | 2 +- docs/gdl.graphics.animation.html | 2 +- docs/gdl.graphics.camera.html | 2 +- docs/gdl.graphics.color.html | 2 +- docs/gdl.graphics.font.html | 3 --- docs/gdl.graphics.freetype.html | 2 +- docs/gdl.graphics.image.html | 8 ++++---- docs/gdl.graphics.shape-drawer.html | 3 --- docs/gdl.graphics.viewport.html | 2 +- docs/gdl.lc.html | 2 +- docs/gdl.raycaster.html | 2 +- docs/gdl.scene2d.actor.html | 2 +- docs/gdl.scene2d.stage.html | 2 +- docs/gdl.scene2d.ui.html | 2 +- docs/gdl.tiled.html | 2 +- docs/gdl.vector.html | 2 +- docs/index.html | 2 +- 20 files changed, 23 insertions(+), 26 deletions(-) create mode 100644 docs/gdl.draw.html delete mode 100644 docs/gdl.graphics.font.html delete mode 100644 docs/gdl.graphics.shape-drawer.html diff --git a/docs/gdl.app.html b/docs/gdl.app.html index 81612cf..8303061 100644 --- a/docs/gdl.app.html +++ b/docs/gdl.app.html @@ -1,3 +1,3 @@ -gdl.app documentation

gdl.app

current-context

(current-context)

current-screen-value

(current-screen-value)

pixels->world-units

(pixels->world-units {:keys [world-unit-scale]} pixels)

render-with

(render-with {:keys [batch gui-camera world-camera world-unit-scale], :as context} gui-or-world renderfn)

set-screen

(set-screen k)

start

(start config)
\ No newline at end of file +gdl.app documentation

gdl.app

current-context

(current-context)

current-screen-value

(current-screen-value)

pixels->world-units

(pixels->world-units {:keys [world-unit-scale]} pixels)

render-with

(render-with {:keys [batch shape-drawer gui-camera world-camera world-unit-scale], :as context} gui-or-world draw-fn)

set-screen

(set-screen k)

start

(start config)
\ No newline at end of file diff --git a/docs/gdl.dev-loop.html b/docs/gdl.dev-loop.html index c277584..777563e 100644 --- a/docs/gdl.dev-loop.html +++ b/docs/gdl.dev-loop.html @@ -1,6 +1,6 @@ -gdl.dev-loop documentation

gdl.dev-loop

-main

(-main & [app-namespace app-start-fn])

app-start-failed

dev-loop

(dev-loop)

nrepl-server

refresh-result

restart!

(restart!)

save-port-file

(save-port-file server)
Writes a file relative to project classpath with port number so other tools
+gdl.dev-loop documentation

gdl.dev-loop

-main

(-main & [app-namespace app-start-fn])

app-start-failed

dev-loop

(dev-loop)

nrepl-server

refresh-result

restart!

(restart!)

save-port-file

(save-port-file server)
Writes a file relative to project classpath with port number so other tools
 can infer the nREPL server port.
 Takes nREPL server map and processed CLI options map.
 Returns nil.

start-app

(start-app)

wait!

(wait!)
\ No newline at end of file diff --git a/docs/gdl.draw.html b/docs/gdl.draw.html new file mode 100644 index 0000000..9d16ae0 --- /dev/null +++ b/docs/gdl.draw.html @@ -0,0 +1,3 @@ + +gdl.draw documentation

gdl.draw

Drawer

protocol

members

arc

(arc _ center-position radius start-angle degree color)

centered-image

(centered-image _ image position)

circle

(circle _ position radius color)

ellipse

(ellipse _ position radius-x radius-y color)

filled-circle

(filled-circle _ position radius color)

filled-ellipse

(filled-ellipse _ position radius-x radius-y color)

filled-rectangle

(filled-rectangle _ x y w h color)

image

(image _ image position)(image _ image x y)

line

(line _ start-position end-position color)(line _ x y ex ey color)

rectangle

(rectangle _ x y w h color)

rotated-centered-image

(rotated-centered-image _ image rotation position)

sector

(sector _ center-position radius start-angle degree color)

text

(text _ {:keys [font text x y h-align up?]})

with-line-width

(with-line-width _ width draw-fn)

grid

(grid drawer leftx bottomy gridw gridh cellw cellh color)
\ No newline at end of file diff --git a/docs/gdl.geom.html b/docs/gdl.geom.html index ae3e353..dd8a0e7 100644 --- a/docs/gdl.geom.html +++ b/docs/gdl.geom.html @@ -1,3 +1,3 @@ -gdl.geom documentation

gdl.geom

circle->outer-rectangle

(circle->outer-rectangle {[x y] :position, :keys [radius], :as circle})

collides?

(collides? a b)

point-in-rect?

(point-in-rect? [x y] rectangle)
\ No newline at end of file +gdl.geom documentation

gdl.geom

circle->outer-rectangle

(circle->outer-rectangle {[x y] :position, :keys [radius], :as circle})

collides?

(collides? a b)

point-in-rect?

(point-in-rect? [x y] rectangle)
\ No newline at end of file diff --git a/docs/gdl.graphics.animation.html b/docs/gdl.graphics.animation.html index 5e669ca..48ee9a8 100644 --- a/docs/gdl.graphics.animation.html +++ b/docs/gdl.graphics.animation.html @@ -1,3 +1,3 @@ -gdl.graphics.animation documentation

gdl.graphics.animation

Animation

protocol

members

current-frame

(current-frame _)

restart

(restart _)

stopped?

(stopped? _)

tick

(tick _ delta)

create

(create frames & {:keys [frame-duration looping?]})
\ No newline at end of file +gdl.graphics.animation documentation

gdl.graphics.animation

Animation

protocol

members

current-frame

(current-frame _)

restart

(restart _)

stopped?

(stopped? _)

tick

(tick _ delta)

create

(create frames & {:keys [frame-duration looping?]})
\ No newline at end of file diff --git a/docs/gdl.graphics.camera.html b/docs/gdl.graphics.camera.html index 4f1261e..04b8946 100644 --- a/docs/gdl.graphics.camera.html +++ b/docs/gdl.graphics.camera.html @@ -1,3 +1,3 @@ -gdl.graphics.camera documentation

gdl.graphics.camera

frustum

(frustum camera)

position

(position camera)

set-position!

(set-position! camera [x y])

set-zoom!

(set-zoom! camera amount)

visible-tiles

(visible-tiles camera)
\ No newline at end of file +gdl.graphics.camera documentation

gdl.graphics.camera

frustum

(frustum camera)

position

(position camera)

set-position!

(set-position! camera [x y])

set-zoom!

(set-zoom! camera amount)

visible-tiles

(visible-tiles camera)
\ No newline at end of file diff --git a/docs/gdl.graphics.color.html b/docs/gdl.graphics.color.html index b869b5d..f85996b 100644 --- a/docs/gdl.graphics.color.html +++ b/docs/gdl.graphics.color.html @@ -1,3 +1,3 @@ -gdl.graphics.color documentation

gdl.graphics.color

defrgb

macro

(defrgb symbol & rgb-args)

rgb

(rgb r g b)(rgb r g b a)
\ No newline at end of file +gdl.graphics.color documentation

gdl.graphics.color

defrgb

macro

(defrgb symbol & rgb-args)

rgb

(rgb r g b)(rgb r g b a)
\ No newline at end of file diff --git a/docs/gdl.graphics.font.html b/docs/gdl.graphics.font.html deleted file mode 100644 index 5259bce..0000000 --- a/docs/gdl.graphics.font.html +++ /dev/null @@ -1,3 +0,0 @@ - -gdl.graphics.font documentation

gdl.graphics.font

draw-text

(draw-text {:keys [default-font unit-scale batch]} {:keys [font text x y h-align up?]})
\ No newline at end of file diff --git a/docs/gdl.graphics.freetype.html b/docs/gdl.graphics.freetype.html index 68958c1..d1957f9 100644 --- a/docs/gdl.graphics.freetype.html +++ b/docs/gdl.graphics.freetype.html @@ -1,3 +1,3 @@ -gdl.graphics.freetype documentation

gdl.graphics.freetype

generate

(generate ttf-file size)
\ No newline at end of file +gdl.graphics.freetype documentation

gdl.graphics.freetype

generate

(generate ttf-file size)
\ No newline at end of file diff --git a/docs/gdl.graphics.image.html b/docs/gdl.graphics.image.html index d65bc93..160f255 100644 --- a/docs/gdl.graphics.image.html +++ b/docs/gdl.graphics.image.html @@ -1,6 +1,6 @@ -gdl.graphics.image documentation

gdl.graphics.image

create

(create {:keys [assets world-unit-scale]} file & {:keys [scale]})
Scale can be a number or [width height]
-

draw

(draw {:keys [batch], :as context} {:keys [texture color], :as image} position)(draw context image x y)

draw-centered

(draw-centered context image position)

draw-rotated-centered

(draw-rotated-centered {:keys [batch], :as context} {:keys [texture color], :as image} rotation [x y])

get-scaled-copy

(get-scaled-copy {:keys [world-unit-scale]} image scale)
Scaled of original texture-dimensions, not any existing scale.
-

get-sprite

(get-sprite context {:keys [tilew tileh], :as sheet} [x y])

get-sub-image

(get-sub-image {:keys [assets world-unit-scale]} {:keys [file], :as image} & sub-image-bounds)
Coordinates are from original image, not scaled one.
-

pixel-dimensions

spritesheet

(spritesheet context file tilew tileh)

world-unit-dimensions

\ No newline at end of file +gdl.graphics.image documentation

gdl.graphics.image

create

(create {:keys [assets world-unit-scale]} file & {:keys [scale]})
Scale can be a number or [width height]
+

get-scaled-copy

(get-scaled-copy {:keys [world-unit-scale]} image scale)
Scaled of original texture-dimensions, not any existing scale.
+

get-sprite

(get-sprite context {:keys [tilew tileh], :as sheet} [x y])

get-sub-image

(get-sub-image {:keys [assets world-unit-scale]} {:keys [file], :as image} & sub-image-bounds)
Coordinates are from original image, not scaled one.
+

pixel-dimensions

spritesheet

(spritesheet context file tilew tileh)

world-unit-dimensions

\ No newline at end of file diff --git a/docs/gdl.graphics.shape-drawer.html b/docs/gdl.graphics.shape-drawer.html deleted file mode 100644 index eff5098..0000000 --- a/docs/gdl.graphics.shape-drawer.html +++ /dev/null @@ -1,3 +0,0 @@ - -gdl.graphics.shape-drawer documentation

gdl.graphics.shape-drawer

arc

(arc [centre-x centre-y] radius start-angle degree color)

circle

(circle [x y] radius color)

ellipse

(ellipse [x y] radius-x radius-y color)

filled-circle

(filled-circle [x y] radius color)

filled-ellipse

(filled-ellipse [x y] radius-x radius-y color)

filled-rectangle

(filled-rectangle x y w h color)

grid

(grid leftx bottomy gridw gridh cellw cellh color)

line

(line [x y] [ex ey] color)(line x y ex ey color)

rectangle

(rectangle x y w h color)

sector

(sector [centre-x centre-y] radius start-angle degree color)

set-line-width

(set-line-width width)

with-line-width

macro

(with-line-width width & exprs)
\ No newline at end of file diff --git a/docs/gdl.graphics.viewport.html b/docs/gdl.graphics.viewport.html index 42c6300..83beb13 100644 --- a/docs/gdl.graphics.viewport.html +++ b/docs/gdl.graphics.viewport.html @@ -1,3 +1,3 @@ -gdl.graphics.viewport documentation

gdl.graphics.viewport

unproject-mouse-posi

(unproject-mouse-posi viewport)
\ No newline at end of file +gdl.graphics.viewport documentation

gdl.graphics.viewport

unproject-mouse-posi

(unproject-mouse-posi viewport)
\ No newline at end of file diff --git a/docs/gdl.lc.html b/docs/gdl.lc.html index ffffebe..3ac4dc3 100644 --- a/docs/gdl.lc.html +++ b/docs/gdl.lc.html @@ -1,4 +1,4 @@ -gdl.lc documentation

gdl.lc

https://libgdx.com/wiki/app/the-life-cycle
+gdl.lc documentation

gdl.lc

create

multimethod

dispose

multimethod

hide

multimethod

render

multimethod

show

multimethod

tick

multimethod

\ No newline at end of file diff --git a/docs/gdl.raycaster.html b/docs/gdl.raycaster.html index 58f4833..40a0cd5 100644 --- a/docs/gdl.raycaster.html +++ b/docs/gdl.raycaster.html @@ -1,3 +1,3 @@ -gdl.raycaster documentation

gdl.raycaster

ray-blocked?

(ray-blocked? boolean-2d-array width height [start-x start-y] [target-x target-y])
\ No newline at end of file +gdl.raycaster documentation

gdl.raycaster

ray-blocked?

(ray-blocked? boolean-2d-array width height [start-x start-y] [target-x target-y])
\ No newline at end of file diff --git a/docs/gdl.scene2d.actor.html b/docs/gdl.scene2d.actor.html index ba50739..a753e1f 100644 --- a/docs/gdl.scene2d.actor.html +++ b/docs/gdl.scene2d.actor.html @@ -1,3 +1,3 @@ -gdl.scene2d.actor documentation

gdl.scene2d.actor

id

(id actor)

set-center

(set-center actor x y)

set-id

(set-id actor id)

set-opts

(set-opts actor {:keys [id]})

set-touchable

(set-touchable actor touchable)

toggle-visible!

(toggle-visible! actor)
\ No newline at end of file +gdl.scene2d.actor documentation

gdl.scene2d.actor

id

(id actor)

set-center

(set-center actor x y)

set-id

(set-id actor id)

set-opts

(set-opts actor {:keys [id]})

set-touchable

(set-touchable actor touchable)

toggle-visible!

(toggle-visible! actor)
\ No newline at end of file diff --git a/docs/gdl.scene2d.stage.html b/docs/gdl.scene2d.stage.html index ca8b88a..25b356e 100644 --- a/docs/gdl.scene2d.stage.html +++ b/docs/gdl.scene2d.stage.html @@ -1,3 +1,3 @@ -gdl.scene2d.stage documentation

gdl.scene2d.stage

create

(create viewport batch)

hit

(hit stage [x y])
\ No newline at end of file +gdl.scene2d.stage documentation

gdl.scene2d.stage

create

(create viewport batch)

hit

(hit stage [x y])
\ No newline at end of file diff --git a/docs/gdl.scene2d.ui.html b/docs/gdl.scene2d.ui.html index a235ca7..5967cf6 100644 --- a/docs/gdl.scene2d.ui.html +++ b/docs/gdl.scene2d.ui.html @@ -1,3 +1,3 @@ -gdl.scene2d.ui documentation

gdl.scene2d.ui

add-rows

(add-rows table rows)

check-box

(check-box text on-clicked checked?)

default-skin

image

(image drawable & opts)

image-button

(image-button image on-clicked)

label

(label text)

pack

(pack widget-group)

set-cell-opts

(set-cell-opts cell opts)

set-opts

(set-opts actor opts)

set-table-opts

(set-table-opts table {:keys [rows cell-defaults]})

set-text

(set-text label text)

set-widget-group-opts

(set-widget-group-opts widget-group {:keys [fill-parent? pack?]})

skin

(skin file)

split-pane

(split-pane & {:keys [first-widget second-widget vertical?], :as opts})

stack

(stack)

table

(table & opts)

text-button

(text-button text on-clicked)

text-field

(text-field text & opts)

text-tooltip

(text-tooltip textfn)

texture-region-drawable

(texture-region-drawable texture)

window

(window & {:keys [title modal?], :as opts})
\ No newline at end of file +gdl.scene2d.ui documentation

gdl.scene2d.ui

add-rows

(add-rows table rows)

check-box

(check-box text on-clicked checked?)

default-skin

image

(image drawable & opts)

image-button

(image-button image on-clicked)

label

(label text)

set-cell-opts

(set-cell-opts cell opts)

set-opts

(set-opts actor opts)

set-table-opts

(set-table-opts table {:keys [rows cell-defaults]})

set-text

(set-text label text)

set-widget-group-opts

(set-widget-group-opts widget-group {:keys [fill-parent? pack?]})

skin

(skin file)

split-pane

(split-pane & {:keys [first-widget second-widget vertical?], :as opts})

stack

(stack)

table

(table & opts)

text-button

(text-button text on-clicked)

text-field

(text-field text & opts)

text-tooltip

(text-tooltip textfn)

texture-region-drawable

(texture-region-drawable texture)

window

(window & {:keys [title modal?], :as opts})
\ No newline at end of file diff --git a/docs/gdl.tiled.html b/docs/gdl.tiled.html index d280893..affb863 100644 --- a/docs/gdl.tiled.html +++ b/docs/gdl.tiled.html @@ -1,5 +1,5 @@ -gdl.tiled documentation

gdl.tiled

cell-at

(cell-at [x y] tiled-map layer)

dispose

(dispose tiled-map)

get-property

multimethod

height

(height tiled-map)

layer-index

(layer-index tiled-map layer)

layer-name

(layer-name layer)

layers

(layers tiled-map)

load-map

(load-map file)
Requires OpenGL context (texture generation).
+gdl.tiled documentation

gdl.tiled

cell-at

(cell-at [x y] tiled-map layer)

dispose

(dispose tiled-map)

get-property

multimethod

height

(height tiled-map)

layer-index

(layer-index tiled-map layer)

layer-name

(layer-name layer)

layers

(layers tiled-map)

load-map

(load-map file)
Requires OpenGL context (texture generation).
 

positions-with-property

(positions-with-property tiled-map layer property)

property-value

(property-value position tiled-map layer property)
Returns the property value from layer and position.
 If there is no cell returns :no-cell and if the property value is undefined returns :undefined.

remove-layer!

(remove-layer! tiled-map layer)

render-map

(render-map {:keys [world-camera], :as context} tiled-map color-setter)

width

(width tiled-map)
\ No newline at end of file diff --git a/docs/gdl.vector.html b/docs/gdl.vector.html index d711398..70191ce 100644 --- a/docs/gdl.vector.html +++ b/docs/gdl.vector.html @@ -1,6 +1,6 @@ -gdl.vector documentation

gdl.vector

add

(add v1 v2)

add-or-subtract-angle

(add-or-subtract-angle current-angle new-angle)
man will current in richtung new rotieren. muss man dazu add or subtract machen f�r den k�rzesten weg?
+gdl.vector documentation

gdl.vector

add

(add v1 v2)

add-or-subtract-angle

(add-or-subtract-angle current-angle new-angle)
man will current in richtung new rotieren. muss man dazu add or subtract machen f�r den k�rzesten weg?
 returns add or subtract-function

degree-add

(degree-add degree by)

degree-minus

(degree-minus degree by)

degrees?

(degrees? n)

direction

(direction [sx sy] [tx ty])

distance

(distance v1 v2)

get-angle-from-vector

(get-angle-from-vector v)
converts theta of Vector2 to angle from top (top is 0 degree, moving left is 90 degree etc.), ->counterclockwise
 

get-angle-to-position

(get-angle-to-position {originx 0, :as origin} {targetx 0, :as target})
Treat Position a the middle of the coordinate sytem and the angle is from the top
 so if target is right of origin -> 90� below origin -> 180�

get-normal-vectors

(get-normal-vectors [x y])

length

(length v)

normalise

(normalise v)

normalised?

(normalised? v)

rotate-angle-to-angle

(rotate-angle-to-angle current-angle new-angle rotationspeed delta)

scale

(scale v n)

smallest-distance

(smallest-distance a b)

vector-from-angle

(vector-from-angle angle)
Given a vector which points upwards on the y-axis, returns a vector rotated by angle degrees clockwise.
diff --git a/docs/index.html b/docs/index.html
index 92a763a..474910e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,3 +1,3 @@
 
-Gdl main-SNAPSHOT

Gdl main-SNAPSHOT

Installation

To install, add the following dependency to your project or build file:

[com.github.damn/gdl "main-SNAPSHOT"]

Namespaces

gdl.graphics.animation

Public variables and functions:

gdl.graphics.color

Public variables and functions:

gdl.graphics.font

Public variables and functions:

gdl.graphics.freetype

Public variables and functions:

gdl.graphics.viewport

Public variables and functions:

gdl.raycaster

Public variables and functions:

gdl.scene2d.stage

Public variables and functions:

\ No newline at end of file +Gdl main-SNAPSHOT

Gdl main-SNAPSHOT

Installation

To install, add the following dependency to your project or build file:

[com.github.damn/gdl "main-SNAPSHOT"]

Namespaces

gdl.draw

Public variables and functions:

gdl.graphics.animation

Public variables and functions:

gdl.graphics.color

Public variables and functions:

gdl.graphics.freetype

Public variables and functions:

gdl.graphics.viewport

Public variables and functions:

gdl.raycaster

Public variables and functions:

gdl.scene2d.stage

Public variables and functions:

\ No newline at end of file