The clinch Reference Manual

Table of Contents

The clinch Reference Manual

This is the clinch Reference Manual, version 0.5, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:47:04 2020 GMT+0.

1 Introduction

Clinch

Overview

Clinch is a simple, yet powerful 3d game engine for Lisp.

Clinch is a usable but still under development. It will become a stable and fast workhorse tool for developing games, visualizations and productivity software. I have plans for a graphical shell which incorporates the strengths of Lisp, 3D, shaders, 2d vector graphics, richtext support, 3d physics and much more.

Features

• Modern OpenGL features such as shaders and GPU buffers. [Done]

• Commercial grade windowing, controller, force-feedback, sound, music and more thorough SDL2. [Done]

• Create and inspect OpenGL objects on the fly. [Done]

• Live code in a multithreaded environment. [Done]

• Load plug-ins for more functionality. [Done]

Clinch Plug-ins:

• 3d physics with joints and motors using the ODE physics engine. [Done]

• Texture loading and saving with FreeImage. [Done]

• Integration with 2D vector graphics with Cairo. [Done]

• Integration with fonts and text positioning with Pango. [Done]

• 3D asset importing using ClassImp. [Current Development]

• Animate textures. [Done]

• Animate 3D objects. [Current Development]

• 2D physics [Experimental]

• 3D GUI [Current Development]

Design Goals

Fast

Clinch should be as fast or faster than most script-based graphics engines and require less development time. While it may never rival professional libraries and engines, the ability to modify the 3D engine and environment from the REPL allows skilled developers to create applications in a fast, intuitive and flexible way.

Simple

Clinch should be as simple as possible for someone familiar with 3D graphics programming to understand. I still remember how easy it was to write a single pixel to the screen in DOS and while I can't simplify to that degree (without losing modern power and flexibility), I can remove many of the most common difficulties. These include texture and vertex buffers, shader compiling and linking, shader variable passing, drawing text and 2D graphics, 3D transformations, etc.

Intuitive

Time spent looking for solutions is spent time, period. It ruins developer flow and can stop a project (especially a small one) indefinitely. Clinch should have few basic primitives which solve the general cases well and allow for easy replacements when necessary. It should be well documented and have a consistent interface. I will strive to keep abstraction leaks at a minimum.

Clinch does not try to wrap other libraries inside the Clinch namespace. This keeps developers from "relearning" the same functionality.

Flexible

Clinch does not inflict any particular design onto its client applications. It can be easily modified to create a specific engine. It uses plugins to minimize it's own overhead.

Architecture

Although Clinch can be used as a complete engine, most parts of Clinch are independent. You can use objects by themselves as best suits your application. For example, you can use a buffer object by itself. This also helps with testing by isolating the various parts of Clinch. The following is in hierarchical order based on the default configuration. This is to explain it as clearly as possible, not to indicate a necessary design.

Transforms

A transform is a 4x4 matrix which is used to hold and apply a C array of 16 floating values. CL-game-math is used as the default linear algebra library and its arrays may be passed to the shader. There are funcions for creating various projection matrices. Math functions are supplied through the rtg-math package.

Nodes

Nodes are usually the topmost objects in the hierarchy. Nodes abstract 3D transform "chains" and hierarchy. Nodes encapulate transforms and can be scaled, rotated, and translated. They also may have children. Nodes are multiplied together in a hierarchy to create the current transforms which is passes to its children. A node can be used in multiple places within a hierarchy (or tree) or even in several different ones. This is done by passing a list of parents to the update function. It will then append itself and call update on its children. In this way, the transform are only calculated when they or their parent(s) have changed.

Buffers

Buffers abstract the shared data on the graphics card. They can carry almost any data to the graphics card in bulk, including vertexes, normals, and texture coordinates. Buffers are usually sent to a shader through the entity object. A buffer's data can be accessed directly by using the map/unmap or pullg/pushg functions.

Textures

Textures abstract the 2D textures and allow easy access to their raw data. Textures can be loaded from files, drawn on with vector graphics or used as render targets. A texture's data can be accessed directly by using the map/unmap or pullg/pushg functions.

Pixel Buffers

They use Pixel Buffer Object to make texture reading and writing faster. It's a separate buffer object which can send and/or receive data from a texture. It's a separate buffer so it can be used for several similar textures.

Shaders

Shaders are the compiled output from text-based source code. Clinch supports vertex, fragment and geometry shaders.

Shader Programs

Shader programs are complete, usable GPU programs. They take input and output to a texture (by default the screen). Shader-programs require a vertex and fragment shader and may also include a geometry shader. They require a list of uniform and attribute arguments.

Entities

Entities are the rendered meshes. They bring together the shader-program, buffers, textures, attributes, uniforms and transforms together into something which can be rendered on the screen. A shader and an index buffer are required although they would be useless without at least one vertex buffer.

Viewports

An application can have several viewports. As Clinch does not force any particular windowing implementation, it can not have a window class. Once your window is set up, however, you can use the viewport handle for drawing an area on screen.

Frame Buffer objects

Frame buffer objects allows OpenGL to render to a texture or textures instead of a screen. The my also have a depth and/or stencle buffer.

Window

Clinch creates the window for you to make things easier. By default it's launched in a separate thread.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 clinch

Author

