3.1.1 clinch/clinch.asd

Source

clinch.asd.

Parent Component

clinch (system).

ASDF Systems

clinch.

---

3.1.2 clinch/package.lisp

Source

clinch.asd.

Parent Component

clinch (system).

Packages

clinch.

---

3.1.3 clinch/threads.lisp

Dependency

package.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Internals

• $ (macro).
• $> (function).

---

3.1.4 clinch/clinch.lisp

Dependency

threads.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• ! (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).

Internals

• *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).

---

3.1.5 clinch/transform.lisp

Dependency

clinch.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• +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).

Internals

• get-point-by-index (function).
• set-point-by-index (function).

---

3.1.6 clinch/node.lisp

Dependency

transform.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• !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).

Internals

• 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).

---

3.1.7 clinch/shaders.lisp

Dependency

node.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• id (reader method).
• initialize-instance (method).
• name (reader method).
• shader-compile (method).
• shader-source (method).
• (setf shader-source) (method).
• unload (method).

Internals

• 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).

---

3.1.8 clinch/shader-program.lisp

Dependency

shaders.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• 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).

Internals

• 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).

---

3.1.9 clinch/default-shaders.lisp

Dependency

shader-program.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• 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).

Internals

• *generic-shader-hash-table* (special variable).
• define-default-shader (macro).

---

3.1.10 clinch/buffer.lisp

Dependency

default-shaders.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• (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).

Internals

• 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).

---

3.1.11 clinch/index-buffer.lisp

Dependency

buffer.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• 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).

Internals

• key (reader method).
• loaded? (reader method).
• (setf loaded?) (writer method).

---

3.1.12 clinch/pixel-buffer.lisp

Dependency

index-buffer.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Internals

pixel-buffer (class).

---

3.1.13 clinch/texture.lisp

Dependency

pixel-buffer.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• 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).

Internals

• *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).

---

3.1.14 clinch/2d-node.lisp

Dependency

texture.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Internals

• 2d-node (class).
• v20 (special variable).
• v2i (special variable).

---

3.1.15 clinch/entity.lisp

Dependency

2d-node.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• 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).

Internals

• bones (reader method).
• (setf bones) (writer method).
• convert-non-buffer (function).
• mode (reader method).

---

3.1.16 clinch/viewport.lisp

Dependency

entity.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• 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).

Internals

with-viewport (macro).

---

3.1.17 clinch/framebuffer.lisp

Dependency

viewport.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• *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).

Internals

• add-color-buffer (method).
• color-attachment-0 (constant).
• color-attachments (reader method).
• key (reader method).
• stencil-attachments (reader method).

---

3.1.18 clinch/animation.lisp

Dependency

framebuffer.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• 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).

Internals

• current-time (reader method).
• (setf current-time) (writer method).

---

3.1.19 clinch/window.lisp

Dependency

animation.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• *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).

Internals

• *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).

---

3.1.20 clinch/shapes.lisp

Dependency

window.lisp (file).

Source

clinch.asd.

Parent Component

clinch (system).

Public Interface

• get-default-texture (function).
• make-quad (function).
• make-quad-and-texture (method).
• make-quad-for-texture (method).

Internals

• 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).

---

5.1.1 Constants

Constant: +pi+ ¶

A single-float version of pi.

Package

clinch.

Source

transform.lisp.

---

5.1.2 Special variables

Special Variable: *context* ¶

Global Opengl Contex object.

Package

clinch.

Source

clinch.lisp.

Special Variable: *controllers* ¶

An alist of discovered controllers. Format: (controller-id . sdl-controller-handle)

Package

clinch.

Source

window.lisp.

Special Variable: *default-on-idle* ¶

The default on-idle handler. Mapped as both a function and a variable.

Package

clinch.

Source

window.lisp.

Special Variable: *delta-ticks* ¶

Change in time (delta time, dt) since the last on-idle call.

Package

clinch.

Source

window.lisp.

Special Variable: *entity* ¶

The current entity

Package

clinch.

Source

clinch.lisp.

Special Variable: *fbo* ¶

Current Frame Buffer Object.

Package

clinch.

Source

framebuffer.lisp.

Special Variable: *haptic* ¶

An alist of discovered haptic feedback devices. Format: (controller-id . sdl-haptic-device-handle)

Package

clinch.

Source

window.lisp.

Special Variable: *next* ¶

Runs before the next on-idle call. No arguments.

Package

clinch.

Source

window.lisp.

Special Variable: *node* ¶

Current default node.

Package

clinch.

Source

clinch.lisp.

Special Variable: *on-controller-added* ¶

