The umbra Reference Manual

3.1.1 umbra/umbra.asd

Source

umbra.asd.

Parent Component

umbra (system).

ASDF Systems

umbra.

3.1.2 umbra/package.lisp

Source

umbra.asd.

Parent Component

umbra (system).

Packages

• umbra.effects.
• umbra.sprite.
• umbra.common.
• umbra.hashing.
• umbra.graphing.
• umbra.color.
• umbra.sdf.
• umbra.noise.
• umbra.shaping.

3.1.3 umbra/common.lisp

Dependency

package.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.4 umbra/common-swizzle.lisp

Dependency

common.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

Internals

• %swizzle/char-position (function).
• %swizzle/combinations (function).
• %swizzle/component-groups (function).
• define-vari-swizzle-macros (macro).

3.1.5 umbra/common-vari.lisp

Dependency

common-swizzle.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.6 umbra/common-math.lisp

Dependency

common-vari.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

Public Interface

• +epsilon+ (constant).
• +half-pi+ (constant).
• +pi+ (constant).

3.1.7 umbra/common-structs.lisp

Dependency

common-math.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

Public Interface

• mesh-attrs (class).
• type->type-spec (method).
• v-glsl-string (reader method).
• v-slots (reader method).

Internals

• (setf v-signature) (writer method).
• v-signature (reader method).

3.1.8 umbra/color-space.lisp

Dependency

common-structs.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

Internals

• +gamma+ (constant).
• +gamma-inverse+ (constant).

3.1.9 umbra/color-grading.lisp

Dependency

color-space.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.10 umbra/graphing.lisp

Dependency

color-grading.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.11 umbra/shaping-iq.lisp

Dependency

graphing.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.12 umbra/shaping-levin.lisp

Dependency

shaping-iq.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.13 umbra/shaping-penner.lisp

Dependency

shaping-levin.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.14 umbra/shaping-misc.lisp

Dependency

shaping-penner.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.15 umbra/hashing-bbs.lisp

Dependency

shaping-misc.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.16 umbra/hashing-fast32.lisp

Dependency

hashing-bbs.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.17 umbra/hashing-fast32-2.lisp

Dependency

hashing-fast32.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.18 umbra/hashing-sgpp.lisp

Dependency

hashing-fast32-2.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.19 umbra/noise-cellular.lisp

Dependency

hashing-sgpp.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.20 umbra/noise-hermite.lisp

Dependency

noise-cellular.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.21 umbra/noise-perlin.lisp

Dependency

noise-hermite.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.22 umbra/noise-polkadot.lisp

Dependency

noise-perlin.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.23 umbra/noise-simplex.lisp

Dependency

noise-polkadot.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

Internals

• +simplex-2d/inverse-triangle-half-edge-length+ (constant).
• +simplex-2d/inverse-triangle-height+ (constant).
• +simplex-2d/norm-factor+ (constant).
• +simplex-2d/skew-factor+ (constant).
• +simplex-2d/triangle-height+ (constant).
• +simplex-2d/unskew-factor+ (constant).
• +simplex-3d/inverse-pyramid-height+ (constant).
• +simplex-3d/inverse-triangle-half-edge-length+ (constant).
• +simplex-3d/norm-factor+ (constant).
• +simplex-3d/pyramid-height+ (constant).
• +simplex-3d/skew-factor+ (constant).
• +simplex-3d/unskew-factor+ (constant).

3.1.24 umbra/noise-value.lisp

Dependency

noise-simplex.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.25 umbra/noise-misc.lisp

Dependency

noise-value.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.26 umbra/noise-utils.lisp

Dependency

noise-misc.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.27 umbra/sdf-2d.lisp

Dependency

noise-utils.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

3.1.28 umbra/sprite.lisp

Dependency

sdf-2d.lisp (file).

Source

umbra.asd.

Parent Component

umbra (system).

Public Interface

• type->type-spec (method).
• type->type-spec (method).
• v-glsl-string (reader method).
• v-glsl-string (reader method).
• v-slots (reader method).
• v-slots (reader method).

Internals

• sprite-data (class).
• spritesheet-data (class).
• (setf v-signature) (writer method).
• v-signature (reader method).
• (setf v-signature) (writer method).
• v-signature (reader method).

5.1.1 Constants

Constant: +epsilon+ ¶

Package

umbra.common.

Source

common-math.lisp.

Constant: +half-pi+ ¶

Package

umbra.common.

Source

common-math.lisp.

Constant: +pi+ ¶

Package

umbra.common.

Source

common-math.lisp.