Brad Beer (WarWeasle)

License

MIT

Description

An OpenGL Game Engine.

Version

0.5

Dependencies

• cl-opengl
• trivial-garbage
• bordeaux-threads
• trivial-channels
• sdl2
• rtg-math
• swank

Source

clinch.asd (file)

Components

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

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 clinch.asd

Location

clinch.asd

Systems

clinch (system)

3.1.2 clinch/package.lisp

Parent

clinch (system)

Location

package.lisp

Packages

clinch

3.1.3 clinch/threads.lisp

Dependency

package.lisp (file)

Parent

clinch (system)

Location

threads.lisp

Internal Definitions

• $ (macro)
• $> (function)

3.1.4 clinch/clinch.lisp

Dependency

threads.lisp (file)

Parent

clinch (system)

Location

clinch.lisp

Exported Definitions

• ! (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 (method)
• unload-all-uncollected (function)

Internal Definitions

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

Parent

clinch (system)

Location

transform.lisp

Exported Definitions

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

Internal Definitions

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

3.1.6 clinch/node.lisp

Dependency

transform.lisp (file)

Parent

clinch (system)

Location

node.lisp

Exported Definitions

• !0 (generic function)
• !0 (method)
• !r (macro)
• !r0 (generic function)
• !r0 (method)
• !s (macro)
• !s0 (generic function)
• !s0 (method)
• !t (macro)
• !t0 (generic function)
• !t0 (method)
• *root* (special variable)
• add-child (method)
• changed? (method)
• (setf changed?) (method)
• children (method)
• (setf children) (method)
• enabled (method)
• (setf enabled) (method)
• n* (generic function)
• n* (method)
• n* (method)
• n* (method)
• n* (method)
• name (method)
• (setf name) (method)
• node (class)
• remove-child (method)
• render (method)
• render (method)
• rotate (generic function)
• rotate (method)
• rotation (method)
• (setf rotation) (generic function)
• (setf rotation) (method)
• scale (generic function)
• scale (method)
• scaling (method)
• (setf scaling) (generic function)
• (setf scaling) (method)
• transform (generic function)
• transform (method)
• (setf transform) (method)
• translate (generic function)
• translate (method)
• translation (method)
• (setf translation) (generic function)
• (setf translation) (method)
• traverse-node (method)
• update (method)
• walk-node-tree (method)
• walk-node-tree (method)
• with-new-node (macro)
• with-node (macro)

Internal Definitions

• current-transform (method)
• node-top-map (method)
• node-top-map-string (method)
• reset (generic function)
• reset (method)
• reset-rotation (generic function)
• reset-rotation (method)
• reset-scaling (generic function)
• reset-scaling (method)
• reset-translation (generic function)
• reset-translation (method)
• rotation-matrix (generic function)
• rotation-matrix (method)
• scale-matrix (generic function)
• scale-matrix (method)
• translation-matrix (generic function)
• translation-matrix (method)
• v0 (special variable)
• vi (special variable)

3.1.7 clinch/shaders.lisp

Dependency

node.lisp (file)

Parent

clinch (system)

Location

shaders.lisp

Exported Definitions

• id (method)
• name (method)
• shader-compile (method)
• shader-source (method)
• unload (method)

Internal Definitions

• add-finalizer (method)
• fragment-shader (class)
• geometry-shader (class)
• key (method)
• make-shader (method)
• make-shader (method)
• make-shader (method)
• shader (class)
• shader-attributes (method)
• shader-type (method)
• shader-uniforms (method)
• vertex-shader (class)

3.1.8 clinch/shader-program.lisp

Dependency

shaders.lisp (file)

Parent

clinch (system)

Location

shader-program.lisp

Exported Definitions

• !> (method)
• 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)
• name (method)
• program (method)
• pullg (method)
• shader-program (class)
• unload (method)
• use-shader-program (method)

Internal Definitions

