The umbra Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The umbra Reference Manual

This is the umbra Reference Manual, version 0.1.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Fri May 24 10:01:31 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

umbra

A library of reusable GPU shader functions.

Overview

This is a library consisting of a collection of useful GPU shader functions, written with Shadow.

Install

(ql:quickload :umbra)

Usage

The functions contained in this library are meant to be compiled by your GPU, using Shadow. On their own, they don't do anything, Please consult the Shadow documentation for usage instructions for inclusion in a shader program.

License

Copyright © Michael Fiano mail@michaelfiano.com.

Licensed under the MIT License.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 umbra

Maintainer

Michael Fiano <mail@michaelfiano.com>

Author

Michael Fiano <mail@michaelfiano.com>

Home Page

https://www.michaelfiano.com/projects/umbra

Source Control

(:git "https://github.com/mfiano/umbra.git")

Bug Tracker

https://github.com/mfiano/umbra/issues

License

MIT

Description

A library of reusable GPU shader functions.

Long Description

# umbra

A library of reusable GPU shader functions.

## Overview

This is a library consisting of a collection of useful GPU shader functions, written with [Shadow](https://github.com/mfiano/shadow).

## Install

“‘lisp
(ql:quickload :umbra)
“‘

## Usage

The functions contained in this library are meant to be compiled by your GPU, using [Shadow](https://github.com/mfiano/shadow). On their own, they don’t do anything, Please consult the Shadow documentation for usage instructions for inclusion in a shader program.

## License

Copyright © Michael Fiano <mail@michaelfiano.com>.

Licensed under the MIT License.

Version

0.1.0

Dependencies
Source

umbra.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 umbra/common

Parent

umbra (system)

Location

common/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.2 umbra/color

Dependency

common (module)

Parent

umbra (system)

Location

color/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.3 umbra/graph

Dependency

color (module)

Parent

umbra (system)

Location

graph/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.4 umbra/shaping

Dependency

graph (module)

Parent

umbra (system)

Location

shaping/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.5 umbra/hashing

Dependency

shaping (module)

Parent

umbra (system)

Location

hashing/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.6 umbra/noise

Dependency

hashing (module)

Parent

umbra (system)

Location

noise/

Components

Next: , Previous: , Up: Modules   [Contents][Index]

3.7 umbra/sdf

Dependency

noise (module)

Parent

umbra (system)

Location

sdf/

Components

Previous: , Up: Modules   [Contents][Index]

3.8 umbra/sprite

Dependency

sdf (module)

Parent

umbra (system)

Location

sprite/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 umbra.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/umbra-20190307-git/umbra.asd

Systems

umbra (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 umbra/common/package.lisp

Parent

common (module)

Location

common/package.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 umbra/common/common.lisp

Parent

common (module)

Location

common/common.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 umbra/common/swizzle.lisp

Parent

common (module)

Location

common/swizzle.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 umbra/common/vari.lisp

Parent

common (module)

Location

common/vari.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 umbra/common/math.lisp

Parent

common (module)

Location

common/math.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 umbra/common/structs.lisp

Parent

common (module)

Location

common/structs.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 umbra/color/package.lisp

Parent

color (module)

Location

color/package.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 umbra/color/grading.lisp

Parent

color (module)

Location

color/grading.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 umbra/color/space.lisp

Parent

color (module)

Location

color/space.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 umbra/graph/package.lisp

Parent

graph (module)

Location

graph/package.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.12 umbra/graph/graph.lisp

Parent

graph (module)

Location

graph/graph.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.13 umbra/shaping/package.lisp

Parent

shaping (module)

Location

shaping/package.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.14 umbra/shaping/iq.lisp

Parent

shaping (module)

Location

shaping/iq.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.15 umbra/shaping/levin.lisp

Parent

shaping (module)

Location

shaping/levin.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.16 umbra/shaping/misc.lisp

Parent

shaping (module)

Location

shaping/misc.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.17 umbra/shaping/penner.lisp

Parent

shaping (module)

Location

shaping/penner.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.18 umbra/hashing/package.lisp

Parent

hashing (module)

Location

hashing/package.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.19 umbra/hashing/bbs.lisp

Parent

hashing (module)

Location

hashing/bbs.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.20 umbra/hashing/fast32.lisp

Parent

hashing (module)

Location

hashing/fast32.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.21 umbra/hashing/fast32-2.lisp

Parent

hashing (module)

Location

hashing/fast32-2.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.22 umbra/hashing/sgpp.lisp

Parent

hashing (module)

Location

hashing/sgpp.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.23 umbra/noise/package.lisp

Parent

noise (module)

Location

noise/package.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.24 umbra/noise/cellular.lisp

Parent

noise (module)

Location

noise/cellular.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.25 umbra/noise/hermite.lisp

Parent

noise (module)

Location

noise/hermite.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.26 umbra/noise/misc.lisp

Parent

noise (module)

Location

noise/misc.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.27 umbra/noise/perlin.lisp

Parent

noise (module)

Location

noise/perlin.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.28 umbra/noise/polkadot.lisp

Parent

noise (module)

Location

noise/polkadot.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.29 umbra/noise/simplex.lisp

Parent

noise (module)

Location

noise/simplex.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.30 umbra/noise/value.lisp

Parent

noise (module)

Location

noise/value.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.31 umbra/sdf/package.lisp

Parent

sdf (module)

Location

sdf/package.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.32 umbra/sdf/2d.lisp

Parent

sdf (module)

Location

sdf/2d.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.33 umbra/sprite/package.lisp

Parent

sprite (module)

Location

sprite/package.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.34 umbra/sprite/sprite.lisp

Parent

sprite (module)

Location

sprite/sprite.lisp


Previous: , Up: Lisp files   [Contents][Index]

4.1.35 umbra/sprite/tile-map.lisp

Parent

sprite (module)

Location

sprite/tile-map.lisp


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M   U  
Index Entry  Section

F
File, Lisp, umbra.asd: The umbra<dot>asd file
File, Lisp, umbra/color/grading.lisp: The umbra/color/grading<dot>lisp file
File, Lisp, umbra/color/package.lisp: The umbra/color/package<dot>lisp file
File, Lisp, umbra/color/space.lisp: The umbra/color/space<dot>lisp file
File, Lisp, umbra/common/common.lisp: The umbra/common/common<dot>lisp file
File, Lisp, umbra/common/math.lisp: The umbra/common/math<dot>lisp file
File, Lisp, umbra/common/package.lisp: The umbra/common/package<dot>lisp file
File, Lisp, umbra/common/structs.lisp: The umbra/common/structs<dot>lisp file
File, Lisp, umbra/common/swizzle.lisp: The umbra/common/swizzle<dot>lisp file
File, Lisp, umbra/common/vari.lisp: The umbra/common/vari<dot>lisp file
File, Lisp, umbra/graph/graph.lisp: The umbra/graph/graph<dot>lisp file
File, Lisp, umbra/graph/package.lisp: The umbra/graph/package<dot>lisp file
File, Lisp, umbra/hashing/bbs.lisp: The umbra/hashing/bbs<dot>lisp file
File, Lisp, umbra/hashing/fast32-2.lisp: The umbra/hashing/fast32-2<dot>lisp file
File, Lisp, umbra/hashing/fast32.lisp: The umbra/hashing/fast32<dot>lisp file
File, Lisp, umbra/hashing/package.lisp: The umbra/hashing/package<dot>lisp file
File, Lisp, umbra/hashing/sgpp.lisp: The umbra/hashing/sgpp<dot>lisp file
File, Lisp, umbra/noise/cellular.lisp: The umbra/noise/cellular<dot>lisp file
File, Lisp, umbra/noise/hermite.lisp: The umbra/noise/hermite<dot>lisp file
File, Lisp, umbra/noise/misc.lisp: The umbra/noise/misc<dot>lisp file
File, Lisp, umbra/noise/package.lisp: The umbra/noise/package<dot>lisp file
File, Lisp, umbra/noise/perlin.lisp: The umbra/noise/perlin<dot>lisp file
File, Lisp, umbra/noise/polkadot.lisp: The umbra/noise/polkadot<dot>lisp file
File, Lisp, umbra/noise/simplex.lisp: The umbra/noise/simplex<dot>lisp file
File, Lisp, umbra/noise/value.lisp: The umbra/noise/value<dot>lisp file
File, Lisp, umbra/sdf/2d.lisp: The umbra/sdf/2d<dot>lisp file
File, Lisp, umbra/sdf/package.lisp: The umbra/sdf/package<dot>lisp file
File, Lisp, umbra/shaping/iq.lisp: The umbra/shaping/iq<dot>lisp file
File, Lisp, umbra/shaping/levin.lisp: The umbra/shaping/levin<dot>lisp file
File, Lisp, umbra/shaping/misc.lisp: The umbra/shaping/misc<dot>lisp file
File, Lisp, umbra/shaping/package.lisp: The umbra/shaping/package<dot>lisp file
File, Lisp, umbra/shaping/penner.lisp: The umbra/shaping/penner<dot>lisp file
File, Lisp, umbra/sprite/package.lisp: The umbra/sprite/package<dot>lisp file
File, Lisp, umbra/sprite/sprite.lisp: The umbra/sprite/sprite<dot>lisp file
File, Lisp, umbra/sprite/tile-map.lisp: The umbra/sprite/tile-map<dot>lisp file

L
Lisp File, umbra.asd: The umbra<dot>asd file
Lisp File, umbra/color/grading.lisp: The umbra/color/grading<dot>lisp file
Lisp File, umbra/color/package.lisp: The umbra/color/package<dot>lisp file
Lisp File, umbra/color/space.lisp: The umbra/color/space<dot>lisp file
Lisp File, umbra/common/common.lisp: The umbra/common/common<dot>lisp file
Lisp File, umbra/common/math.lisp: The umbra/common/math<dot>lisp file
Lisp File, umbra/common/package.lisp: The umbra/common/package<dot>lisp file
Lisp File, umbra/common/structs.lisp: The umbra/common/structs<dot>lisp file
Lisp File, umbra/common/swizzle.lisp: The umbra/common/swizzle<dot>lisp file
Lisp File, umbra/common/vari.lisp: The umbra/common/vari<dot>lisp file
Lisp File, umbra/graph/graph.lisp: The umbra/graph/graph<dot>lisp file
Lisp File, umbra/graph/package.lisp: The umbra/graph/package<dot>lisp file
Lisp File, umbra/hashing/bbs.lisp: The umbra/hashing/bbs<dot>lisp file
Lisp File, umbra/hashing/fast32-2.lisp: The umbra/hashing/fast32-2<dot>lisp file
Lisp File, umbra/hashing/fast32.lisp: The umbra/hashing/fast32<dot>lisp file
Lisp File, umbra/hashing/package.lisp: The umbra/hashing/package<dot>lisp file
Lisp File, umbra/hashing/sgpp.lisp: The umbra/hashing/sgpp<dot>lisp file
Lisp File, umbra/noise/cellular.lisp: The umbra/noise/cellular<dot>lisp file
Lisp File, umbra/noise/hermite.lisp: The umbra/noise/hermite<dot>lisp file
Lisp File, umbra/noise/misc.lisp: The umbra/noise/misc<dot>lisp file
Lisp File, umbra/noise/package.lisp: The umbra/noise/package<dot>lisp file
Lisp File, umbra/noise/perlin.lisp: The umbra/noise/perlin<dot>lisp file
Lisp File, umbra/noise/polkadot.lisp: The umbra/noise/polkadot<dot>lisp file
Lisp File, umbra/noise/simplex.lisp: The umbra/noise/simplex<dot>lisp file
Lisp File, umbra/noise/value.lisp: The umbra/noise/value<dot>lisp file
Lisp File, umbra/sdf/2d.lisp: The umbra/sdf/2d<dot>lisp file
Lisp File, umbra/sdf/package.lisp: The umbra/sdf/package<dot>lisp file
Lisp File, umbra/shaping/iq.lisp: The umbra/shaping/iq<dot>lisp file
Lisp File, umbra/shaping/levin.lisp: The umbra/shaping/levin<dot>lisp file
Lisp File, umbra/shaping/misc.lisp: The umbra/shaping/misc<dot>lisp file
Lisp File, umbra/shaping/package.lisp: The umbra/shaping/package<dot>lisp file
Lisp File, umbra/shaping/penner.lisp: The umbra/shaping/penner<dot>lisp file
Lisp File, umbra/sprite/package.lisp: The umbra/sprite/package<dot>lisp file
Lisp File, umbra/sprite/sprite.lisp: The umbra/sprite/sprite<dot>lisp file
Lisp File, umbra/sprite/tile-map.lisp: The umbra/sprite/tile-map<dot>lisp file

M
Module, umbra/color: The umbra/color module
Module, umbra/common: The umbra/common module
Module, umbra/graph: The umbra/graph module
Module, umbra/hashing: The umbra/hashing module
Module, umbra/noise: The umbra/noise module
Module, umbra/sdf: The umbra/sdf module
Module, umbra/shaping: The umbra/shaping module
Module, umbra/sprite: The umbra/sprite module

U
umbra.asd: The umbra<dot>asd file
umbra/color: The umbra/color module
umbra/color/grading.lisp: The umbra/color/grading<dot>lisp file
umbra/color/package.lisp: The umbra/color/package<dot>lisp file
umbra/color/space.lisp: The umbra/color/space<dot>lisp file
umbra/common: The umbra/common module
umbra/common/common.lisp: The umbra/common/common<dot>lisp file
umbra/common/math.lisp: The umbra/common/math<dot>lisp file
umbra/common/package.lisp: The umbra/common/package<dot>lisp file
umbra/common/structs.lisp: The umbra/common/structs<dot>lisp file
umbra/common/swizzle.lisp: The umbra/common/swizzle<dot>lisp file
umbra/common/vari.lisp: The umbra/common/vari<dot>lisp file
umbra/graph: The umbra/graph module
umbra/graph/graph.lisp: The umbra/graph/graph<dot>lisp file
umbra/graph/package.lisp: The umbra/graph/package<dot>lisp file
umbra/hashing: The umbra/hashing module
umbra/hashing/bbs.lisp: The umbra/hashing/bbs<dot>lisp file
umbra/hashing/fast32-2.lisp: The umbra/hashing/fast32-2<dot>lisp file
umbra/hashing/fast32.lisp: The umbra/hashing/fast32<dot>lisp file
umbra/hashing/package.lisp: The umbra/hashing/package<dot>lisp file
umbra/hashing/sgpp.lisp: The umbra/hashing/sgpp<dot>lisp file
umbra/noise: The umbra/noise module
umbra/noise/cellular.lisp: The umbra/noise/cellular<dot>lisp file
umbra/noise/hermite.lisp: The umbra/noise/hermite<dot>lisp file
umbra/noise/misc.lisp: The umbra/noise/misc<dot>lisp file
umbra/noise/package.lisp: The umbra/noise/package<dot>lisp file
umbra/noise/perlin.lisp: The umbra/noise/perlin<dot>lisp file
umbra/noise/polkadot.lisp: The umbra/noise/polkadot<dot>lisp file
umbra/noise/simplex.lisp: The umbra/noise/simplex<dot>lisp file
umbra/noise/value.lisp: The umbra/noise/value<dot>lisp file
umbra/sdf: The umbra/sdf module
umbra/sdf/2d.lisp: The umbra/sdf/2d<dot>lisp file
umbra/sdf/package.lisp: The umbra/sdf/package<dot>lisp file
umbra/shaping: The umbra/shaping module
umbra/shaping/iq.lisp: The umbra/shaping/iq<dot>lisp file
umbra/shaping/levin.lisp: The umbra/shaping/levin<dot>lisp file
umbra/shaping/misc.lisp: The umbra/shaping/misc<dot>lisp file
umbra/shaping/package.lisp: The umbra/shaping/package<dot>lisp file
umbra/shaping/penner.lisp: The umbra/shaping/penner<dot>lisp file
umbra/sprite: The umbra/sprite module
umbra/sprite/package.lisp: The umbra/sprite/package<dot>lisp file
umbra/sprite/sprite.lisp: The umbra/sprite/sprite<dot>lisp file
umbra/sprite/tile-map.lisp: The umbra/sprite/tile-map<dot>lisp file

Jump to:   F   L   M   U  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions


Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   S   U  
Index Entry  Section

S
System, umbra: The umbra system

U
umbra: The umbra system

Jump to:   S   U