5.1.2 Standalone methods

Method: type->type-spec ((type sprite-data)) ¶

Package

varjo.internals.

Source

sprite.lisp.

Method: type->type-spec ((type spritesheet-data)) ¶

Package

varjo.internals.

Source

sprite.lisp.

Method: type->type-spec ((type mesh-attrs)) ¶

Package

varjo.internals.

Source

common-structs.lisp.

Reader Method: v-glsl-string ((sprite-data sprite-data)) ¶

automatically generated reader method

Package

varjo.internals.

Source

sprite.lisp.

Target Slot

glsl-string.

Reader Method: v-glsl-string ((spritesheet-data spritesheet-data)) ¶

automatically generated reader method

Package

varjo.internals.

Source

sprite.lisp.

Target Slot

glsl-string.

Reader Method: v-glsl-string ((mesh-attrs mesh-attrs)) ¶

automatically generated reader method

Package

varjo.internals.

Source

common-structs.lisp.

Target Slot

glsl-string.

Reader Method: v-slots ((sprite-data sprite-data)) ¶

automatically generated reader method

Package

varjo.internals.

Source

sprite.lisp.

Target Slot

slots.

Reader Method: v-slots ((spritesheet-data spritesheet-data)) ¶

automatically generated reader method

Package

varjo.internals.

Source

sprite.lisp.

Target Slot

slots.

Reader Method: v-slots ((mesh-attrs mesh-attrs)) ¶

automatically generated reader method

Package

varjo.internals.

Source

common-structs.lisp.

Target Slot

slots.

5.1.3 Classes

Class: mesh-attrs ¶

Package

umbra.common.

Source

common-structs.lisp.

Direct superclasses

v-user-struct.

Direct methods

• type->type-spec.
• v-glsl-string.
• (setf v-signature).
• v-signature.
• v-slots.

Direct slots

Slot: type-name ¶

Package

varjo.internals.

Initform

(quote umbra.common:mesh-attrs)

Slot: superclass ¶

Package

varjo.internals.

Initform

(quote vari.types:v-user-struct)

Slot: glsl-string ¶

Package

varjo.internals.

Initform

"mesh_attrs"

Initargs

:glsl-string

Readers

v-glsl-string.

Writers

This slot is read-only.

Slot: signature ¶

Package

varjo.internals.

Initform

"struct mesh_attrs { vec3 mesh47pos; vec3 mesh47normal; vec4 mesh47tangent; vec4 mesh47color; vec2 mesh47uv1; vec2 mesh47uv2; vec4 mesh47joints; vec4 mesh47weights; };"

Initargs

:signature

Readers

v-signature.

Writers

(setf v-signature).

Slot: slots ¶

Package

varjo.internals.

Initform