• attach-shader (method)
• build-shader-program (method)
• build-shader-program (method)
• detach-shader (method)
• find-shader-attributes (method)
• find-shader-uniforms (method)
• key (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 (method)
• shader-program-uniform (method)
• (setf shader-program-uniform) (method)
• shader-program-uniforms (method)

3.1.9 clinch/default-shaders.lisp

Dependency

shader-program.lisp (file)

Parent

clinch (system)

Location

default-shaders.lisp

Exported Definitions

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

Internal Definitions

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

3.1.10 clinch/buffer.lisp

Dependency

default-shaders.lisp (file)

Parent

clinch (system)

Location

buffer.lisp

Exported Definitions

• !< (generic function)
• !< (method)
• !> (generic function)
• !> (method)
• (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 (method)
• map-buffer (method)
• pullg (generic function)
• pullg (method)
• pushg (generic function)
• pushg (method)
• qtype (method)
• (setf qtype) (method)
• size-in-bytes (method)
• stride (method)
• target (method)
• unbind (method)
• unload (method)
• unmap-buffer (method)
• usage (method)
• (setf usage) (method)
• vertex-count (method)
• with-mapped-buffer (macro)

Internal Definitions

• bind-buffer-to-normal-array (method)
• cffi-type->gl-type (function)
• key (method)
• loaded? (method)
• (setf loaded?) (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)

Parent

clinch (system)

Location

index-buffer.lisp

Exported Definitions

• draw-with-index-buffer (method)
• draw-with-ranged-index-buffer (method)
• id (method)
• index-buffer (class)
• qtype (method)
• (setf qtype) (method)
• stride (method)
• target (method)
• usage (method)
• (setf usage) (method)
• vertex-count (method)

Internal Definitions

• key (method)
• loaded? (method)
• (setf loaded?) (method)

3.1.12 clinch/pixel-buffer.lisp

Dependency

index-buffer.lisp (file)

Parent

clinch (system)

Location

pixel-buffer.lisp

Internal Definitions

pixel-buffer (class)

3.1.13 clinch/texture.lisp

Dependency

pixel-buffer.lisp (file)

Parent

clinch (system)

Location

texture.lisp

Exported Definitions

• !< (method)
• !< (method)
• !> (method)
• bind (method)
• bind-sampler (method)
• data-format (method)
• (setf data-format) (method)
• data-from-pointer (method)
• get-identity-texture (function)
• get-size (method)
• height (method)
• make-pbo-for-texture (method)
• pullg (method)
• pushg (method)
• pushg (method)
• qtype (method)
• (setf qtype) (method)
• set-texture-color (method)
• size-in-bytes (method)
• stride (method)
• tex-id (method)
• (setf tex-id) (method)
• texture (class)
• unbind (method)
• unload (method)
• width (method)
• with-temporary-pbo (macro)

Internal Definitions

• *default-texture* (special variable)
• *identity-texture* (special variable)
• data-from-list (method)
• internal-format (method)
• (setf internal-format) (method)
• key (method)
• with-texture (macro)

3.1.14 clinch/2d-node.lisp

Dependency

texture.lisp (file)

Parent

clinch (system)

Location

2d-node.lisp

Internal Definitions

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

3.1.15 clinch/entity.lisp

Dependency

2d-node.lisp (file)

Parent

clinch (system)

Location

entity.lisp

Exported Definitions

• attribute (method)
• (setf attribute) (method)
• attributes (method)
• enabled (method)
• (setf enabled) (method)
• entity (class)
• indexes (method)
• (setf indexes) (method)
• ray-entity-intersect? (method)
• render (method)
• shader-program (method)
• (setf shader-program) (method)
• uniform (method)
• (setf uniform) (method)
• uniforms (method)
• unload (method)
• update (method)
• with-attributes (macro)
• with-uniforms (macro)

Internal Definitions

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

3.1.16 clinch/viewport.lisp

Dependency

entity.lisp (file)

Parent

clinch (system)

Location

viewport.lisp

Exported Definitions

• clear-color (method)
• (setf clear-color) (method)
• height (method)
• (setf height) (method)
• quick-set (method)
• render (method)
• resize (method)
• viewport (class)
• width (method)
• (setf width) (method)
• x (method)
• (setf x) (method)
• y (method)
• (setf y) (method)

Internal Definitions

with-viewport (macro)

3.1.17 clinch/framebuffer.lisp

Dependency

viewport.lisp (file)

Parent

clinch (system)

Location

framebuffer.lisp

Exported Definitions

• *fbo* (special variable)
• bind (method)
• bind (method)
• color-attachment (method)
• (setf color-attachment) (method)
• depth-buffer (method)
• (setf depth-buffer) (method)
• frame-buffer (class)
• id (method)
• make-color-texture (method)
• make-depth-texture (method)
• target (method)
• (setf target) (method)
• unbind (method)
• unload (method)
• with-fbo (macro)

Internal Definitions

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

3.1.18 clinch/animation.lisp

Dependency

framebuffer.lisp (file)

Parent

clinch (system)

Location

animation.lisp

Exported Definitions

• animation (method)
• (setf animation) (method)
• animation (class)
• animator (class)
• frames (method)
• (setf frames) (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 (method)
• (setf name) (method)
• pause (generic function)
• pause (method)
• paused (method)
• (setf paused) (method)
• play (generic function)
• play (method)
• render (method)
• repeat (method)
• (setf repeat) (method)
• repeat (method)
• (setf repeat) (method)
• run-length (method)
• (setf run-length) (method)
• run-length (method)
• (setf run-length) (method)
• run-speed (method)
• (setf run-speed) (method)
• skip (generic function)
• skip (method)
• stop (generic function)
• stop (method)
• update (method)

Internal Definitions

• current-time (method)
• (setf current-time) (method)

3.1.19 clinch/window.lisp

Dependency

animation.lisp (file)

Parent

clinch (system)

Location

window.lisp

Exported Definitions

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

Internal Definitions

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

Parent

clinch (system)

Location

shapes.lisp

Exported Definitions

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

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 clinch

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• ! (macro)
• !! (macro)
• !0 (generic function)
• !0 (method)
• !< (generic function)
• !< (method)
• !< (method)
• !< (method)
• !> (generic function)
• !> (method)
• !> (method)
• !> (method)
• (setf !>) (generic function)
• (setf !>) (method)
• !r (macro)
• !r0 (generic function)
• !r0 (method)
• !s (macro)
• !s0 (generic function)
• !s0 (method)
• !t (macro)
• !t0 (generic function)
• !t0 (method)
• *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)
• add-child (method)
• animation (generic function)
• animation (method)
• (setf animation) (method)
• (setf animation) (generic function)
• animation (class)
• animator (class)
• attach-uniform (generic function)
• attach-uniform (method)
• attach-uniform (method)
• attach-uniform (method)
• attribute (generic function)
• attribute (method)
• (setf attribute) (method)
• (setf attribute) (generic function)
• attributes (generic function)
• attributes (method)
• bind (generic function)
• bind (method)
• bind (method)
• bind (method)
• bind (method)
• bind-buffer-to-attribute-array (generic function)
• bind-buffer-to-attribute-array (method)
• bind-buffer-to-vertex-array (generic function)
• bind-buffer-to-vertex-array (method)
• bind-sampler (generic function)
• bind-sampler (method)
• bind-static-values-to-attribute (generic function)
• bind-static-values-to-attribute (method)
• buffer (class)
• changed? (generic function)
• changed? (method)
• (setf changed?) (method)
• (setf changed?) (generic function)
• children (generic function)
• children (method)
• (setf children) (method)
• (setf children) (generic function)
• clear-color (generic function)
• clear-color (method)
• (setf clear-color) (method)
• (setf clear-color) (generic function)
• color-attachment (generic function)
• color-attachment (method)
• (setf color-attachment) (method)
• (setf color-attachment) (generic function)
• d->r (macro)
• data-format (generic function)
• data-format (method)
• (setf data-format) (method)
• (setf data-format) (generic function)
• data-from-pointer (generic function)
• data-from-pointer (method)
• data-from-pointer (method)
• decompose-transform (function)
• defevent (macro)
• degrees->radians (macro)
• depth-buffer (generic function)
• depth-buffer (method)
• (setf depth-buffer) (generic function)
• (setf depth-buffer) (method)
• draw-with-index-buffer (generic function)
• draw-with-index-buffer (method)
• draw-with-ranged-index-buffer (generic function)
• draw-with-ranged-index-buffer (method)
• enabled (generic function)
• enabled (method)
• (setf enabled) (method)
• enabled (method)
• (setf enabled) (method)
• (setf enabled) (generic function)
• ensure-float (macro)
• entity (class)
• frame-buffer (class)
• frames (generic function)
• frames (method)
• (setf frames) (method)
• (setf frames) (generic function)
• get-animation-time (generic function)
• get-animation-time (method)
• get-animation-time (method)
• get-animation-time (method)
• get-animation-time (method)
• get-animation-time (method)
• get-attribute-id (generic function)
• get-attribute-id (method)
• get-attribute-id (method)
• 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-keyframe (method)
• get-keyframe (method)
• get-keyframe (method)
• get-keyframe (method)
• get-keyframe (method)
• get-screen-direction (function)
• get-size (generic function)
• get-size (method)
• get-size (method)
• get-uniform-id (generic function)
• get-uniform-id (method)
• get-uniform-id (method)
• height (generic function)
• height (method)
• (setf height) (method)
• height (method)
• (setf height) (generic function)
• id (generic function)
• id (method)
• id (method)
• id (method)
• id (method)
• index-buffer (class)
• indexes (generic function)
• indexes (method)
• (setf indexes) (generic function)
• (setf indexes) (method)
• init (function)
• make-color-texture (generic function)
• make-color-texture (method)
• make-depth-texture (generic function)
• make-depth-texture (method)
• make-frustum-transform (function)
• make-orthogonal-transform (function)
• make-pbo-for-texture (generic function)
• make-pbo-for-texture (method)
• make-perspective-transform (function)
• make-quad (function)
• make-quad-and-texture (generic function)
• make-quad-and-texture (method)
• make-quad-for-texture (generic function)
• make-quad-for-texture (method)
• map-buffer (generic function)
• map-buffer (method)
• n* (generic function)
• n* (method)
• n* (method)
• n* (method)
• n* (method)
• name (generic function)
• name (method)
• (setf name) (method)
• name (method)
• name (method)
• name (method)
• (setf name) (method)
• (setf name) (generic function)
• node (class)
• pause (generic function)
• pause (method)
• paused (generic function)
• paused (method)
• (setf paused) (method)
• (setf paused) (generic function)
• play (generic function)
• play (method)
• program (generic function)
• program (method)
• pullg (generic function)
• pullg (method)
• pullg (method)
• pullg (method)
• pushg (generic function)
• pushg (method)
• pushg (method)
• pushg (method)
• qtype (generic function)
• qtype (method)
• (setf qtype) (method)
• qtype (method)
• (setf qtype) (method)
• qtype (method)
• (setf qtype) (method)
• (setf qtype) (generic function)
• quick-set (generic function)
• quick-set (method)
• r->d (macro)
• radians->degrees (macro)
• ray-entity-intersect? (generic function)
• ray-entity-intersect? (method)
• ray-triangle-intersect? (function)
• remove-child (generic function)
• remove-child (method)
• render (generic function)
• render (method)
• render (method)
• render (method)
• render (method)
• render (method)
• repeat (generic function)
• repeat (method)
• (setf repeat) (method)
• repeat (method)
• (setf repeat) (method)
• (setf repeat) (generic function)
• resize (generic function)
• resize (method)
• rotate (generic function)
• rotate (method)
• rotation (generic function)
• rotation (method)
• (setf rotation) (generic function)
• (setf rotation) (method)
• run-length (generic function)
• run-length (method)
• (setf run-length) (method)
• run-length (method)
• (setf run-length) (method)
• (setf run-length) (generic function)
• run-speed (generic function)
• run-speed (method)
• (setf run-speed) (method)
• (setf run-speed) (generic function)
• scale (generic function)
• scale (method)
• scaling (generic function)
• scaling (method)
• (setf scaling) (generic function)
• (setf scaling) (method)
• set-texture-color (generic function)
• set-texture-color (method)
• shader-compile (generic function)
• shader-compile (method)
• shader-program (generic function)
• shader-program (method)
• (setf shader-program) (generic function)
• (setf shader-program) (method)
• shader-program (class)
• shader-source (generic function)
• shader-source (method)
• (setf shader-source) (generic function)
• size-in-bytes (generic function)
• size-in-bytes (method)
• size-in-bytes (method)
• skip (generic function)
• skip (method)
• stop (generic function)
• stop (method)
• stride (generic function)
• stride (method)
• stride (method)
• stride (method)
• target (generic function)
• target (method)
• (setf target) (method)
• target (method)
• target (method)
• (setf target) (generic function)
• tex-id (generic function)
• tex-id (method)
• (setf tex-id) (method)
• (setf tex-id) (generic function)
• texture (class)
• topological-sort (function)
• transform (generic function)
• transform (method)
• (setf transform) (generic function)
• (setf transform) (method)
• transform-point (function)
• transform-points (function)
• translate (generic function)
• translate (method)
• translation (generic function)
• translation (method)
• (setf translation) (generic function)
• (setf translation) (method)
• traverse-node (generic function)
• traverse-node (method)
• unbind (generic function)
• unbind (method)
• unbind (method)
• unbind (method)
• uniform (generic function)
• uniform (method)
• (setf uniform) (method)
• (setf uniform) (generic function)
• uniforms (generic function)
• uniforms (method)
• uninit (function)
• unload (generic function)
• unload (method)
• unload (method)
• unload (method)
• unload (method)
• unload (method)
• unload (method)
• unload (method)
• unload-all-uncollected (function)
• unmap-buffer (generic function)
• unmap-buffer (method)
• unproject (function)
• update (generic function)
• update (method)
• update (method)
• update (method)
• usage (generic function)
• usage (method)
• (setf usage) (method)
• usage (method)
• (setf usage) (method)
• (setf usage) (generic function)
• use-shader-program (generic function)
• use-shader-program (method)
• vertex-count (generic function)
• vertex-count (method)
• vertex-count (method)
• viewport (class)
• walk-node-tree (generic function)
• walk-node-tree (method)
• walk-node-tree (method)
• width (generic function)
• width (method)
• (setf width) (method)
• width (method)
• (setf width) (generic function)
• 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 function)
• x (method)
• (setf x) (method)
• (setf x) (generic function)
• y (generic function)
• y (method)
• (setf y) (method)
• (setf y) (generic function)

Internal Definitions

• $ (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-color-buffer (method)
• add-dependent (function)
• add-finalizer (generic function)
• add-finalizer (method)
• add-uncollected (function)
• attach-shader (generic function)
• attach-shader (method)
• average-vectors (macro)
• bind-buffer-to-normal-array (generic function)
• bind-buffer-to-normal-array (method)
• bones (generic function)
• bones (method)
• (setf bones) (method)
• (setf bones) (generic function)
• build-shader-program (generic function)
• build-shader-program (method)
• build-shader-program (method)
• cffi-type->gl-type (function)
• clone-function (macro)
• color-attachment-0 (constant)
• color-attachments (generic function)
• color-attachments (method)
• continuable (macro)
• convert-non-buffer (function)
• current-time (generic function)
• current-time (method)
• (setf current-time) (method)
• (setf current-time) (generic function)
• current-transform (generic function)
• current-transform (method)
• data-from-list (generic function)
• data-from-list (method)
• define-default-shader (macro)
• delete-entity (generic function)
• delete-entity (method)
• detach-shader (generic function)
• detach-shader (method)
• ensure-cepl-compatible-setup (function)
• find-shader-attributes (generic function)
• find-shader-attributes (method)
• find-shader-uniforms (generic function)
• find-shader-uniforms (method)
• 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 function)
• internal-format (method)
• (setf internal-format) (method)
• (setf internal-format) (generic function)
• key (generic function)
• key (method)
• key (method)
• key (method)
• key (method)
• key (method)
• key (method)
• list-raw-shader-attributes (generic function)
• list-raw-shader-attributes (method)
• list-shader-attributes (generic function)
• list-shader-attributes (method)
• list-shader-uniforms (generic function)
• list-shader-uniforms (method)
• loaded? (generic function)
• loaded? (method)
• (setf loaded?) (method)
• loaded? (method)
• (setf loaded?) (method)
• (setf loaded?) (generic function)
• 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-shader (method)
• make-shader (method)
• make-shader (method)
• make-shareable-array (generic function)
• make-shareable-array (method)
• make-sphere (function)
• merge-hashes (function)
• midpoint (function)
• mode (generic function)
• mode (method)
• node-top-map (generic function)
• node-top-map (method)
• node-top-map-string (generic function)
• node-top-map-string (method)
• 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-attribute (method)
• remove-shader-program-uniform (generic function)
• remove-shader-program-uniform (method)
• remove-shader-value-suffix (function)
• remove-shader-value-type-suffix (function)
• remove-uncollected (function)
• reset (generic function)
• reset (method)
• reset-rotation (generic function)
• reset-rotation (method)
• reset-scaling (generic function)
• reset-scaling (method)
• reset-translation (generic function)
• reset-translation (method)
• rotation-matrix (generic function)
• rotation-matrix (method)
• scale-matrix (generic function)
• scale-matrix (method)
• 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 function)
• shader-attributes (method)
• shader-program-attribute (generic function)
• shader-program-attribute (method)
• (setf shader-program-attribute) (method)
• (setf shader-program-attribute) (generic function)
• shader-program-attributes (generic function)
• shader-program-attributes (method)
• shader-program-uniform (generic function)
• shader-program-uniform (method)
• (setf shader-program-uniform) (method)
• (setf shader-program-uniform) (generic function)
• shader-program-uniforms (generic function)
• shader-program-uniforms (method)
• shader-type (generic function)
• shader-type (method)
• shader-uniforms (generic function)
• shader-uniforms (method)
• split-keywords (function)
• stencil-attachments (generic function)
• stencil-attachments (method)
• transform-tree (function)
• translation-matrix (generic function)
• translation-matrix (method)
• tst (function)
• unbind-buffer-attribute-array (generic function)
• unbind-buffer-attribute-array (method)
• unbind-normal-array (generic function)
• unbind-normal-array (method)
• unbind-vertex-array (generic function)
• unbind-vertex-array (method)
• 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)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Constants

