This is the clinch Reference Manual, version 0.5, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:58:50 2025 GMT+0.
clinch/clinch.asdclinch/package.lispclinch/threads.lispclinch/clinch.lispclinch/transform.lispclinch/node.lispclinch/shaders.lispclinch/shader-program.lispclinch/default-shaders.lispclinch/buffer.lispclinch/index-buffer.lispclinch/pixel-buffer.lispclinch/texture.lispclinch/2d-node.lispclinch/entity.lispclinch/viewport.lispclinch/framebuffer.lispclinch/animation.lispclinch/window.lispclinch/shapes.lispThe main system appears first, followed by any subsystem dependency.
clinchAn OpenGL Game Engine.
Brad Beer (WarWeasle)
MIT
0.5
cl-opengl (system).
trivial-garbage (system).
bordeaux-threads (system).
trivial-channels (system).
sdl2 (system).
rtg-math (system).
swank (system).
package.lisp (file).
threads.lisp (file).
clinch.lisp (file).
transform.lisp (file).
node.lisp (file).
shaders.lisp (file).
shader-program.lisp (file).
default-shaders.lisp (file).
buffer.lisp (file).
index-buffer.lisp (file).
pixel-buffer.lisp (file).
texture.lisp (file).
2d-node.lisp (file).
entity.lisp (file).
viewport.lisp (file).
framebuffer.lisp (file).
animation.lisp (file).
window.lisp (file).
shapes.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
clinch/clinch.asdclinch/package.lispclinch/threads.lispclinch/clinch.lispclinch/transform.lispclinch/node.lispclinch/shaders.lispclinch/shader-program.lispclinch/default-shaders.lispclinch/buffer.lispclinch/index-buffer.lispclinch/pixel-buffer.lispclinch/texture.lispclinch/2d-node.lispclinch/entity.lispclinch/viewport.lispclinch/framebuffer.lispclinch/animation.lispclinch/window.lispclinch/shapes.lispclinch/threads.lisppackage.lisp (file).
clinch (system).
clinch/clinch.lispthreads.lisp (file).
clinch (system).
! (macro).
!! (macro).
*context* (special variable).
*entity* (special variable).
*node* (special variable).
*ortho-projection* (special variable).
*projection* (special variable).
*texture* (special variable).
*uncollected* (special variable).
*viewport* (special variable).
*window* (special variable).
decompose-transform (function).
ray-triangle-intersect? (function).
topological-sort (function).
unload (generic function).
unload-all-uncollected (function).
*current-shader-attributes* (special variable).
*current-shader-uniforms* (special variable).
*dependents* (special variable).
*inited* (special variable).
*running* (special variable).
*shaders->shader-programs* (special variable).
add-dependent (function).
add-uncollected (function).
clone-function (macro).
get-intersections (function).
get-point (function).
make-list-length (function).
merge-hashes (function).
midpoint (function).
normalize-for-3d (function).
ray-triangles-intersect (function).
remove-dependent (function).
remove-uncollected (function).
separate (function).
set-assoc-name (function).
set-assoc-value (function).
split-keywords (function).
transform-tree (function).
unload-all-dependants (function).
unload-dependent (function).
clinch/transform.lispclinch.lisp (file).
clinch (system).
+pi+ (constant).
d->r (macro).
degrees->radians (macro).
ensure-float (macro).
get-screen-direction (function).
make-frustum-transform (function).
make-orthogonal-transform (function).
make-perspective-transform (function).
r->d (macro).
radians->degrees (macro).
transform-point (function).
transform-points (function).
unproject (function).
get-point-by-index (function).
set-point-by-index (function).
clinch/node.lisptransform.lisp (file).
clinch (system).
!r (macro).
!s (macro).
!t (macro).
*root* (special variable).
add-child (method).
changed? (method).
(setf changed?) (method).
children (reader method).
(setf children) (writer method).
enabled (reader method).
(setf enabled) (writer method).
initialize-instance (method).
n* (generic function).
name (reader method).
(setf name) (writer method).
node (class).
print-object (method).
remove-child (method).
render (method).
render (method).
rotate (generic function).
rotation (reader method).
(setf rotation) (generic function).
scale (generic function).
scaling (reader method).
(setf scaling) (generic function).
transform (generic function).
(setf transform) (method).
translate (generic function).
translation (reader method).
(setf translation) (generic function).
traverse-node (method).
update (method).
walk-node-tree (method).
walk-node-tree (method).
with-new-node (macro).
with-node (macro).
current-transform (reader method).
node-top-map (method).
node-top-map-string (method).
reset (generic function).
reset-rotation (generic function).
reset-scaling (generic function).
reset-translation (generic function).
rotation-matrix (generic function).
scale-matrix (generic function).
translation-matrix (generic function).
v0 (special variable).
vi (special variable).
clinch/shaders.lispnode.lisp (file).
clinch (system).
id (reader method).
initialize-instance (method).
name (reader method).
shader-compile (method).
shader-source (method).
(setf shader-source) (method).
unload (method).
add-finalizer (method).
fragment-shader (class).
geometry-shader (class).
key (reader method).
make-shader (method).
make-shader (method).
make-shader (method).
shader (class).
shader-attributes (reader method).
shader-type (reader method).
shader-uniforms (reader method).
vertex-shader (class).
clinch/shader-program.lispshaders.lisp (file).
clinch (system).
attach-uniform (method).
attach-uniform (method).
attach-uniform (method).
bind-static-values-to-attribute (method).
get-attribute-id (method).
get-attribute-id (method).
get-uniform-id (method).
get-uniform-id (method).
initialize-instance (method).
name (reader method).
program (reader method).
pullg (method).
shader-program (class).
unload (method).
use-shader-program (method).
attach-shader (method).
build-shader-program (method).
build-shader-program (method).
detach-shader (method).
find-shader-attributes (method).
find-shader-uniforms (method).
key (reader method).
list-raw-shader-attributes (method).
list-shader-attributes (method).
list-shader-uniforms (method).
remove-shader-program-attribute (method).
remove-shader-program-uniform (method).
remove-shader-value-suffix (function).
remove-shader-value-type-suffix (function).
shader-program-attribute (method).
(setf shader-program-attribute) (method).
shader-program-attributes (reader method).
shader-program-uniform (method).
(setf shader-program-uniform) (method).
shader-program-uniforms (reader method).
clinch/default-shaders.lispshader-program.lisp (file).
clinch (system).
get-generic-per-vertex-color-shader (function).
get-generic-single-color-shader (function).
get-generic-single-diffuse-light-animation-shader (function).
get-generic-single-diffuse-light-per-vertex-color-shader (function).
get-generic-single-diffuse-light-shader (function).
get-generic-single-texture-shader (function).
get-generic-solid-phong-shader (function).
*generic-shader-hash-table* (special variable).
define-default-shader (macro).
clinch/buffer.lispdefault-shaders.lisp (file).
clinch (system).
(setf !>) (method).
bind (method).
bind-buffer-to-attribute-array (method).
bind-buffer-to-vertex-array (method).
buffer (class).
data-from-pointer (method).
get-size (method).
id (reader method).
initialize-instance (method).
map-buffer (method).
pullg (generic function).
pushg (generic function).
qtype (reader method).
(setf qtype) (writer method).
size-in-bytes (method).
stride (reader method).
target (reader method).
unbind (method).
unload (method).
unmap-buffer (method).
usage (reader method).
(setf usage) (writer method).
vertex-count (reader method).
with-mapped-buffer (macro).
bind-buffer-to-normal-array (method).
cffi-type->gl-type (function).
key (reader method).
loaded? (reader method).
(setf loaded?) (writer method).
make-shareable-array (method).
unbind-buffer-attribute-array (method).
unbind-normal-array (method).
unbind-vertex-array (method).
clinch/index-buffer.lispbuffer.lisp (file).
clinch (system).
draw-with-index-buffer (method).
draw-with-ranged-index-buffer (method).
id (reader method).
index-buffer (class).
qtype (reader method).
(setf qtype) (writer method).
stride (reader method).
target (reader method).
usage (reader method).
(setf usage) (writer method).
vertex-count (reader method).
key (reader method).
loaded? (reader method).
(setf loaded?) (writer method).
clinch/pixel-buffer.lispindex-buffer.lisp (file).
clinch (system).
pixel-buffer (class).
clinch/texture.lisppixel-buffer.lisp (file).
clinch (system).
bind (method).
bind-sampler (method).
data-format (reader method).
(setf data-format) (writer method).
data-from-pointer (method).
get-identity-texture (function).
get-size (method).
height (reader method).
initialize-instance (method).
make-pbo-for-texture (method).
pullg (method).
pushg (method).
pushg (method).
qtype (reader method).
(setf qtype) (writer method).
set-texture-color (method).
size-in-bytes (method).
stride (reader method).
tex-id (reader method).
(setf tex-id) (writer method).
texture (class).
unbind (method).
unload (method).
width (reader method).
with-temporary-pbo (macro).
*default-texture* (special variable).
*identity-texture* (special variable).
data-from-list (method).
internal-format (reader method).
(setf internal-format) (writer method).
key (reader method).
with-texture (macro).
clinch/2d-node.lisptexture.lisp (file).
clinch (system).
clinch/entity.lisp2d-node.lisp (file).
clinch (system).
attribute (method).
(setf attribute) (method).
attributes (reader method).
enabled (reader method).
(setf enabled) (writer method).
entity (class).
indexes (reader method).
(setf indexes) (method).
initialize-instance (method).
print-object (method).
ray-entity-intersect? (method).
render (method).
shader-program (reader method).
(setf shader-program) (method).
uniform (method).
(setf uniform) (method).
uniforms (reader method).
unload (method).
update (method).
with-attributes (macro).
with-uniforms (macro).
bones (reader method).
(setf bones) (writer method).
convert-non-buffer (function).
mode (reader method).
clinch/viewport.lispentity.lisp (file).
clinch (system).
clear-color (reader method).
(setf clear-color) (writer method).
height (reader method).
(setf height) (writer method).
initialize-instance (method).
quick-set (method).
render (method).
resize (method).
viewport (class).
width (reader method).
(setf width) (writer method).
x (reader method).
(setf x) (writer method).
y (reader method).
(setf y) (writer method).
with-viewport (macro).
clinch/framebuffer.lispviewport.lisp (file).
clinch (system).
*fbo* (special variable).
bind (method).
bind (method).
color-attachment (method).
(setf color-attachment) (method).
depth-buffer (reader method).
(setf depth-buffer) (method).
frame-buffer (class).
id (reader method).
initialize-instance (method).
make-color-texture (method).
make-depth-texture (method).
target (reader method).
(setf target) (writer method).
unbind (method).
unload (method).
with-fbo (macro).
add-color-buffer (method).
color-attachment-0 (constant).
color-attachments (reader method).
key (reader method).
stencil-attachments (reader method).
clinch/animation.lispframebuffer.lisp (file).
clinch (system).
animation (reader method).
(setf animation) (writer method).
animation (class).
animator (class).
frames (reader method).
(setf frames) (writer method).
get-animation-time (method).
get-animation-time (method).
get-animation-time (method).
get-animation-time (method).
get-animation-time (method).
get-keyframe (method).
get-keyframe (method).
get-keyframe (method).
get-keyframe (method).
get-keyframe (method).
name (reader method).
(setf name) (writer method).
pause (generic function).
paused (reader method).
(setf paused) (writer method).
play (generic function).
render (method).
repeat (reader method).
repeat (reader method).
(setf repeat) (writer method).
(setf repeat) (writer method).
run-length (reader method).
run-length (reader method).
(setf run-length) (writer method).
(setf run-length) (writer method).
run-speed (reader method).
(setf run-speed) (writer method).
skip (generic function).
stop (generic function).
update (method).
current-time (reader method).
(setf current-time) (writer method).
clinch/window.lispanimation.lisp (file).
clinch (system).
*controllers* (special variable).
*default-on-idle* (special variable).
*default-on-idle* (function).
*delta-ticks* (special variable).
*haptic* (special variable).
*next* (special variable).
*on-controller-added* (special variable).
*on-controller-axis-move* (special variable).
*on-controller-button-down* (special variable).
*on-controller-button-up* (special variable).
*on-controller-remapped* (special variable).
*on-controller-removed* (special variable).
*on-idle* (special variable).
*on-key-down* (special variable).
*on-key-up* (special variable).
*on-mouse-click* (special variable).
*on-mouse-double-click* (special variable).
*on-mouse-down* (special variable).
*on-mouse-move* (special variable).
*on-mouse-up* (special variable).
*on-mouse-wheel-move* (special variable).
*on-quit* (special variable).
*on-text-editing* (special variable).
*on-text-input* (special variable).
*on-window-close* (special variable).
*on-window-enter* (special variable).
*on-window-exposed* (special variable).
*on-window-focus-gained* (special variable).
*on-window-focus-lost* (special variable).
*on-window-hidden* (special variable).
*on-window-leave* (special variable).
*on-window-maximized* (special variable).
*on-window-minimized* (special variable).
*on-window-moved* (special variable).
*on-window-resized* (special variable).
*on-window-restored* (special variable).
*on-window-size-changed* (special variable).
*ticks* (special variable).
defevent (macro).
init (function).
uninit (function).
*startup-condition* (special variable).
*startup-lock* (special variable).
_init (function).
continuable (macro).
ensure-cepl-compatible-setup (function).
fire (macro).
force-print (macro).
init-controllers (function).
main-loop (function).
print-sdl-version (function).
set-default-gl-options (function).
uninit-controllers (function).
update-swank (function).
with-main (macro).
clinch/shapes.lispwindow.lisp (file).
clinch (system).
get-default-texture (function).
make-quad (function).
make-quad-and-texture (method).
make-quad-for-texture (method).
average-vectors (macro).
delete-entity (method).
get-box-vertex-normal-texture-and-index-buffers (function).
get-cylinder-vertex-normal-and-index-buffers (function).
get-height-node-normal (function).
get-height-node-normals (function).
get-middle-square-and-normal (function).
get-middle-squares-and-normals (function).
get-point-or-vert (function).
get-sphere-vertex-normal-and-index-buffers (function).
heightmap->buffers (function).
make-box (function).
make-cylinder (function).
make-dummy-entity (function).
make-heightmap-entity (function).
make-quad-indices (function).
make-quad-texture-coordinates (function).
make-quad-vertexes (function).
make-sphere (function).
random-heightfield (function).
set-point (function).
tst (function).
Packages are listed by definition order.
clinchcommon-lisp.
! (macro).
!! (macro).
!0 (generic function).
!< (generic function).
!> (generic function).
(setf !>) (generic function).
!r (macro).
!r0 (generic function).
!s (macro).
!s0 (generic function).
!t (macro).
!t0 (generic function).
*context* (special variable).
*controllers* (special variable).
*default-on-idle* (special variable).
*default-on-idle* (function).
*delta-ticks* (special variable).
*entity* (special variable).
*fbo* (special variable).
*haptic* (special variable).
*next* (special variable).
*node* (special variable).
*on-controller-added* (special variable).
*on-controller-axis-move* (special variable).
*on-controller-button-down* (special variable).
*on-controller-button-up* (special variable).
*on-controller-remapped* (special variable).
*on-controller-removed* (special variable).
*on-idle* (special variable).
*on-key-down* (special variable).
*on-key-up* (special variable).
*on-mouse-click* (special variable).
*on-mouse-double-click* (special variable).
*on-mouse-down* (special variable).
*on-mouse-move* (special variable).
*on-mouse-up* (special variable).
*on-mouse-wheel-move* (special variable).
*on-quit* (special variable).
*on-text-editing* (special variable).
*on-text-input* (special variable).
*on-window-close* (special variable).
*on-window-enter* (special variable).
*on-window-exposed* (special variable).
*on-window-focus-gained* (special variable).
*on-window-focus-lost* (special variable).
*on-window-hidden* (special variable).
*on-window-leave* (special variable).
*on-window-maximized* (special variable).
*on-window-minimized* (special variable).
*on-window-moved* (special variable).
*on-window-resized* (special variable).
*on-window-restored* (special variable).
*on-window-size-changed* (special variable).
*ortho-projection* (special variable).
*projection* (special variable).
*root* (special variable).
*texture* (special variable).
*ticks* (special variable).
*uncollected* (special variable).
*viewport* (special variable).
*window* (special variable).
+pi+ (constant).
add-child (generic function).
animation (generic reader).
(setf animation) (generic writer).
animation (class).
animator (class).
attach-uniform (generic function).
attribute (generic function).
(setf attribute) (generic function).
attributes (generic reader).
bind (generic function).
bind-buffer-to-attribute-array (generic function).
bind-buffer-to-vertex-array (generic function).
bind-sampler (generic function).
bind-static-values-to-attribute (generic function).
buffer (class).
changed? (generic function).
(setf changed?) (generic function).
children (generic reader).
(setf children) (generic writer).
clear-color (generic reader).
(setf clear-color) (generic writer).
color-attachment (generic function).
(setf color-attachment) (generic function).
d->r (macro).
data-format (generic reader).
(setf data-format) (generic writer).
data-from-pointer (generic function).
decompose-transform (function).
defevent (macro).
degrees->radians (macro).
depth-buffer (generic reader).
(setf depth-buffer) (generic function).
draw-with-index-buffer (generic function).
draw-with-ranged-index-buffer (generic function).
enabled (generic reader).
(setf enabled) (generic writer).
ensure-float (macro).
entity (class).
frame-buffer (class).
frames (generic reader).
(setf frames) (generic writer).
get-animation-time (generic function).
get-attribute-id (generic function).
get-default-texture (function).
get-generic-per-vertex-color-shader (function).
get-generic-single-color-shader (function).
get-generic-single-diffuse-light-animation-shader (function).
get-generic-single-diffuse-light-per-vertex-color-shader (function).
get-generic-single-diffuse-light-shader (function).
get-generic-single-texture-shader (function).
get-generic-solid-phong-shader (function).
get-identity-texture (function).
get-keyframe (generic function).
get-screen-direction (function).
get-size (generic function).
get-uniform-id (generic function).
height (generic reader).
(setf height) (generic writer).
id (generic reader).
index-buffer (class).
indexes (generic reader).
(setf indexes) (generic function).
init (function).
make-color-texture (generic function).
make-depth-texture (generic function).
make-frustum-transform (function).
make-orthogonal-transform (function).
make-pbo-for-texture (generic function).
make-perspective-transform (function).
make-quad (function).
make-quad-and-texture (generic function).
make-quad-for-texture (generic function).
map-buffer (generic function).
n* (generic function).
name (generic reader).
(setf name) (generic writer).
node (class).
pause (generic function).
paused (generic reader).
(setf paused) (generic writer).
play (generic function).
program (generic reader).
pullg (generic function).
pushg (generic function).
qtype (generic reader).
(setf qtype) (generic writer).
quick-set (generic function).
r->d (macro).
radians->degrees (macro).
ray-entity-intersect? (generic function).
ray-triangle-intersect? (function).
remove-child (generic function).
render (generic function).
repeat (generic reader).
(setf repeat) (generic writer).
resize (generic function).
rotate (generic function).
rotation (generic reader).
(setf rotation) (generic function).
run-length (generic reader).
(setf run-length) (generic writer).
run-speed (generic reader).
(setf run-speed) (generic writer).
scale (generic function).
scaling (generic reader).
(setf scaling) (generic function).
set-texture-color (generic function).
shader-compile (generic function).
shader-program (generic reader).
(setf shader-program) (generic function).
shader-program (class).
shader-source (generic function).
(setf shader-source) (generic function).
size-in-bytes (generic function).
skip (generic function).
stop (generic function).
stride (generic reader).
target (generic reader).
(setf target) (generic writer).
tex-id (generic reader).
(setf tex-id) (generic writer).
texture (class).
topological-sort (function).
transform (generic function).
(setf transform) (generic function).
transform-point (function).
transform-points (function).
translate (generic function).
translation (generic reader).
(setf translation) (generic function).
traverse-node (generic function).
unbind (generic function).
uniform (generic function).
(setf uniform) (generic function).
uniforms (generic reader).
uninit (function).
unload (generic function).
unload-all-uncollected (function).
unmap-buffer (generic function).
unproject (function).
update (generic function).
usage (generic reader).
(setf usage) (generic writer).
use-shader-program (generic function).
vertex-count (generic reader).
viewport (class).
walk-node-tree (generic function).
width (generic reader).
(setf width) (generic writer).
with-attributes (macro).
with-fbo (macro).
with-mapped-buffer (macro).
with-new-node (macro).
with-node (macro).
with-temporary-pbo (macro).
with-uniforms (macro).
x (generic reader).
(setf x) (generic writer).
y (generic reader).
(setf y) (generic writer).
$ (macro).
$> (function).
*current-shader-attributes* (special variable).
*current-shader-uniforms* (special variable).
*default-texture* (special variable).
*dependents* (special variable).
*generic-shader-hash-table* (special variable).
*identity-texture* (special variable).
*inited* (special variable).
*running* (special variable).
*shaders->shader-programs* (special variable).
*startup-condition* (special variable).
*startup-lock* (special variable).
2d-node (class).
_init (function).
add-color-buffer (generic function).
add-dependent (function).
add-finalizer (generic function).
add-uncollected (function).
attach-shader (generic function).
average-vectors (macro).
bind-buffer-to-normal-array (generic function).
bones (generic reader).
(setf bones) (generic writer).
build-shader-program (generic function).
cffi-type->gl-type (function).
clone-function (macro).
color-attachment-0 (constant).
color-attachments (generic reader).
continuable (macro).
convert-non-buffer (function).
current-time (generic reader).
(setf current-time) (generic writer).
current-transform (generic reader).
data-from-list (generic function).
define-default-shader (macro).
delete-entity (generic function).
detach-shader (generic function).
ensure-cepl-compatible-setup (function).
find-shader-attributes (generic function).
find-shader-uniforms (generic function).
fire (macro).
force-print (macro).
fragment-shader (class).
geometry-shader (class).
get-box-vertex-normal-texture-and-index-buffers (function).
get-cylinder-vertex-normal-and-index-buffers (function).
get-height-node-normal (function).
get-height-node-normals (function).
get-intersections (function).
get-middle-square-and-normal (function).
get-middle-squares-and-normals (function).
get-point (function).
get-point-by-index (function).
get-point-or-vert (function).
get-sphere-vertex-normal-and-index-buffers (function).
heightmap->buffers (function).
init-controllers (function).
internal-format (generic reader).
(setf internal-format) (generic writer).
key (generic reader).
list-raw-shader-attributes (generic function).
list-shader-attributes (generic function).
list-shader-uniforms (generic function).
loaded? (generic reader).
(setf loaded?) (generic writer).
main-loop (function).
make-box (function).
make-cylinder (function).
make-dummy-entity (function).
make-heightmap-entity (function).
make-list-length (function).
make-quad-indices (function).
make-quad-texture-coordinates (function).
make-quad-vertexes (function).
make-shader (generic function).
make-shareable-array (generic function).
make-sphere (function).
merge-hashes (function).
midpoint (function).
mode (generic reader).
node-top-map (generic function).
node-top-map-string (generic function).
normalize-for-3d (function).
pixel-buffer (class).
print-sdl-version (function).
random-heightfield (function).
ray-triangles-intersect (function).
remove-dependent (function).
remove-shader-program-attribute (generic function).
remove-shader-program-uniform (generic function).
remove-shader-value-suffix (function).
remove-shader-value-type-suffix (function).
remove-uncollected (function).
reset (generic function).
reset-rotation (generic function).
reset-scaling (generic function).
reset-translation (generic function).
rotation-matrix (generic function).
scale-matrix (generic function).
separate (function).
set-assoc-name (function).
set-assoc-value (function).
set-default-gl-options (function).
set-point (function).
set-point-by-index (function).
shader (class).
shader-attributes (generic reader).
shader-program-attribute (generic function).
(setf shader-program-attribute) (generic function).
shader-program-attributes (generic reader).
shader-program-uniform (generic function).
(setf shader-program-uniform) (generic function).
shader-program-uniforms (generic reader).
shader-type (generic reader).
shader-uniforms (generic reader).
split-keywords (function).
stencil-attachments (generic reader).
transform-tree (function).
translation-matrix (generic function).
tst (function).
unbind-buffer-attribute-array (generic function).
unbind-normal-array (generic function).
unbind-vertex-array (generic function).
uninit-controllers (function).
unload-all-dependants (function).
unload-dependent (function).
update-swank (function).
v0 (special variable).
v20 (special variable).
v2i (special variable).
vertex-shader (class).
vi (special variable).
with-main (macro).
with-texture (macro).
with-viewport (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Global Opengl Contex object.
An alist of discovered controllers. Format: (controller-id . sdl-controller-handle)
The default on-idle handler. Mapped as both a function and a variable.
Change in time (delta time, dt) since the last on-idle call.
The current entity
Current Frame Buffer Object.
An alist of discovered haptic feedback devices. Format: (controller-id . sdl-haptic-device-handle)
Runs before the next on-idle call. No arguments.
Current default node.
Called when a new controller is discovered. Arguments: (controller-id axis-id value timestamp)
Called when a controller’s axis moves. Arguments (controller-id axis-id position timestamp)
Called when a controller’s button is pressed. Arguments: (controller-id axis-id value timestamp)
Called when a controller’s button is released. Arguments: (controller-id axis-id value timestamp)
Called when a controller is remapped. Arguments: (window data1 data2 timestamp)
Called when a controller is removed. Arguments: (window data1 data2 timestamp)
Called when there are no pending events. Take no arguments. Default can be overridden.
Called when a key is pressed. Arguments (win keysym state ts)
Called when a key is released. Arguments (win keysym state ts)
Called when mouse button is released. Arguments: (win mouse x y button state clicks ts)
Called when mouse button is pressed. Arguments: (win mouse x y button state clicks ts)
Called when mouse is moved. Arguments (win mouse state x y xrel yrel ts)
Called when mouse button is released. Arguments: (win mouse x y button state clicks ts)
Called when the mouse wheel is moved. Arguments: (win mouse x y ts)
Called when clinch is about to exit. Take no arguments.
Called when editing text.
Call when text input happens.
Called when window is closing. Arguments (window timestamp)
Called when window gains mouse focus. Arguments (window timestamp)
Called when window is exposed and need redrawn. Arguments (window timestamp)
Called when window gains focus. Arguments (window timestamp)
Called when window loses focus. Arguments (window timestamp)
Called when window is loses mouse focus. Arguments (window timestamp)
Called when window is maximized. Arguments (window timestamp)
Called when window is minimized. Arguments (window timestamp)
Called when the window has been moved. Arguments (window x y timestamp)
Always called when window size changes. Arguments (window width height timestamp)
Called when window is restored to normal position and size. Arguments (window timestamp)
Always called when window size changes. Arguments (window width height timestamp)
An automatically generated orthogonal projection for the window. Pixel to pixel.
Current default projection.
The current texture. Defaults to the window’s overlay.
Time elapsed since (init) in milliseconds.
Weak hash of loaded OpenGL objects.
Current viewport object.
Global window object.
Runs body in main thread for safe OpenGL calls. Waits for return value.
Runs body in main thread for safe OpenGL calls. Returns immediately.
Converts degrees to radians.
Creates and updates an event handler. Use this for all your *on-* events. It’s just a nice wrapper around (setf event (lambda ...
Converts degrees to radians.
Coerce a number to a single-float.
Converts radians to degrees.
Converts radians to degrees.
Convenience macro for useing and resetting an FBO.
Convenience macro for mapping and unmapping the buffer data. Name is the symbol name to use for the buffer pointer.
A wrapper which creates a new node and set it as current.
A wrapper which sets and unsets the current *node* object.
Creates a temporary pixel buffer for a texture.
Decomposes a matrix into it’s position vector3, rotation quaterion and scaling vector3. Useful for creating/updating the node object.
Creates/returns a shader-program which blits a texture to an entity.
Uniforms:
P: projection matrix
M: model-view matrix
t1: texture
Attributes:
v: Vertexes
tc1: texture coordinates
Creates/returns a shader-program which uses simple phong shading with a single color.
Uniforms:
P: projection matrix
M: model-view matrix
ambientLight: Ambient Light Color
lightDirection: Direction of light
lightIntensity: Color of light
color: color of object
Attributes:
v: Vertexes
Creates/returns a 1x1 texture with the values (1.0, 1.0, 1.0, 1.0). This is a nice placeholder when you don’t want a custom shader.
Gets the direction from the middle of the screen.
Creates Clinch’s window in it’s own thread.
Use ! (wait and return a value from main thread) or
Use !! (return immediately with a nil.
Create a raw CFFI frustum matrix.
Create a raw CFFI orthogonal matrix.
Create a raw CFFI perspective matrix.
Creates a quad entity of width and height.
Given an origin, direction and a triangle returns if and where they intersect. Presently does not cull backfacing triangles.
Graph is an association list whose keys are objects and whose values are lists of objects on which the corresponding key depends. Test is used to compare elements, and should be a suitable test for hash-tables. Topological-sort returns two values. The first is a list of objects sorted toplogically. The second is a boolean indicating whether all of the objects in the input graph are present in the topological ordering (i.e., the first value).
Unloads all loaded OpenGL objects.
Unproject from the screen to transform space.
Resets a node to default. Position 0, rotation 0 and scale of 1. Shortcut is !0.
Resets a node’s rotation to 1,0,0,0. Shortcut is !r0
Resets a node’s scaling to 1,1,1. Shortcut is !s0
Resets a node’s translation to 0,0,0. Shortcut is !t0
shader-program) (uniform string) (matrix node)) ¶Shaders pass information by using named values called Uniforms and Attributes. This sets a uniform to the matrix of a node.
shader-program) (uniform string) (matrix array)) ¶Shaders pass information by using named values called Uniforms and Attributes. This sets a uniform to a matrix value.
shader-program) (uniform string) value) ¶Shaders pass information by using named values called Uniforms and Attributes. This sets a uniform to value.
null) &key) ¶Binds the frame buffer for use.
frame-buffer) &key) ¶Wrapper around glBindFrameBuffer. Puts the Framebuffer into play.
texture) &key) ¶Wrapper around glBindBuffer. Puts the texture into play.
buffer) (shader shader-program) name &key index offset length) ¶Bind buffer to a shader attribute.
shader-program) name vals) ¶It is possible to bind static information to an attribute. That’s what this does.
frame-buffer) name) ¶Returns a color-attachment by number.
frame-buffer) name) ¶Sets an attachment’s number
frame-buffer)) ¶automatically generated reader method
frame-buffer)) ¶Binds the depth buffer for use.
index-buffer) &key mode) ¶Use this buffer as an index array and draw somthing.
index-buffer) &key start end mode) ¶Use this buffer as an index array and draw somthing within start and end bounds.
shader-program) (attribute string)) ¶Shaders pass information by using named values called Uniforms and Attributes. This gets the gl id of a attribute name.
shader-program) (id integer)) ¶Shaders pass information by using named values called Uniforms and Attributes. If we are using the raw id, this returns it.
vector) (time number) &key) ¶list) (time number) &key) ¶shader-program) (uniform string)) ¶Shaders pass information by using named values called Uniforms and Attributes. This gets the gl id of a uniform name.
shader-program) (id integer)) ¶Shaders pass information by using named values called Uniforms and Attributes. If we are using the raw id, this returns it.
frame-buffer)) ¶automatically generated reader method
id.
index-buffer)) ¶automatically generated reader method
id.
frame-buffer) index width height &key pbo stride qtype internal-format format wrap-s wrap-t mag-filter min-filter texture-compare-mode texture-compare-function) ¶Creates and adds a color buffer for the frame buffer.
frame-buffer) width height &key internal-format format qtype stride depth-texture-mode texture-compare-mode texture-compare-function) ¶Creates a depth texture for a framebuffer.
Multiplies nodes and matrix transforms.
vector) (that vector) &key new-node) ¶Multiplies a node? I’m not sure if this works.
node) (that vector) &key new-node) ¶Multiplies a node? I’m not sure if this works.
animation)) ¶automatically generated reader method
name.
shader-program)) ¶automatically generated reader method
name.
shader-program)) ¶automatically generated reader method
shader-program) &key) ¶Returns shader-program’s available information such as shader source, uniforms and attributes.
texture) (pbo pixel-buffer) &key) ¶Sets the texture data from a pixel buffer.
texture)) ¶automatically generated reader method
type.
index-buffer)) ¶automatically generated reader method
type.
texture)) ¶automatically generated writer method
type.
index-buffer)) ¶automatically generated writer method
type.
Rotate node. Shortcut is !r.
Scale node. Shortcut is !s.
texture)) ¶automatically generated reader method
index-buffer)) ¶automatically generated reader method
frame-buffer)) ¶automatically generated reader method
index-buffer)) ¶automatically generated reader method
frame-buffer)) ¶automatically generated writer method
get the entire transform.
Translate node. Shortcut is !t.
frame-buffer) &key) ¶Wrapper around glBindFrameBuffer. Puts the Framebuffer into play.
Unloads an opengl object. Does nothing for non-opengl objects.
frame-buffer) &key) ¶Unloads and releases all frame-buffer resources, also any renderbuffers
entity) &key all) ¶Release entity resources. If :all t, then the index buffer and all uniforms and attributes are unloaded.
shader-program) &key) ¶Unloads and releases all shader-program resources.
index-buffer)) ¶automatically generated reader method
index-buffer)) ¶automatically generated writer method
shader-program) &key) ¶Start using the shader-program.
index-buffer)) ¶automatically generated reader method
node) &key translation rotation scale copy matrix parent) ¶Creates a node with optional translation (vector3), rotation (quaterion) and scaling (vector3). Can also use another node or matrix to set its value. If a node and another value is give, the other value is used starting with the matrix.
buffer) &key data) ¶Sets up a buffer instance.
type: cffi type NOTE: Use the index buffer for indices.
id: OpenGL buffer id
vcount: vertex count (or number of tuples if not using vertexes)
stride: The number of items in each vertex (or each tuple.) NOTE: use 1 if you are creating an index buffer.
target: OpenGL buffer target. If you use this, think about subclassing. For more info lookup glBindBuffer().
NOTE: use :element-array-buffer if you are creating an index buffer.
usage: Tells OpenGL how often you wish to access the buffer.
loaded: Has data been put into the buffer. Buffers without data is just future storage, just be sure to set it before you use it.
data: The data with which to fill the buffer. If data has a size, vcount does not need to be set.
entity) &key compile parent strict-index) ¶Creates an entity.
:parent adds itself to the given parent. The entity doesn’t keep track of its parent. (t means the root node)
:indexes sets the index buffer. Required.
:mode sets what kind of object (triangle, square, etc) will be drawn. Only triangles are tested.
:uniforms sets the uniform values as an alist.
:attributes sets the attribute values as an alist.
:shader-program sets the shader program.
:enabled sets if this entity will render.
texture) &key pbo wrap-s wrap-t mag-filter min-filter depth-texture-mode texture-compare-mode texture-compare-function data) ¶Sets up a texture instance with gc finalizer. Do not depend on finalizers, release resources manually if you can.
type: cffi type NOTE: use :unsigned-int if you are creating an index buffer.
id: OpenGL buffer id
stride: The number of values in each pixel.
usage: Tells OpenGL how often you wish to access the buffer.
loaded: Has data been put into the buffer. Buffers without data is just future storage, just be sure to set it before you use it.
format: The OpenGL Format of the Color Data. blue-green-red-alpha is default and prefered for simplicity.
wrap-s & wrap-t: Wrap texture vertical or horizontal.
mag-filter & min-filter: Magnification an minimization method.
frame-buffer) &key color-attachments depth-attachment stencil-attachment) ¶Creates an FBO with optional color attachments, depth-attachements and stencil attachments.
shader-program) &key vertex-shader fragment-shader geometry-shader name attributes uniforms defines undefs delete-shaders) ¶Create the shader program. Currently there is no way to change the shader. You must make a new one.
:animation
0
:start
t
:paused
t
:repeat
1
:run-speed
:run-length
Creates and keeps track of GPU buffer object (shared memory with gpu).
(setf !>).
bind.
bind-buffer-to-attribute-array.
bind-buffer-to-normal-array.
bind-buffer-to-vertex-array.
data-from-pointer.
get-size.
id.
initialize-instance.
key.
(setf loaded?).
loaded?.
make-shareable-array.
map-buffer.
pullg.
pushg.
(setf qtype).
qtype.
size-in-bytes.
stride.
target.
unbind.
unbind-buffer-attribute-array.
unload.
unmap-buffer.
(setf usage).
usage.
vertex-count.
common-lisp.
:float
:qtype
:static-draw
:usage
:count
This slot is read-only.
:array-buffer
:target
This slot is read-only.
Renders a mesh with a shader-program with attributes and uniforms.
:shader-program
This slot is read-only.
:attributes
This slot is read-only.
:bones
t
:enabled
The Frame Buffer Object or FBO. Use this to render to textures.
:draw-framebuffer
:target
This slot is read-only.
:depth-buffer
This slot is read-only.
This slot is read-only.
Creates and keeps track of GPU index buffer object (shared memory with gpu).
common-lisp.
:unsigned-int
:qtype
:static-draw
clinch:usage
:count
This slot is read-only.
:element-array-buffer
:target
This slot is read-only.
A node class for creating hierarchies of objects. It caches calculations for speed. Not enough in itself, and is not required by Clinch.
add-child.
attach-uniform.
(setf changed?).
changed?.
(setf children).
children.
current-transform.
(setf enabled).
enabled.
initialize-instance.
n*.
n*.
n*.
(setf name).
name.
node-top-map.
node-top-map-string.
print-object.
remove-child.
render.
reset.
reset-rotation.
reset-scaling.
reset-translation.
rotate.
(setf rotation).
rotation.
rotation-matrix.
scale.
scale-matrix.
(setf scaling).
scaling.
transform.
(setf transform).
translate.
(setf translation).
translation.
translation-matrix.
traverse-node.
update.
walk-node-tree.
clinch::v0
:translation
This slot is read-only.
(rtg-math.quaternions:identity)
:rotation
This slot is read-only.
This slot is read-only.
t
:enabled
:children
Creates and keeps track of the shader-program objects. Requires an UNLOAD call when you are done. Bind Buffer functions are in Buffer.l
attach-shader.
attach-uniform.
attach-uniform.
attach-uniform.
bind-buffer-to-attribute-array.
bind-static-values-to-attribute.
build-shader-program.
detach-shader.
find-shader-attributes.
find-shader-uniforms.
get-attribute-id.
get-attribute-id.
get-uniform-id.
get-uniform-id.
initialize-instance.
key.
list-raw-shader-attributes.
list-shader-attributes.
list-shader-uniforms.
name.
program.
pullg.
remove-shader-program-attribute.
remove-shader-program-uniform.
(setf shader-program-attribute).
shader-program-attribute.
shader-program-attributes.
(setf shader-program-uniform).
shader-program-uniform.
shader-program-uniforms.
unbind-buffer-attribute-array.
unload.
use-shader-program.
This slot is read-only.
This slot is read-only.
Creates and keeps track of a texture object. Can be used with a pixelbuffer to speed things up.
add-color-buffer.
bind.
bind-sampler.
(setf data-format).
data-format.
data-from-list.
data-from-pointer.
(setf depth-buffer).
get-size.
height.
initialize-instance.
(setf internal-format).
internal-format.
key.
make-pbo-for-texture.
make-quad-for-texture.
pullg.
pushg.
pushg.
(setf qtype).
qtype.
set-texture-color.
size-in-bytes.
stride.
(setf tex-id).
tex-id.
unbind.
unload.
width.
:tex-id
common-lisp.
:unsigned-char
:qtype
:rgba
:internal-format
:bgra
:format
Creates a viewport.
Weak hash of OpenGL objects waiting to be unloaded by another.
Helper macro that we can use to allow us to continue from an
error. Remember to hit C in slime or pick the restart so errors don’t kill the app.
Enables REPL access via UPDATE-SWANK in the main loop using SDL2. Wrap this around the sdl2:with-init code.
A wrapper which sets and unsets a viewport.
Adds item to list of loaded OpenGL objects.
Returns the buffer type as a cffi type.
Removes item from list of loaded OpenGL objects. Does NOT call unload.
I think this is a tree walker which applies a function to a clinch node tree.
Called from within the main loop, this keep the lisp repl working while cepl runs
frame-buffer) index (tex texture)) ¶Add a color buffer at position index.
shader-program) (shader shader)) ¶shader-program) &key vertex-shader fragment-shader geometry-shader attributes uniforms defines undefs delete-shaders) ¶null) &key vertex-shader fragment-shader geometry-shader attributes uniforms defines undefs delete-shaders) ¶frame-buffer)) ¶automatically generated reader method
shader-program) (shader shader)) ¶shader-program) &key) ¶shader-program) &key) ¶frame-buffer)) ¶automatically generated reader method
key.
texture)) ¶automatically generated reader method
key.
index-buffer)) ¶automatically generated reader method
key.
buffer)) ¶automatically generated reader method
key.
shader-program)) ¶automatically generated reader method
key.
shader-program)) ¶List the shader-program’s attribute arguments.
shader-program)) ¶List the shader-program’s attribute arguments.
shader-program)) ¶List the shader-program’s uniform arguments.
index-buffer)) ¶automatically generated reader method
index-buffer)) ¶automatically generated writer method
geometry-shader)) ¶Creates a geometry shader.
fragment-shader)) ¶Creates a fragment shader.
vertex-shader)) ¶Creates a vertex shader.
shader-program) key) ¶Removes a shader-program attribute
shader-program) key) ¶Removes a shader-program uniform
Resets a node to default. Position 0, rotation 0 and scale of 1. Shortcut is !0.
Resets a node’s rotation to 1,0,0,0. Shortcut is !r0
Resets a node’s scaling to 1,1,1. Shortcut is !s0
Resets a node’s translation to 0,0,0. Shortcut is !t0
Get the rotation matrix.
Get the scale matrix.
shader-program) key) ¶Gets a shader-program attribute
shader-program) key) ¶Sets a shader-program attribute.
shader-program)) ¶automatically generated reader method
shader-program) key) ¶Gets a shader-program uniform
shader-program) key) ¶Sets a shader-program uniform.
shader-program)) ¶automatically generated reader method
frame-buffer)) ¶automatically generated reader method
Get the translation matrix.
buffer) (shader-program shader-program) name) ¶Bind buffer to a shader-program attribute.
Stop using the normal array
Stop using the vertex array
Fragment Shader Class.
:fragment-shader
Geometry Shader Class.
:geometry-shader
Creates a buffer for quickly reading and writing to textures. This is separate from the texture’s data.
:pixel-unpack-buffer
Base class for all individual shaders.
Vertex Shader Class.
:vertex-shader
| Jump to: | !
$
(
*
_
A B C D E F G H I K L M N P Q R S T U V W X Y |
|---|
| Jump to: | !
$
(
*
_
A B C D E F G H I K L M N P Q R S T U V W X Y |
|---|
| Jump to: | *
+
A B C D E F H I K L M N P R S T U V W X Y |
|---|
| Jump to: | *
+
A B C D E F H I K L M N P R S T U V W X Y |
|---|
| Jump to: | 2
A B C D E F G I N P S T V W |
|---|
| Jump to: | 2
A B C D E F G I N P S T V W |
|---|