Called when a new controller is discovered. Arguments: (controller-id axis-id value timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-controller-axis-move* ¶

Called when a controller’s axis moves. Arguments (controller-id axis-id position timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-controller-button-down* ¶

Called when a controller’s button is pressed. Arguments: (controller-id axis-id value timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-controller-button-up* ¶

Called when a controller’s button is released. Arguments: (controller-id axis-id value timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-controller-remapped* ¶

Called when a controller is remapped. Arguments: (window data1 data2 timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-controller-removed* ¶

Called when a controller is removed. Arguments: (window data1 data2 timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-idle* ¶

Called when there are no pending events. Take no arguments. Default can be overridden.

Package

clinch.

Source

window.lisp.

Special Variable: *on-key-down* ¶

Called when a key is pressed. Arguments (win keysym state ts)

Package

clinch.

Source

window.lisp.

Special Variable: *on-key-up* ¶

Called when a key is released. Arguments (win keysym state ts)

Package

clinch.

Source

window.lisp.

Special Variable: *on-mouse-click* ¶

Called when mouse button is released. Arguments: (win mouse x y button state clicks ts)

Package

clinch.

Source

window.lisp.

Special Variable: *on-mouse-double-click* ¶

Package

clinch.

Source

window.lisp.

Special Variable: *on-mouse-down* ¶

Called when mouse button is pressed. Arguments: (win mouse x y button state clicks ts)

Package

clinch.

Source

window.lisp.

Special Variable: *on-mouse-move* ¶

Called when mouse is moved. Arguments (win mouse state x y xrel yrel ts)

Package

clinch.

Source

window.lisp.

Special Variable: *on-mouse-up* ¶

Called when mouse button is released. Arguments: (win mouse x y button state clicks ts)

Package

clinch.

Source

window.lisp.

Special Variable: *on-mouse-wheel-move* ¶

Called when the mouse wheel is moved. Arguments: (win mouse x y ts)

Package

clinch.

Source

window.lisp.

Special Variable: *on-quit* ¶

Called when clinch is about to exit. Take no arguments.

Package

clinch.

Source

window.lisp.

Special Variable: *on-text-editing* ¶

Called when editing text.

Package

clinch.

Source

window.lisp.

Special Variable: *on-text-input* ¶

Call when text input happens.

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-close* ¶

Called when window is closing. Arguments (window timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-enter* ¶

Called when window gains mouse focus. Arguments (window timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-exposed* ¶

Called when window is exposed and need redrawn. Arguments (window timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-focus-gained* ¶

Called when window gains focus. Arguments (window timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-focus-lost* ¶

Called when window loses focus. Arguments (window timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-hidden* ¶

Called when window is hidden. Arguments (window timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-leave* ¶

Called when window is loses mouse focus. Arguments (window timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-maximized* ¶

Called when window is maximized. Arguments (window timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-minimized* ¶

Called when window is minimized. Arguments (window timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-moved* ¶

Called when the window has been moved. Arguments (window x y timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-resized* ¶

Always called when window size changes. Arguments (window width height timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-restored* ¶

Called when window is restored to normal position and size. Arguments (window timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *on-window-size-changed* ¶

Always called when window size changes. Arguments (window width height timestamp)

Package

clinch.

Source

window.lisp.

Special Variable: *ortho-projection* ¶

An automatically generated orthogonal projection for the window. Pixel to pixel.

Package

clinch.

Source

clinch.lisp.

Special Variable: *projection* ¶

Current default projection.

Package

clinch.

Source

clinch.lisp.

Special Variable: *root* ¶

The default root node.

Package

clinch.

Source

node.lisp.

Special Variable: *texture* ¶

The current texture. Defaults to the window’s overlay.

Package

clinch.

Source

clinch.lisp.

Special Variable: *ticks* ¶

Time elapsed since (init) in milliseconds.

Package

clinch.

Source

window.lisp.

Special Variable: *uncollected* ¶

Weak hash of loaded OpenGL objects.

Package

clinch.

Source

clinch.lisp.

Special Variable: *viewport* ¶

Current viewport object.

Package

clinch.

Source

clinch.lisp.

Special Variable: *window* ¶

Global window object.

Package

clinch.

Source

clinch.lisp.

---

5.1.3 Macros

Macro: ! (&body body) ¶

Runs body in main thread for safe OpenGL calls. Waits for return value.

Package

clinch.

Source

clinch.lisp.

Macro: !! (&body body) ¶

Runs body in main thread for safe OpenGL calls. Returns immediately.

Package

clinch.

Source

clinch.lisp.

Macro: !r (this w x y z &optional in-place) ¶

Package

clinch.

Source

node.lisp.

Macro: !s (this x y z &optional in-place) ¶

Package

clinch.

Source

node.lisp.

Macro: !t (this x y z &optional in-place) ¶

Package

clinch.

Source

node.lisp.

Macro: d->r (degrees) ¶

Converts degrees to radians.

Package

clinch.

Source

transform.lisp.

Macro: defevent (event args &body body) ¶

Creates and updates an event handler. Use this for all your *on-* events. It’s just a nice wrapper around (setf event (lambda ...

Package

clinch.

Source

window.lisp.

Macro: degrees->radians (degrees) ¶

Converts degrees to radians.

Package

clinch.

Source

transform.lisp.

Macro: ensure-float (x) ¶

Coerce a number to a single-float.

Package

clinch.

Source

transform.lisp.

Macro: r->d (radians) ¶

Converts radians to degrees.

Package

clinch.

Source

transform.lisp.

Macro: radians->degrees (radians) ¶

Converts radians to degrees.

Package

clinch.

Source

transform.lisp.

Macro: with-attributes (args this &body body) ¶

Package

clinch.

Source

entity.lisp.

Macro: with-fbo ((fbo) &body body) ¶

Convenience macro for useing and resetting an FBO.

Package

clinch.

Source

framebuffer.lisp.

Macro: with-mapped-buffer ((name buffer &optional access) &body body) ¶

Convenience macro for mapping and unmapping the buffer data. Name is the symbol name to use for the buffer pointer.

Package

clinch.

Source

buffer.lisp.

Macro: with-new-node ((&optional parent) &body body) ¶

A wrapper which creates a new node and set it as current.

Package

clinch.

Source

node.lisp.

Macro: with-node ((node) &body body) ¶

A wrapper which sets and unsets the current *node* object.

Package

clinch.

Source

node.lisp.

Macro: with-temporary-pbo ((var texture &key usage target) &body body) ¶

Creates a temporary pixel buffer for a texture.

Package

clinch.

Source

texture.lisp.

Macro: with-uniforms (args this &body body) ¶

Package

clinch.

Source

entity.lisp.

---

5.1.4 Ordinary functions

Function: *default-on-idle* () ¶

Package

clinch.

Source

window.lisp.

Function: decompose-transform (m) ¶

Decomposes a matrix into it’s position vector3, rotation quaterion and scaling vector3. Useful for creating/updating the node object.

Package

clinch.

Source

clinch.lisp.

Function: get-default-texture () ¶

Package

clinch.

Source

shapes.lisp.

Function: get-generic-per-vertex-color-shader () ¶

Package

clinch.

Source

default-shaders.lisp.

Function: get-generic-single-color-shader () ¶

Package

clinch.

Source

default-shaders.lisp.

Function: get-generic-single-diffuse-light-animation-shader () ¶

Package

clinch.

Source

default-shaders.lisp.

Function: get-generic-single-diffuse-light-per-vertex-color-shader () ¶

Package

clinch.

Source

default-shaders.lisp.

Function: get-generic-single-diffuse-light-shader () ¶

Package

clinch.

Source

default-shaders.lisp.

Function: get-generic-single-texture-shader () ¶

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

Package

clinch.

Source

default-shaders.lisp.

Function: get-generic-solid-phong-shader () ¶

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

Package

clinch.

Source

default-shaders.lisp.

Function: get-identity-texture () ¶

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.

Package

clinch.

Source

texture.lisp.

Function: get-screen-direction (lens-1) ¶

Gets the direction from the middle of the screen.

Package

clinch.

Source

transform.lisp.

Function: init (&key asynchronous init-controllers width height title fullscreen no-frame context-profile-mask alpha-size depth-size stencil-size red-size green-size blue-size buffer-size double-buffer hidden resizable) ¶

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.

Package

clinch.

Source

window.lisp.

Function: make-frustum-transform (left right bottom top near far) ¶

Create a raw CFFI frustum matrix.

Package

clinch.

Source

transform.lisp.

Function: make-orthogonal-transform (width height near far) ¶

Create a raw CFFI orthogonal matrix.

Package

clinch.

Source

transform.lisp.

Function: make-perspective-transform (fovy aspect znear zfar) ¶

Create a raw CFFI perspective matrix.

Package

clinch.

Source

transform.lisp.

Function: make-quad (width height &key center shader-program texture parent) ¶

Creates a quad entity of width and height.

Package

clinch.

Source

shapes.lisp.

Function: ray-triangle-intersect? (origin ray-dir v0 v1 v2) ¶

Given an origin, direction and a triangle returns if and where they intersect. Presently does not cull backfacing triangles.

Package

clinch.

Source

clinch.lisp.

Function: topological-sort (graph &key test) ¶

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).

Package

clinch.

Source

clinch.lisp.

Function: transform-point (p m) ¶

Package

clinch.

Source

transform.lisp.

Function: transform-points (points matrix) ¶

Package

clinch.

Source

transform.lisp.

Function: uninit () ¶

Package

clinch.

Source

window.lisp.

Function: unload-all-uncollected () ¶

Unloads all loaded OpenGL objects.

Package

clinch.

Source

clinch.lisp.

Function: unproject (x y width height inv-transform) ¶

Unproject from the screen to transform space.

Package

clinch.

Source

transform.lisp.

---

5.1.5 Generic functions

Generic Function: !0 (this) ¶

Resets a node to default. Position 0, rotation 0 and scale of 1. Shortcut is !0.

Package

clinch.

Alias for

reset.

Generic Function: !< (this data &key) ¶

Package

clinch.

Alias for

pushg.

Generic Function: !> (this &key data-format index offset size) ¶

Package

clinch.

Alias for

pullg.

Generic Function: (setf !>) (this) ¶

Package

clinch.

Methods

Method: (setf !>) ((this buffer)) ¶

Source

buffer.lisp.

Generic Function: !r0 (this) ¶

Resets a node’s rotation to 1,0,0,0. Shortcut is !r0

Package

clinch.

Alias for

reset-rotation.

Generic Function: !s0 (this) ¶

Resets a node’s scaling to 1,1,1. Shortcut is !s0

Package

clinch.

Alias for

reset-scaling.

Generic Function: !t0 (this) ¶

Resets a node’s translation to 0,0,0. Shortcut is !t0

Package

clinch.

Alias for

reset-translation.

Generic Function: add-child (this child &key) ¶

Package

clinch.

Methods

Method: add-child ((this node) child &key) ¶

Add a child. Children must implement update and render.

Source

node.lisp.

Generic Reader: animation (object) ¶

Package

clinch.

Methods

Reader Method: animation ((animator animator)) ¶

automatically generated reader method

Source

animation.lisp.

Target Slot

animation.

Generic Writer: (setf animation) (object) ¶

Package

clinch.

Methods

Writer Method: (setf animation) ((animator animator)) ¶

automatically generated writer method

Source

animation.lisp.

Target Slot

animation.

Generic Function: attach-uniform (this uniform value) ¶

Package

clinch.

Methods

Method: attach-uniform ((this 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.

Source

shader-program.lisp.

Method: attach-uniform ((this 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.

Source

shader-program.lisp.

Method: attach-uniform ((this shader-program) (uniform string) value) ¶

Shaders pass information by using named values called Uniforms and Attributes. This sets a uniform to value.

Source

shader-program.lisp.

Generic Function: attribute (this name) ¶

Package

clinch.

Methods

Method: attribute ((this entity) name) ¶

Returns an attribute by name. Should work with numbers and strings.

Source

entity.lisp.

Generic Function: (setf attribute) (this name) ¶

Package

clinch.

Methods

Method: (setf attribute) ((this entity) name) ¶

Sets an attribute’s value. If the name doesn’t exist, it’s added. If the new value is nil, the entry is deleted.

Source

entity.lisp.

Generic Reader: attributes (object) ¶

Package

clinch.

Methods

Reader Method: attributes ((entity entity)) ¶

automatically generated reader method

Source

entity.lisp.

Target Slot

attributes.

Generic Function: bind (this &key index offset length) ¶

Package

clinch.

Methods

Method: bind ((this null) &key) ¶

Binds the frame buffer for use.

Source

framebuffer.lisp.

Method: bind ((this frame-buffer) &key) ¶

Wrapper around glBindFrameBuffer. Puts the Framebuffer into play.

Source

framebuffer.lisp.

Method: bind ((this texture) &key) ¶

Wrapper around glBindBuffer. Puts the texture into play.

Source

texture.lisp.

Method: bind ((this buffer) &key index offset length) ¶

Wrapper around glBindBuffer. Binds this buffer for use.

Source

buffer.lisp.

Generic Function: bind-buffer-to-attribute-array (this shader name &key index offset length) ¶

Package

clinch.

Methods

Method: bind-buffer-to-attribute-array ((this buffer) (shader shader-program) name &key index offset length) ¶

Bind buffer to a shader attribute.

Source

buffer.lisp.

Generic Function: bind-buffer-to-vertex-array (this &key index offset length) ¶

Package

clinch.

Methods

Method: bind-buffer-to-vertex-array ((this buffer) &key index offset length) ¶

Use buffer in shader for the vertex array: The built-in variable gl_Vertex.

Source

buffer.lisp.

Generic Function: bind-sampler (this shader-program name tex-unit) ¶

Package

clinch.

Methods

Method: bind-sampler ((this texture) shader-program name tex-unit) ¶

Shader-Programs pass information by using named values called Uniforms. Textures are passed using Samplers. This sets a texture-unit to a sampler uniform

Source

texture.lisp.

Generic Function: bind-static-values-to-attribute (this name vals) ¶

Package

clinch.

Methods

Method: bind-static-values-to-attribute ((this shader-program) name vals) ¶

It is possible to bind static information to an attribute. That’s what this does.

Source

shader-program.lisp.

Generic Function: changed? (this) ¶

Package

clinch.

Methods

Method: changed? ((this node)) ¶

Has this node changed and not updated?

Source

node.lisp.

Generic Function: (setf changed?) (this) ¶

Package

clinch.

Methods

Method: (setf changed?) ((this node)) ¶

Set this node to update later.

Source

node.lisp.

Generic Reader: children (object) ¶

Package

clinch.

Methods

Reader Method: children ((node node)) ¶

automatically generated reader method

Source

node.lisp.

Target Slot

children.

Generic Writer: (setf children) (object) ¶

Package

clinch.

Methods

Writer Method: (setf children) ((node node)) ¶

automatically generated writer method

Source

node.lisp.

Target Slot

children.

Generic Reader: clear-color (object) ¶

Package

clinch.

Methods

Reader Method: clear-color ((viewport viewport)) ¶

automatically generated reader method

Source

viewport.lisp.

Target Slot

clear-color.

Generic Writer: (setf clear-color) (object) ¶

Package

clinch.

Methods

Writer Method: (setf clear-color) ((viewport viewport)) ¶

automatically generated writer method

Source

viewport.lisp.

Target Slot

clear-color.

Generic Function: color-attachment (this name) ¶

Package

clinch.

Methods

Method: color-attachment ((this frame-buffer) name) ¶

Returns a color-attachment by number.

Source

framebuffer.lisp.

Generic Function: (setf color-attachment) (this name) ¶

Package

clinch.

Methods

Method: (setf color-attachment) ((this frame-buffer) name) ¶

Sets an attachment’s number

Source

framebuffer.lisp.

Generic Reader: data-format (object) ¶

Package

clinch.

Methods

Reader Method: data-format ((texture texture)) ¶

automatically generated reader method

Source

texture.lisp.

Target Slot

data-format.

Generic Writer: (setf data-format) (object) ¶

Package

clinch.

Methods

Writer Method: (setf data-format) ((texture texture)) ¶

automatically generated writer method

Source

texture.lisp.

Target Slot

data-format.

Generic Function: data-from-pointer (this pointer) ¶

Package

clinch.

Methods

Method: data-from-pointer ((this texture) pointer) ¶

Source

texture.lisp.

Method: data-from-pointer ((this buffer) pointer) ¶

Source

buffer.lisp.

Generic Reader: depth-buffer (object) ¶

Package

clinch.

Methods

Reader Method: depth-buffer ((frame-buffer frame-buffer)) ¶

automatically generated reader method

Source

framebuffer.lisp.

Target Slot

depth.

Generic Function: (setf depth-buffer) (this) ¶

Package

clinch.

Methods

Method: (setf depth-buffer) ((this frame-buffer)) ¶

Binds the depth buffer for use.

Source

framebuffer.lisp.

Generic Function: draw-with-index-buffer (this &key mode) ¶

Package

clinch.

Methods

Method: draw-with-index-buffer ((this index-buffer) &key mode) ¶

Use this buffer as an index array and draw somthing.

Source

index-buffer.lisp.

Generic Function: draw-with-ranged-index-buffer (this &key start end mode) ¶

Package

clinch.

Methods

Method: draw-with-ranged-index-buffer ((this index-buffer) &key start end mode) ¶

Use this buffer as an index array and draw somthing within start and end bounds.

Source

index-buffer.lisp.

Generic Reader: enabled (object) ¶

Package

clinch.

Methods

Reader Method: enabled ((entity entity)) ¶

automatically generated reader method

Source

entity.lisp.

Target Slot

enabled.

Reader Method: enabled ((node node)) ¶

automatically generated reader method

Source

node.lisp.

Target Slot

enabled.

Generic Writer: (setf enabled) (object) ¶

Package

clinch.

Methods

Writer Method: (setf enabled) ((entity entity)) ¶

automatically generated writer method

Source

entity.lisp.

Target Slot

enabled.

Writer Method: (setf enabled) ((node node)) ¶

automatically generated writer method

Source

node.lisp.

Target Slot

enabled.

Generic Reader: frames (object) ¶

Package

clinch.

Methods

Reader Method: frames ((animation animation)) ¶

automatically generated reader method

Source

animation.lisp.

Target Slot

frames.

Generic Writer: (setf frames) (object) ¶

Package

clinch.

Methods

Writer Method: (setf frames) ((animation animation)) ¶

automatically generated writer method

Source

animation.lisp.

Target Slot

frames.

Generic Function: get-animation-time (this) ¶

Package

clinch.

Methods

Method: get-animation-time ((this animator)) ¶

Source

animation.lisp.

Method: get-animation-time ((this animation)) ¶

Source

animation.lisp.

Method: get-animation-time ((this vector)) ¶

Source

animation.lisp.

Method: get-animation-time ((this list)) ¶

Source

animation.lisp.

Method: get-animation-time (this) ¶

Source

animation.lisp.

Generic Function: get-attribute-id (this id) ¶

Package

clinch.

Methods

Method: get-attribute-id ((this shader-program) (attribute string)) ¶

Shaders pass information by using named values called Uniforms and Attributes. This gets the gl id of a attribute name.

Source

shader-program.lisp.

Method: get-attribute-id ((this 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.

Source

shader-program.lisp.

Generic Function: get-keyframe (this time &key) ¶

Package

clinch.

Methods

Method: get-keyframe ((this animator) time &key) ¶

Source

animation.lisp.

Method: get-keyframe ((this animation) (time number) &key) ¶

Source

animation.lisp.

Method: get-keyframe ((this vector) (time number) &key) ¶

Source

animation.lisp.

Method: get-keyframe ((this list) (time number) &key) ¶

Source

animation.lisp.

Method: get-keyframe (this time &key) ¶

Source

animation.lisp.

Generic Function: get-size (this &key) ¶

Package

clinch.

Methods

Method: get-size ((this texture) &key) ¶

Calculates the number of VALUES (stride * vcount) or (stride * width * height) this buffer contains.

Source

texture.lisp.

Method: get-size ((this buffer) &key) ¶

Calculates the number of VALUES (stride + vcount) this buffer contains.

Source

buffer.lisp.

Generic Function: get-uniform-id (this id) ¶

Package

clinch.

Methods

Method: get-uniform-id ((this shader-program) (uniform string)) ¶

Shaders pass information by using named values called Uniforms and Attributes. This gets the gl id of a uniform name.

Source

shader-program.lisp.

Method: get-uniform-id ((this 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.

Source

shader-program.lisp.

Generic Reader: height (object) ¶

Package

clinch.

Methods

Reader Method: height ((this viewport)) ¶

Get the viewport height.

Source

viewport.lisp.

Target Slot

height.

Reader Method: height ((texture texture)) ¶

automatically generated reader method

Source

texture.lisp.

Target Slot

height.

Generic Writer: (setf height) (object) ¶

Package

clinch.

Methods

Writer Method: (setf height) ((this viewport)) ¶

Set the viewport height.

Source

viewport.lisp.

Target Slot

height.

Generic Reader: id (object) ¶

Package

clinch.

Methods

Reader Method: id ((frame-buffer frame-buffer)) ¶

automatically generated reader method

Source

framebuffer.lisp.

Target Slot

id.

Reader Method: id ((index-buffer index-buffer)) ¶

automatically generated reader method

Source

index-buffer.lisp.

Target Slot

id.

Reader Method: id ((buffer buffer)) ¶

automatically generated reader method

Source

buffer.lisp.

Target Slot

id.

Reader Method: id ((shader shader)) ¶

automatically generated reader method

Source

shaders.lisp.

Target Slot

id.

Generic Reader: indexes (object) ¶

Package

clinch.

Methods

Reader Method: indexes ((entity entity)) ¶

automatically generated reader method

Source

entity.lisp.

Target Slot

indexes.

Generic Function: (setf indexes) (this) ¶

Package

clinch.

Methods

Method: (setf indexes) ((this entity)) ¶

Sets the index array.

Source

entity.lisp.

Generic Function: make-color-texture (this index width height &key pbo stride qtype internal-format format wrap-s wrap-t mag-filter min-filter texture-compare-mode texture-compare-function) ¶

Package

clinch.

Methods

Method: make-color-texture ((this 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.

Source

framebuffer.lisp.

Generic Function: make-depth-texture (this width height &key internal-format format qtype stride depth-texture-mode texture-compare-mode texture-compare-function) ¶

Package

clinch.

Methods

Method: make-depth-texture ((this 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.

Source

framebuffer.lisp.

Generic Function: make-pbo-for-texture (this &key usage target) ¶

Package

clinch.

Methods

Method: make-pbo-for-texture ((this texture) &key usage target) ¶

Returns a compatible pixel buffer for a texture.

Source

texture.lisp.

Generic Function: make-quad-and-texture (width height &key center shader-program parent no-parent) ¶

Package

clinch.

Methods

Method: make-quad-and-texture (width height &key center shader-program parent no-parent) ¶

Source

shapes.lisp.

Generic Function: make-quad-for-texture (this &key width height center shader-program parent no-parent) ¶

Package

clinch.

Methods

Method: make-quad-for-texture ((this texture) &key width height center shader-program parent no-parent) ¶

Creates a quad for a texture which defaults to texture’s width and height.

Source

shapes.lisp.

Generic Function: map-buffer (this &optional access) ¶

Package

clinch.

Methods

Method: map-buffer ((this buffer) &optional access) ¶

Returns a pointer to the buffer data. YOU MUST CALL UNMAP-BUFFER AFTER YOU ARE DONE!
Access options are: :Read-Only, :Write-Only, and :READ-WRITE. NOTE: Using :read-write is slower than the others. If you can, use them instead.

Source

buffer.lisp.

Generic Function: n* (this that &key new-node) ¶

Multiplies nodes and matrix transforms.

Package

clinch.

Source

node.lisp.

Methods

Method: n* ((this vector) (that vector) &key new-node) ¶

Multiplies a node? I’m not sure if this works.

Method: n* ((this node) (that vector) &key new-node) ¶

Multiplies a node? I’m not sure if this works.

Method: n* ((this vector) (that node) &key new-node) ¶

Multiplies a node? I’m not sure if this works.

Method: n* ((this node) (that node) &key new-node) ¶

Multiplies a node? I’m not sure if this works.

Generic Reader: name (object) ¶

Package

clinch.

Methods

Reader Method: name ((animation animation)) ¶

automatically generated reader method

Source

animation.lisp.

Target Slot

name.

Reader Method: name ((shader-program shader-program)) ¶

automatically generated reader method

Source

shader-program.lisp.

Target Slot

name.

Reader Method: name ((shader shader)) ¶

automatically generated reader method

Source

shaders.lisp.

Target Slot

name.

Reader Method: name ((node node)) ¶

automatically generated reader method

Source

node.lisp.

Target Slot

name.

Generic Writer: (setf name) (object) ¶

Package

clinch.

Methods

Writer Method: (setf name) ((animation animation)) ¶

automatically generated writer method

Source

animation.lisp.

Target Slot

name.

Writer Method: (setf name) ((node node)) ¶

automatically generated writer method

Source

node.lisp.

Target Slot

name.

Generic Function: pause (this &key) ¶

Package

clinch.

Source

animation.lisp.

Methods

Method: pause ((this animator) &key) ¶

Generic Reader: paused (object) ¶

Package

clinch.

Methods

Reader Method: paused ((animator animator)) ¶

automatically generated reader method

Source

animation.lisp.

Target Slot

paused.

Generic Writer: (setf paused) (object) ¶

Package

clinch.

Methods

Writer Method: (setf paused) ((animator animator)) ¶

automatically generated writer method

Source

animation.lisp.

Target Slot

paused.

Generic Function: play (this &key) ¶

Package

clinch.

Source

animation.lisp.

Methods

Method: play ((this animator) &key) ¶

Generic Reader: program (object) ¶

Package

clinch.

Methods

Reader Method: program ((shader-program shader-program)) ¶

automatically generated reader method

Source

shader-program.lisp.

Target Slot

program.

Generic Function: pullg (this &key data-format index offset size) ¶

Package

clinch.

Source

buffer.lisp.

Methods

Method: pullg ((tex texture) &key data-format) ¶

Gets the texture data as a vector array.

Source

texture.lisp.

Method: pullg ((this buffer) &key index offset size) ¶

Returns the buffer’s data as a vector array.

Method: pullg ((this shader-program) &key) ¶

Returns shader-program’s available information such as shader source, uniforms and attributes.

Source

shader-program.lisp.

Generic Function: pushg (this data &key) ¶

Package

clinch.

Source

buffer.lisp.

Methods

Method: pushg ((tex texture) (data array) &key) ¶

Sets the texture data from a vector array.

Source

texture.lisp.

Method: pushg ((this texture) (pbo pixel-buffer) &key) ¶

Sets the texture data from a pixel buffer.

Source

texture.lisp.

Method: pushg ((this buffer) (data array) &key) ¶

Sets the buffer data from a vector array.

Generic Reader: qtype (object) ¶

Package

clinch.

Methods

Reader Method: qtype ((texture texture)) ¶

automatically generated reader method

Source

texture.lisp.

Target Slot

type.

Reader Method: qtype ((index-buffer index-buffer)) ¶

automatically generated reader method

Source

index-buffer.lisp.

Target Slot

type.

Reader Method: qtype ((buffer buffer)) ¶

automatically generated reader method

Source

buffer.lisp.

Target Slot

type.

Generic Writer: (setf qtype) (object) ¶

Package

clinch.

Methods

Writer Method: (setf qtype) ((texture texture)) ¶

automatically generated writer method

Source

texture.lisp.

Target Slot

type.

Writer Method: (setf qtype) ((index-buffer index-buffer)) ¶

automatically generated writer method

Source

index-buffer.lisp.

Target Slot

type.

Writer Method: (setf qtype) ((buffer buffer)) ¶

automatically generated writer method

Source

buffer.lisp.

Target Slot

type.

Generic Function: quick-set (this x y w h) ¶

Package

clinch.

Methods

Method: quick-set ((this viewport) x y w h) ¶

A quick method to set all the values in the viewport.

Source

viewport.lisp.

Generic Function: ray-entity-intersect? (this transform start end &optional primitive) ¶

Package

clinch.

Methods

Method: ray-entity-intersect? ((this entity) transform start end &optional primitive) ¶

Source

entity.lisp.

Generic Function: remove-child (this child &key) ¶

Package

clinch.

Methods

Method: remove-child ((this node) child &key) ¶

Removes a child. Does not unref removed children.

Source

node.lisp.

Generic Function: render (this &key time projection parent) ¶

Package

clinch.

Methods

Method: render ((this animator) &key time) ¶

Source

animation.lisp.

Method: render ((this viewport) &key projection) ¶

Makes this viewport active.

Source

viewport.lisp.

Method: render ((this entity) &key parent projection) ¶

Renders the entity (mesh).
:parent Sets the parent for the :model

Source

entity.lisp.

Method: render ((this list) &key parent projection) ¶

Render a list of rendables.

Source

node.lisp.

Method: render ((this node) &key parent projection) ¶

Render child objects. You don’t need to build your application with nodes/render. This is just here to help.

Source

node.lisp.

Generic Reader: repeat (object) ¶

Package

clinch.

Methods

Reader Method: repeat ((animator animator)) ¶

automatically generated reader method

Source

animation.lisp.

Target Slot

repeat.

Reader Method: repeat ((animation animation)) ¶

automatically generated reader method

Source

animation.lisp.

Target Slot

repeat.

Generic Writer: (setf repeat) (object) ¶

Package

clinch.

Methods

Writer Method: (setf repeat) ((animator animator)) ¶

automatically generated writer method

Source

animation.lisp.

Target Slot

repeat.

Writer Method: (setf repeat) ((animation animation)) ¶

automatically generated writer method

Source

animation.lisp.

Target Slot

repeat.

Generic Function: resize (this x y w h) ¶

Package

clinch.

Methods

Method: resize ((this viewport) x y w h) ¶

Resize the viewport.

Source

viewport.lisp.

Generic Function: rotate (this rot &key modify) ¶

Rotate node. Shortcut is !r.

Package

clinch.

Source

node.lisp.

Methods

Method: rotate ((this node) rot &key modify) ¶

Rotate the node. Takes a quaterion.

Generic Reader: rotation (object) ¶

Package

clinch.

Methods

Reader Method: rotation ((node node)) ¶

automatically generated reader method

Source

node.lisp.

Target Slot

rot.

Generic Function: (setf rotation) (this) ¶

Package

clinch.

Source

node.lisp.

Methods

Method: (setf rotation) ((this node)) ¶

Sets the rotation quaterion.

Generic Reader: run-length (object) ¶

Package

clinch.

Methods

Reader Method: run-length ((animator animator)) ¶

automatically generated reader method

Source

animation.lisp.

Target Slot

run-length.

Reader Method: run-length ((animation animation)) ¶

automatically generated reader method

Source

animation.lisp.

Target Slot

run-length.

Generic Writer: (setf run-length) (object) ¶

Package

clinch.

Methods

Writer Method: (setf run-length) ((animator animator)) ¶

automatically generated writer method

Source

animation.lisp.

Target Slot

run-length.

Writer Method: (setf run-length) ((animation animation)) ¶

automatically generated writer method

Source

animation.lisp.

Target Slot

run-length.

Generic Reader: run-speed (object) ¶

Package

clinch.

Methods

Reader Method: run-speed ((animator animator)) ¶

automatically generated reader method

Source

animation.lisp.

Target Slot

run-speed.

Generic Writer: (setf run-speed) (object) ¶

Package

clinch.

Methods

Writer Method: (setf run-speed) ((animator animator)) ¶

automatically generated writer method

Source

animation.lisp.

Target Slot

run-speed.

Generic Function: scale (this scale &key modify) ¶

Scale node. Shortcut is !s.

Package

clinch.

Source

node.lisp.

Methods

Method: scale ((this node) size &key modify) ¶

Scales a node. Takes a vector3.

Generic Reader: scaling (object) ¶

Package

clinch.

Methods

Reader Method: scaling ((node node)) ¶

automatically generated reader method

Source

node.lisp.

Target Slot

scale.

Generic Function: (setf scaling) (this) ¶

Package

clinch.

Source

node.lisp.

Methods

Method: (setf scaling) ((this node)) ¶

Sets the scaling vector.

Generic Function: set-texture-color (this r g b &optional a) ¶

Package

clinch.

Methods

Method: set-texture-color ((this texture) r g b &optional a) ¶

Source

texture.lisp.

Generic Function: shader-compile (this &key code defs undefs) ¶

Package

clinch.

Methods

Method: shader-compile ((this shader) &key code defs undefs) ¶

Source

shaders.lisp.

Generic Reader: shader-program (object) ¶

Package

clinch.

Methods

Reader Method: shader-program ((entity entity)) ¶

automatically generated reader method

Source

entity.lisp.

Target Slot

shader-program.

Generic Function: (setf shader-program) (this) ¶

Package

clinch.

Methods

Method: (setf shader-program) ((this entity)) ¶

Sets the shader-program to use.

Source

entity.lisp.

Generic Function: shader-source (this) ¶

Package

clinch.

Methods

Method: shader-source ((this shader)) ¶

Source

shaders.lisp.

Generic Function: (setf shader-source) (this) ¶

Package

clinch.

Methods

Method: (setf shader-source) ((this shader)) ¶

Source

shaders.lisp.

Generic Function: size-in-bytes (this) ¶

Package

clinch.

Methods

Method: size-in-bytes ((this texture)) ¶

Calculates how many bytes this buffer consists of.

Source

texture.lisp.

Method: size-in-bytes ((this buffer)) ¶

Calculates how many bytes this buffer consists of.

Source

buffer.lisp.

Generic Function: skip (this position &key) ¶

Package

clinch.

Source

animation.lisp.

Methods

Method: skip ((this animator) position &key) ¶

Generic Function: stop (this &key) ¶

Package

clinch.

Source

animation.lisp.

Methods

Method: stop ((this animator) &key) ¶

Generic Reader: stride (object) ¶

Package

clinch.

Methods

Reader Method: stride ((texture texture)) ¶

automatically generated reader method

Source

texture.lisp.

Target Slot

stride.

Reader Method: stride ((index-buffer index-buffer)) ¶

automatically generated reader method

Source

index-buffer.lisp.

Target Slot

stride.

Reader Method: stride ((buffer buffer)) ¶

automatically generated reader method

Source

buffer.lisp.

Target Slot

stride.

Generic Reader: target (object) ¶

Package

clinch.

Methods

Reader Method: target ((frame-buffer frame-buffer)) ¶

automatically generated reader method

Source

framebuffer.lisp.

Target Slot

target.

Reader Method: target ((index-buffer index-buffer)) ¶

automatically generated reader method

Source

index-buffer.lisp.

Target Slot

target.

Reader Method: target ((buffer buffer)) ¶

automatically generated reader method

Source

buffer.lisp.

Target Slot

target.

Generic Writer: (setf target) (object) ¶

Package

clinch.

Methods

Writer Method: (setf target) ((frame-buffer frame-buffer)) ¶

automatically generated writer method

Source

framebuffer.lisp.

Target Slot

target.

Generic Reader: tex-id (object) ¶

Package

clinch.

Methods

Reader Method: tex-id ((texture texture)) ¶

automatically generated reader method

Source

texture.lisp.

Target Slot

tex-id.

Generic Writer: (setf tex-id) (object) ¶

Package

clinch.

Methods

Writer Method: (setf tex-id) ((texture texture)) ¶

automatically generated writer method

Source

texture.lisp.

Target Slot

tex-id.

Generic Function: transform (this &key) ¶

get the entire transform.

Package

clinch.

Source

node.lisp.

Methods

Method: transform ((this node) &key) ¶

Gets the transform matrix.

Generic Function: (setf transform) (this) ¶

Package

clinch.

Methods

Method: (setf transform) ((this node)) ¶

Source

node.lisp.

Generic Function: translate (this trans &key modify) ¶

Translate node. Shortcut is !t.

Package

clinch.

Source

node.lisp.

Methods

Method: translate ((this node) trans &key modify) ¶

Translate the node. Takes a vector3.

Generic Reader: translation (object) ¶

Package

clinch.

Methods

Reader Method: translation ((node node)) ¶

automatically generated reader method

Source

node.lisp.

Target Slot

trans.

Generic Function: (setf translation) (this) ¶

Package

clinch.

Source

node.lisp.

Methods

Method: (setf translation) ((this node)) ¶

Sets the translation vector.

Generic Function: traverse-node (this) ¶

Package

clinch.

Methods

Method: traverse-node ((this node)) ¶

Not yet implemented.

Source

node.lisp.

Generic Function: unbind (this &key) ¶

Package

clinch.

Methods

Method: unbind ((this frame-buffer) &key) ¶

Wrapper around glBindFrameBuffer. Puts the Framebuffer into play.

Source

framebuffer.lisp.

Method: unbind ((this texture) &key) ¶

Unbinds the texture.

Source

texture.lisp.

Method: unbind ((this buffer) &key) ¶

Wrapper around glBindBuffer with buffer 0, or no buffer.

Source

buffer.lisp.

Generic Function: uniform (this name) ¶

Package

clinch.

Methods

Method: uniform ((this entity) name) ¶

Returns a uniform by name. Should work with numbers and strings.

Source

entity.lisp.

Generic Function: (setf uniform) (this name) ¶

Package

clinch.

Methods

Method: (setf uniform) ((this entity) name) ¶

Sets a uniform’s value. If the name doesn’t exist, it’s added. If the new value is nil, the entry is deleted.

Source

entity.lisp.

Generic Reader: uniforms (object) ¶

Package

clinch.

Methods

Reader Method: uniforms ((entity entity)) ¶

automatically generated reader method

Source

entity.lisp.

Target Slot

uniforms.

Generic Function: unload (this &key all) ¶

Unloads an opengl object. Does nothing for non-opengl objects.

Package

clinch.

Source

clinch.lisp.

Methods

Method: unload ((this frame-buffer) &key) ¶

Unloads and releases all frame-buffer resources, also any renderbuffers

Source

framebuffer.lisp.

Method: unload ((this entity) &key all) ¶

Release entity resources. If :all t, then the index buffer and all uniforms and attributes are unloaded.

Source

entity.lisp.

Method: unload ((this texture) &key) ¶

Unloads the texture. Also cancels gc finalization.

Source

texture.lisp.

Method: unload ((this buffer) &key) ¶

Release buffer resources.

Source

buffer.lisp.

Method: unload ((this shader-program) &key) ¶

Unloads and releases all shader-program resources.

Source

shader-program.lisp.

Method: unload ((this shader) &key) ¶

Unloads and releases the shader.

Source

shaders.lisp.

Method: unload (this &key) ¶

Generic Function: unmap-buffer (this) ¶

Package

clinch.

Methods

Method: unmap-buffer ((this buffer)) ¶

Release the pointer given by map-buffer. NOTE: THIS TAKES THE BUFFER OBJECT, NOT THE POINTER! ALSO, DON’T TRY TO RELASE THE POINTER.

Source

buffer.lisp.

Generic Function: update (this &key time parent matrix force projection) ¶

Package

clinch.

Methods

Method: update ((this animator) &key time) ¶

Source

animation.lisp.

Method: update ((this entity) &key parent matrix force) ¶

Source

entity.lisp.

Method: update ((this node) &key parent projection) ¶

Render child objects. You don’t need to build your application with nodes/render. This is just here to help.

Source

node.lisp.

Generic Reader: usage (object) ¶

Package

clinch.

Methods

Reader Method: usage ((index-buffer index-buffer)) ¶

automatically generated reader method

Source

index-buffer.lisp.

Target Slot

usage.

Reader Method: usage ((buffer buffer)) ¶

automatically generated reader method

Source

buffer.lisp.

Target Slot

usage.

Generic Writer: (setf usage) (object) ¶

Package

clinch.

Methods

Writer Method: (setf usage) ((index-buffer index-buffer)) ¶

automatically generated writer method

Source

index-buffer.lisp.

Target Slot

usage.

Writer Method: (setf usage) ((buffer buffer)) ¶

automatically generated writer method

Source

buffer.lisp.

Target Slot

usage.

Generic Function: use-shader-program (this &key) ¶

Package

clinch.

Methods

Method: use-shader-program ((this shader-program) &key) ¶

Start using the shader-program.

Source

shader-program.lisp.

Generic Reader: vertex-count (object) ¶

Package

clinch.

Methods

Reader Method: vertex-count ((index-buffer index-buffer)) ¶

automatically generated reader method

Source

index-buffer.lisp.

Target Slot

vertex-count.

Reader Method: vertex-count ((buffer buffer)) ¶

automatically generated reader method

Source

buffer.lisp.

Target Slot

vertex-count.

Generic Function: walk-node-tree (this f &key test non-node) ¶

Package

clinch.

Methods

Method: walk-node-tree ((this node) f &key test non-node) ¶

Render child objects. You don’t need to build your application with nodes/render. This is just here to help.

Source

node.lisp.

Method: walk-node-tree (this f &key test non-node) ¶

Source

node.lisp.

Generic Reader: width (object) ¶

Package

clinch.

Methods

Reader Method: width ((this viewport)) ¶

Get viewport width.

Source

viewport.lisp.

Target Slot

width.

Reader Method: width ((texture texture)) ¶

automatically generated reader method

Source

texture.lisp.

Target Slot

width.

Generic Writer: (setf width) (object) ¶

Package

clinch.

Methods

Writer Method: (setf width) ((this viewport)) ¶

Set viewport width.

Source

viewport.lisp.

Target Slot

width.

Generic Reader: x (object) ¶

Package

clinch.

Methods

Reader Method: x ((viewport viewport)) ¶

automatically generated reader method

Source

viewport.lisp.

Target Slot

x.

Generic Writer: (setf x) (object) ¶

Package

clinch.

Methods

Writer Method: (setf x) ((viewport viewport)) ¶

automatically generated writer method

Source

viewport.lisp.

Target Slot

x.

Generic Reader: y (object) ¶

Package

clinch.

Methods

Reader Method: y ((viewport viewport)) ¶

automatically generated reader method

Source

viewport.lisp.

Target Slot

y.

Generic Writer: (setf y) (object) ¶

Package

clinch.

Methods

Writer Method: (setf y) ((viewport viewport)) ¶

automatically generated writer method

Source

viewport.lisp.

Target Slot

y.

---