Constant: +pi+

A single-float version of pi.

Package

clinch

Source

transform.lisp (file)

5.1.2 Special variables

Special Variable: *context*

Global Opengl Contex object.

Package

clinch

Source

clinch.lisp (file)

Special Variable: *controllers*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *default-on-idle*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *delta-ticks*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *entity*

The current entity

Package

clinch

Source

clinch.lisp (file)

Special Variable: *fbo*

Current Frame Buffer Object.

Package

clinch

Source

framebuffer.lisp (file)

Special Variable: *haptic*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *next*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *node*

Current default node.

Package

clinch

Source

clinch.lisp (file)

Special Variable: *on-controller-added*

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

Package

clinch

Source

window.lisp (file)

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 (file)

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 (file)

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 (file)

Special Variable: *on-controller-remapped*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *on-controller-removed*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *on-idle*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *on-key-down*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *on-key-up*

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

Package

clinch

Source

window.lisp (file)

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 (file)

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

Package

clinch

Source

window.lisp (file)

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 (file)

Special Variable: *on-mouse-move*

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

Package

clinch

Source

window.lisp (file)

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 (file)

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

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

Package

clinch

Source

window.lisp (file)

Special Variable: *on-quit*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *on-text-editing*

Called when editing text.

Package

clinch

Source