(quote ((umbra.common:mesh/pos #<vari.types:v-vec3 {10051337e3}> umbra.common::mesh-attrs-mesh/pos "~a.mesh47pos") (umbra.common:mesh/normal #<vari.types:v-vec3 {10051337f3}> umbra.common::mesh-attrs-mesh/normal "~a.mesh47normal") (umbra.common:mesh/tangent #<vari.types:v-vec4 {1005133803}> umbra.common::mesh-attrs-mesh/tangent "~a.mesh47tangent") (umbra.common:mesh/color #<vari.types:v-vec4 {1005133813}> umbra.common::mesh-attrs-mesh/color "~a.mesh47color") (umbra.common:mesh/uv1 #<vari.types:v-vec2 {1005133823}> umbra.common::mesh-attrs-mesh/uv1 "~a.mesh47uv1") (umbra.common:mesh/uv2 #<vari.types:v-vec2 {1005133833}> umbra.common::mesh-attrs-mesh/uv2 "~a.mesh47uv2") (umbra.common:mesh/joints #<vari.types:v-vec4 {1005133843}> umbra.common::mesh-attrs-mesh/joints "~a.mesh47joints") (umbra.common:mesh/weights #<vari.types:v-vec4 {1005133853}> umbra.common::mesh-attrs-mesh/weights "~a.mesh47weights")))

Readers

v-slots.

Writers

This slot is read-only.

5.2.1 Constants

Constant: +gamma+ ¶

Package

umbra.color.

Source

color-space.lisp.

Constant: +gamma-inverse+ ¶

Package

umbra.color.

Source

color-space.lisp.

Constant: +simplex-2d/inverse-triangle-half-edge-length+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-2d/inverse-triangle-height+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-2d/norm-factor+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-2d/skew-factor+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-2d/triangle-height+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-2d/unskew-factor+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-3d/inverse-pyramid-height+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-3d/inverse-triangle-half-edge-length+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-3d/norm-factor+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-3d/pyramid-height+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-3d/skew-factor+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

Constant: +simplex-3d/unskew-factor+ ¶

Package

umbra.noise.

Source

noise-simplex.lisp.

5.2.2 Macros

Macro: define-vari-swizzle-macros () ¶

Package

umbra.common.

Source

common-swizzle.lisp.

5.2.3 Ordinary functions

Function: %swizzle/char-position (components index) ¶

Package

umbra.common.

Source

common-swizzle.lisp.

Function: %swizzle/combinations (n items) ¶

Package

umbra.common.

Source

common-swizzle.lisp.

Function: %swizzle/component-groups (size) ¶

Package

umbra.common.

Source

common-swizzle.lisp.

5.2.4 Standalone methods

Writer Method: (setf v-signature) ((sprite-data sprite-data)) ¶

automatically generated writer method

Package

varjo.internals.

Source

sprite.lisp.

Target Slot

signature.

Reader Method: v-signature ((sprite-data sprite-data)) ¶

automatically generated reader method

Package

varjo.internals.

Source

sprite.lisp.

Target Slot

signature.

Writer Method: (setf v-signature) ((spritesheet-data spritesheet-data)) ¶

automatically generated writer method

Package

varjo.internals.

Source

sprite.lisp.

Target Slot

signature.

Reader Method: v-signature ((spritesheet-data spritesheet-data)) ¶

automatically generated reader method

Package

varjo.internals.

Source

sprite.lisp.

Target Slot

signature.

Writer Method: (setf v-signature) ((mesh-attrs mesh-attrs)) ¶

automatically generated writer method

Package

varjo.internals.

Source

common-structs.lisp.

Target Slot

signature.

Reader Method: v-signature ((mesh-attrs mesh-attrs)) ¶

automatically generated reader method

Package

varjo.internals.

Source

common-structs.lisp.

Target Slot

signature.

5.2.5 Classes

Class: sprite-data ¶

Package

umbra.sprite.

Source

sprite.lisp.

Direct superclasses

v-user-struct.

Direct methods

• type->type-spec.
• v-glsl-string.
• (setf v-signature).
• v-signature.
• v-slots.

Direct slots

Slot: type-name ¶

Package

varjo.internals.

Initform

(quote umbra.sprite::sprite-data)

Slot: superclass ¶

Package

varjo.internals.

Initform

(quote vari.types:v-user-struct)

Slot: glsl-string ¶

Package

varjo.internals.

Initform

"sprite_data"

Initargs

:glsl-string

Readers

v-glsl-string.

Writers

This slot is read-only.

Slot: signature ¶

Package

varjo.internals.

Initform

"struct sprite_data { sampler2d sampler; int index; };"

Initargs

:signature

Readers

v-signature.

Writers

(setf v-signature).

Slot: slots ¶

Package

varjo.internals.

Initform

(quote ((umbra.sprite::sampler #<vari.types:v-sampler-2d {1002867253}> umbra.sprite::sampler "~a.sampler") (umbra.sprite::index #<vari.types:v-int {1002867593}> umbra.sprite::index "~a.index")))

Readers

v-slots.

Writers

This slot is read-only.

Class: spritesheet-data ¶

Package

umbra.sprite.

Source

sprite.lisp.

Direct superclasses

v-user-struct.

Direct methods

• type->type-spec.
• v-glsl-string.
• (setf v-signature).
• v-signature.
• v-slots.

Direct slots

Slot: type-name ¶

Package

varjo.internals.

Initform

(quote umbra.sprite::spritesheet-data)

Slot: superclass ¶

Package

varjo.internals.

Initform

(quote vari.types:v-user-struct)

Slot: glsl-string ¶

Package

varjo.internals.

Initform

"spritesheet_data"

Initargs

:glsl-string

Readers

v-glsl-string.

Writers

This slot is read-only.

Slot: signature ¶

Package

varjo.internals.

Initform

"struct spritesheet_data { ivec2 pos[(2048)]; ivec2 size[(2048)]; };"

Initargs

:signature

Readers

v-signature.

Writers

(setf v-signature).

Slot: slots ¶

Package

varjo.internals.

Initform

(quote ((umbra.sprite::pos #<vari.types:v-array {1002a11663}> umbra.sprite::pos "~a.pos") (umbra.sprite::size #<vari.types:v-array {1002a119d3}> umbra.sprite::size "~a.size")))

Readers

v-slots.

Writers

This slot is read-only.