window.lisp (file)

Special Variable: *on-text-input*

Call when text input happens.

Package

clinch

Source

window.lisp (file)

Special Variable: *on-window-close*

Called when window is closing. Arguments (window timestamp)

Package

clinch

Source

window.lisp (file)

Special Variable: *on-window-enter*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *on-window-exposed*

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

Package

clinch

Source

window.lisp (file)

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

Called when window gains focus. Arguments (window timestamp)

Package

clinch

Source

window.lisp (file)

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

Called when window loses focus. Arguments (window timestamp)

Package

clinch

Source

window.lisp (file)

Special Variable: *on-window-hidden*

Called when window is hidden. Arguments (window timestamp)

Package

clinch

Source

window.lisp (file)

Special Variable: *on-window-leave*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *on-window-maximized*

Called when window is maximized. Arguments (window timestamp)

Package

clinch

Source

window.lisp (file)

Special Variable: *on-window-minimized*

Called when window is minimized. Arguments (window timestamp)

Package

clinch

Source

window.lisp (file)

Special Variable: *on-window-moved*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *on-window-resized*

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

Package

clinch

Source

window.lisp (file)

Special Variable: *on-window-restored*

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

Package

clinch

Source

window.lisp (file)

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

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

Package

clinch

Source

window.lisp (file)

Special Variable: *ortho-projection*

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

Package

clinch

Source

clinch.lisp (file)

Special Variable: *projection*

Current default projection.

Package

clinch

Source

clinch.lisp (file)

Special Variable: *root*

The default root node.

Package

clinch

Source

node.lisp (file)

Special Variable: *texture*

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

Package

clinch

Source

clinch.lisp (file)

Special Variable: *ticks*

Time elapsed since (init) in milliseconds.

Package

clinch

Source

window.lisp (file)

Special Variable: *uncollected*

Weak hash of loaded OpenGL objects.

Package

clinch

Source

clinch.lisp (file)

Special Variable: *viewport*

Current viewport object.

Package

clinch

Source

clinch.lisp (file)

Special Variable: *window*

Global window object.

Package

clinch

Source

clinch.lisp (file)

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 (file)

Macro: !! &body BODY

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

Package

clinch

Source

clinch.lisp (file)

Macro: !r THIS W X Y Z &optional IN-PLACE

Package

clinch

Source

node.lisp (file)

Macro: !s THIS X Y Z &optional IN-PLACE

Package

clinch

Source

node.lisp (file)

Macro: !t THIS X Y Z &optional IN-PLACE

Package

clinch

Source

node.lisp (file)

Macro: d->r DEGREES

Converts degrees to radians.

Package

clinch

Source

transform.lisp (file)

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 (file)

Macro: degrees->radians DEGREES

Converts degrees to radians.

Package

clinch

Source

transform.lisp (file)

Macro: ensure-float X

Coerce a number to a single-float.

Package

clinch

Source

transform.lisp (file)

Macro: r->d RADIANS

Converts radians to degrees.

Package

clinch

Source

transform.lisp (file)

Macro: radians->degrees RADIANS

Converts radians to degrees.

Package

clinch

Source

transform.lisp (file)

Macro: with-attributes ARGS THIS &body BODY

Package

clinch

Source

entity.lisp (file)

Macro: with-fbo (FBO) &body BODY

Convenience macro for useing and resetting an FBO.

Package

clinch

Source

framebuffer.lisp (file)

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 (file)

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 (file)

Macro: with-node (NODE) &body BODY

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

Package

clinch

Source

node.lisp (file)

Macro: with-temporary-pbo (VAR TEXTURE &key USAGE TARGET) &body BODY

Creates a temporary pixel buffer for a texture.

Package

clinch

Source

texture.lisp (file)

Macro: with-uniforms ARGS THIS &body BODY

Package

clinch

Source

entity.lisp (file)

5.1.4 Functions

Function: *default-on-idle* ()

Package

clinch

Source

window.lisp (file)

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 (file)

Function: get-default-texture ()

Package

clinch

Source

shapes.lisp (file)

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

Package

clinch

Source

default-shaders.lisp (file)

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

Package

clinch

Source

default-shaders.lisp (file)

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

Package

clinch

Source

default-shaders.lisp (file)

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

Package

clinch

Source

default-shaders.lisp (file)

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

Package

clinch

Source

default-shaders.lisp (file)

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 (file)

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 (file)

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 (file)

Function: get-screen-direction LENS-1

Gets the direction from the middle of the screen.

Package

clinch

Source

transform.lisp (file)

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 (file)

Function: make-frustum-transform LEFT RIGHT BOTTOM TOP NEAR FAR

Create a raw CFFI frustum matrix.

Package

clinch

Source

transform.lisp (file)

Function: make-orthogonal-transform WIDTH HEIGHT NEAR FAR

Create a raw CFFI orthogonal matrix.

Package

clinch

Source

transform.lisp (file)

Function: make-perspective-transform FOVY ASPECT ZNEAR ZFAR

Create a raw CFFI perspective matrix.

Package

clinch

Source

transform.lisp (file)

Function: make-quad WIDTH HEIGHT &key CENTER SHADER-PROGRAM TEXTURE PARENT

Creates a quad entity of width and height.

Package

clinch

Source

shapes.lisp (file)

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 (file)

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 (file)

Function: transform-point P M

Package

clinch

Source

transform.lisp (file)

Function: transform-points POINTS MATRIX

Package

clinch

Source

transform.lisp (file)

Function: uninit ()

Package

clinch

Source

window.lisp (file)

Function: unload-all-uncollected ()

Unloads all loaded OpenGL objects.

Package

clinch

Source

clinch.lisp (file)

Function: unproject X Y WIDTH HEIGHT INV-TRANSFORM

Unproject from the screen to transform space.

Package

clinch

Source

transform.lisp (file)

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

Source

node.lisp (file)

Methods

Method: !0 (THIS node)

Resets the node.

Generic Function: !< THIS DATA &key

Package

clinch

Source

buffer.lisp (file)

Methods

Method: !< (TEX texture) (DATA array) &key

Sets the texture data from a vector array.

Source

texture.lisp (file)

Method: !< (THIS texture) (PBO pixel-buffer) &key

Sets the texture data from a pixel buffer.

Source

texture.lisp (file)

Method: !< (THIS buffer) (DATA array) &key

Sets the buffer data from a vector array.

Generic Function: !> THIS &key DATA-FORMAT INDEX OFFSET SIZE

Package

clinch

Source

buffer.lisp (file)

Writer

(setf !>) (generic function)

Methods

Method: !> (TEX texture) &key DATA-FORMAT

Gets the texture data as a vector array.

Source

texture.lisp (file)

Method: !> (THIS buffer) &key INDEX OFFSET SIZE

Returns the buffer’s data as a vector array.

Method: !> (THIS shader-program) &key

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

Source

shader-program.lisp (file)

Generic Function: (setf !>) DATA THIS

Package

clinch

Reader

!> (generic function)

Methods

Method: (setf !>) (DATA array) (THIS buffer)

Source

buffer.lisp (file)

Generic Function: !r0 THIS

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

Package

clinch

Source

node.lisp (file)

Methods

Method: !r0 (THIS node)

Generic Function: !s0 THIS

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

Package

clinch

Source

node.lisp (file)

Methods

Method: !s0 (THIS node)

Generic Function: !t0 THIS

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

Package

clinch

Source

node.lisp (file)

Methods

Method: !t0 (THIS node)

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 (file)

Generic Function: animation OBJECT

Generic Function: (setf animation) NEW-VALUE OBJECT

Package

clinch

Methods

Method: animation (ANIMATOR animator)

automatically generated reader method

Source

animation.lisp (file)

Method: (setf animation) NEW-VALUE (ANIMATOR animator)

automatically generated writer method

Source

animation.lisp (file)

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 (file)

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 (file)

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 (file)

Generic Function: attribute THIS NAME

Generic Function: (setf attribute) NEW-VALUE THIS NAME

Package

clinch

Methods

Method: attribute (THIS entity) NAME

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

Source

entity.lisp (file)

Method: (setf attribute) NEW-VALUE (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 (file)

Generic Function: attributes OBJECT

Package

clinch

Methods

Method: attributes (ENTITY entity)

automatically generated reader method

Source

entity.lisp (file)

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 (file)

Method: bind (THIS frame-buffer) &key

Wrapper around glBindFrameBuffer. Puts the Framebuffer into play.

Source

framebuffer.lisp (file)

Method: bind (THIS texture) &key

Wrapper around glBindBuffer. Puts the texture into play.

Source

texture.lisp (file)

Method: bind (THIS buffer) &key INDEX OFFSET LENGTH

Wrapper around glBindBuffer. Binds this buffer for use.

Source

buffer.lisp (file)

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 (file)

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 (file)

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 (file)

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 (file)

Generic Function: changed? THIS

Generic Function: (setf changed?) VAL THIS

Package

clinch

Methods

Method: changed? (THIS node)

Has this node changed and not updated?

Source

node.lisp (file)

Method: (setf changed?) VAL (THIS node)

Set this node to update later.

Source

node.lisp (file)

Generic Function: children OBJECT

Generic Function: (setf children) NEW-VALUE OBJECT

Package

clinch

Methods

Method: children (NODE node)

automatically generated reader method

Source

node.lisp (file)

Method: (setf children) NEW-VALUE (NODE node)

automatically generated writer method

Source

node.lisp (file)

Generic Function: clear-color OBJECT

Generic Function: (setf clear-color) NEW-VALUE OBJECT

Package

clinch

Methods

Method: clear-color (VIEWPORT viewport)

automatically generated reader method

Source

viewport.lisp (file)

Method: (setf clear-color) NEW-VALUE (VIEWPORT viewport)

automatically generated writer method

Source

viewport.lisp (file)

Generic Function: color-attachment THIS NAME

Generic Function: (setf color-attachment) NEW-VALUE THIS NAME

Package

clinch

Methods

Method: color-attachment (THIS frame-buffer) NAME

Returns a color-attachment by number.

Source

framebuffer.lisp (file)

Method: (setf color-attachment) NEW-VALUE (THIS frame-buffer) NAME

Sets an attachment’s number

Source

framebuffer.lisp (file)

Generic Function: data-format OBJECT

Generic Function: (setf data-format) NEW-VALUE OBJECT

Package

clinch

Methods

Method: data-format (TEXTURE texture)

automatically generated reader method

Source

texture.lisp (file)

Method: (setf data-format) NEW-VALUE (TEXTURE texture)

automatically generated writer method

Source

texture.lisp (file)

Generic Function: data-from-pointer THIS POINTER

Package

clinch

Methods

Method: data-from-pointer (THIS texture) POINTER

Source

texture.lisp (file)

Method: data-from-pointer (THIS buffer) POINTER

Source

buffer.lisp (file)

Generic Function: depth-buffer OBJECT

Generic Function: (setf depth-buffer) DB THIS

Package

clinch

Methods

Method: depth-buffer (FRAME-BUFFER frame-buffer)

automatically generated reader method

Source

framebuffer.lisp (file)

Method: (setf depth-buffer) (DB texture) (THIS frame-buffer)

Binds the depth buffer for use.

Source

framebuffer.lisp (file)

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 (file)

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 (file)

Generic Function: enabled OBJECT

Generic Function: (setf enabled) NEW-VALUE OBJECT

Package

clinch

Methods

Method: enabled (ENTITY entity)

automatically generated reader method

Source

entity.lisp (file)

Method: (setf enabled) NEW-VALUE (ENTITY entity)

automatically generated writer method

Source

entity.lisp (file)

Method: enabled (NODE node)

automatically generated reader method

Source

node.lisp (file)

Method: (setf enabled) NEW-VALUE (NODE node)

automatically generated writer method

Source

node.lisp (file)

Generic Function: frames OBJECT

Generic Function: (setf frames) NEW-VALUE OBJECT

Package

clinch

Methods

Method: frames (ANIMATION animation)

automatically generated reader method

Source

animation.lisp (file)

Method: (setf frames) NEW-VALUE (ANIMATION animation)

automatically generated writer method

Source

animation.lisp (file)

Generic Function: get-animation-time THIS

Package

clinch

Methods

Method: get-animation-time (THIS animator)

Source

animation.lisp (file)

Method: get-animation-time (THIS animation)

Source

animation.lisp (file)

Method: get-animation-time (THIS vector)

Source

animation.lisp (file)

Method: get-animation-time (THIS list)

Source

animation.lisp (file)

Method: get-animation-time THIS

Source

animation.lisp (file)