The black-tie Reference Manual

This is the black-tie Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:44:11 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 black-tie

Noise library for Common Lisp.

Author

Erik Winkels <>

License

BSD

Version

0.2

Source

black-tie.asd.

Child Component

src (module).


3 Modules

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


3.1 black-tie/src

Source

black-tie.asd.

Parent Component

black-tie (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 black-tie/black-tie.asd

Source

black-tie.asd.

Parent Component

black-tie (system).

ASDF Systems

black-tie.


4.1.2 black-tie/src/package.lisp

Source

black-tie.asd.

Parent Component

src (module).

Packages

black-tie.


4.1.3 black-tie/src/config.lisp

Dependency

package.lisp (file).

Source

black-tie.asd.

Parent Component

src (module).

Internals
  • +f2+ (special variable).
  • +f3+ (special variable).
  • +g2*2+ (special variable).
  • +g2+ (special variable).
  • +g3*2+ (special variable).
  • +g3*3+ (special variable).
  • +g3+ (special variable).
  • +pnp+ (special variable).

4.1.4 black-tie/src/macros.lisp

Dependency

config.lisp (file).

Source

black-tie.asd.

Parent Component

src (module).

Internals

4.1.5 black-tie/src/common.lisp

Dependency

macros.lisp (file).

Source

black-tie.asd.

Parent Component

src (module).

Internals

4.1.6 black-tie/src/perlin-noise.lisp

Dependency

common.lisp (file).

Source

black-tie.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.7 black-tie/src/simplex-noise.lisp

Dependency

perlin-noise.lisp (file).

Source

black-tie.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.8 black-tie/src/voronoi.lisp

Dependency

simplex-noise.lisp (file).

Source

black-tie.asd.

Parent Component

src (module).

Public Interface

initialize-instance (method).

Internals

4.1.9 black-tie/src/noise-functions.lisp

Dependency

voronoi.lisp (file).

Source

black-tie.asd.

Parent Component

src (module).

Public Interface

5 Packages

Packages are listed by definition order.


5.1 black-tie

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: bands3d (x y z &key fn octaves multiplier)
Package

black-tie.

Source

noise-functions.lisp.

Function: fbm2d (x y &key fn octaves multiplier)
Package

black-tie.

Source

noise-functions.lisp.

Function: fbm3d (x y z &key fn octaves multiplier)
Package

black-tie.

Source

noise-functions.lisp.

Function: perlin-noise (x y z)
Package

black-tie.

Source

perlin-noise.lisp.

Function: perlin-noise-ref (x y z)

X, Y and Z should be floats for the best results.

Package

black-tie.

Alias for

perlin-noise-reference.

Function: perlin-noise-reference (x y z)

X, Y and Z should be floats for the best results.

Package

black-tie.

Source

perlin-noise.lisp.

Function: perlin-noise-sf (x y z)

X, Y and Z need to be SINGLE-FLOATS.

Package

black-tie.

Alias for

perlin-noise-single-float.

Function: perlin-noise-single-float (x y z)

X, Y and Z need to be SINGLE-FLOATS.

Package

black-tie.

Source

perlin-noise.lisp.

Function: ridge3d (x y z &key fn octaves multiplier ridge)
Package

black-tie.

Source

noise-functions.lisp.

Function: simplex-noise-1d (x)
Package

black-tie.

Source

simplex-noise.lisp.

Function: simplex-noise-1d-ref (x)
Package

black-tie.

Alias for

simplex-noise-1d-reference.

Function: simplex-noise-1d-reference (x)
Package

black-tie.

Source

simplex-noise.lisp.

Function: simplex-noise-1d-sf (x)

SINGLE-FLOAT version of SIMPLEX-NOISE-1D which has less accuracy but is a lot faster and generally good enough unless you need the precision.

Package

black-tie.

Alias for

simplex-noise-1d-single-float.

Function: simplex-noise-1d-single-float (x)

SINGLE-FLOAT version of SIMPLEX-NOISE-1D which has less accuracy but is a lot faster and generally good enough unless you need the precision.

Package

black-tie.

Source

simplex-noise.lisp.

Function: simplex-noise-2d (x y)
Package

black-tie.

Source

simplex-noise.lisp.

Function: simplex-noise-2d-ref (x y)
Package

black-tie.

Alias for

simplex-noise-2d-reference.

Function: simplex-noise-2d-reference (x y)
Package

black-tie.

Source

simplex-noise.lisp.

Function: simplex-noise-2d-sf (x y)

SINGLE-FLOAT version of SIMPLEX-NOISE-2D which has less accuracy but is a lot faster and generally good enough unless you need the precision.

Package

black-tie.

Alias for

simplex-noise-2d-single-float.

Function: simplex-noise-2d-single-float (x y)

SINGLE-FLOAT version of SIMPLEX-NOISE-2D which has less accuracy but is a lot faster and generally good enough unless you need the precision.

Package

black-tie.

Source

simplex-noise.lisp.

Function: simplex-noise-3d (x y z)
Package

black-tie.

Source

simplex-noise.lisp.

Function: simplex-noise-3d-ref (x y z)
Package

black-tie.

Alias for

simplex-noise-3d-reference.

Function: simplex-noise-3d-reference (x y z)
Package

black-tie.

Source

simplex-noise.lisp.

Function: simplex-noise-3d-sf (x y z)

SINGLE-FLOAT version of SIMPLEX-NOISE-3D which has less accuracy but is a lot faster and generally good enough unless you need the precision.

Package

black-tie.

Alias for

simplex-noise-3d-single-float.

Function: simplex-noise-3d-single-float (x y z)

SINGLE-FLOAT version of SIMPLEX-NOISE-3D which has less accuracy but is a lot faster and generally good enough unless you need the precision.

Package

black-tie.

Source

simplex-noise.lisp.

Function: turbulence3d (x y z &key fn octaves multiplier)
Package

black-tie.

Source

noise-functions.lisp.


6.1.2 Standalone methods

Method: initialize-instance :after ((v2d voronoi-2d) &key)
Source

voronoi.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: +f2+
Package

black-tie.

Source

config.lisp.

Special Variable: +f3+
Package

black-tie.

Source

config.lisp.

Special Variable: +g2*2+
Package

black-tie.

Source

config.lisp.

Special Variable: +g2+
Package

black-tie.

Source

config.lisp.

Special Variable: +g3*2+
Package

black-tie.

Source

config.lisp.

Special Variable: +g3*3+
Package

black-tie.

Source

config.lisp.

Special Variable: +g3+
Package

black-tie.

Source

config.lisp.

Special Variable: +pnp+
Package

black-tie.

Source

config.lisp.


6.2.2 Macros

Macro: with-2d ((x-var x-max y-var y-max &key x-min y-min step) &body body)
Package

black-tie.

Source

macros.lisp.

Macro: with-3d ((x-var x-max y-var y-max z-var z-max &key x-min y-min z-min step) &body body)
Package

black-tie.

Source

macros.lisp.


6.2.3 Ordinary functions

Function: append1 (lst obj)
Package

black-tie.

Source

common.lisp.

Function: asdf (system)
Package

black-tie.

Source

common.lisp.

Function: current-date-time-string ()
Package

black-tie.

Source

common.lisp.

Function: defalias (function alias)

Defines an alias for FUNCTION, meaning it can be called with ALIAS as well.

Package

black-tie.

Source

common.lisp.

Function: error-message (msg)
Package

black-tie.

Source

common.lisp.

Function: fade (v)
Package

black-tie.

Source

perlin-noise.lisp.

Function: fade-ref (v)
Package

black-tie.

Source

perlin-noise.lisp.

Function: fade-sf (v)
Package

black-tie.

Source

perlin-noise.lisp.

Function: grad (hash x y z)
Package

black-tie.

Source

perlin-noise.lisp.

Function: grad-ref (hash x y z)
Package

black-tie.

Source

perlin-noise.lisp.

Function: grad-sf (hash x y z)
Package

black-tie.

Source

perlin-noise.lisp.

Function: last1 (lst)
Package

black-tie.

Source

common.lisp.

Function: lerp (v a b)
Package

black-tie.

Source

perlin-noise.lisp.

Function: lerp-ref (v a b)
Package

black-tie.

Source

perlin-noise.lisp.

Function: lerp-sf (v a b)
Package

black-tie.

Source

perlin-noise.lisp.

Function: mkfstr (&rest args)
Package

black-tie.

Source

common.lisp.

Function: mkstr (&rest args)
Package

black-tie.

Source

common.lisp.

Function: perlin-noise-benchmark (&key fn iterations)
Package

black-tie.

Source

perlin-noise.lisp.

Function: perlin-noise-closure (&optional precision)

Returns a closure which can be called just like PERLIN-NOISE-SINGLE-FLOAT. PRECISION will be used to determine the size of the precalculated perlin cube. The higher the precision to more elements will be in the cube and the more precise it will be (and the more memory it will consume). The number of elements in the cube is determined as PRECISION^3. NOTE: This does not give the same results for the same inputs as PERLIN-NOISE!

Package

black-tie.

Source

perlin-noise.lisp.

Function: perlin-noise-compare (fn1 &key fn2 lines sleep-time)

Compares the output of FN1 to the output of FN2.

Package

black-tie.

Source

perlin-noise.lisp.

Function: print-hash (hash)
Package

black-tie.

Source

common.lisp.

Function: quit ()
Package

black-tie.

Source

common.lisp.

Function: simplex-noise-compare (fn1 fn2 &key lines sleep-time)
Package

black-tie.

Source

simplex-noise.lisp.

Function: sngrad1d (hash x)
Package

black-tie.

Source

simplex-noise.lisp.

Function: sngrad1d-ref (hash x)
Package

black-tie.

Source

simplex-noise.lisp.

Function: sngrad1d-sf (hash x)
Package

black-tie.

Source

simplex-noise.lisp.

Function: sngrad2d (hash x y)
Package

black-tie.

Source

simplex-noise.lisp.

Function: sngrad2d-ref (hash x y)
Package

black-tie.

Source

simplex-noise.lisp.

Function: sngrad2d-sf (hash x y)
Package

black-tie.

Source

simplex-noise.lisp.

Function: sngrad3d (hash x y z)
Package

black-tie.

Source

simplex-noise.lisp.

Function: sngrad3d-ref (hash x y z)
Package

black-tie.

Source

simplex-noise.lisp.

Function: sngrad3d-sf (hash x y z)
Package

black-tie.

Source

simplex-noise.lisp.

Function: sngrad4d (hash x y z tt)
Package

black-tie.

Source

simplex-noise.lisp.

Function: verbose (msg)
Package

black-tie.

Source

common.lisp.

Function: vlength (v)

Returns the length of vector V.

Package

black-tie.

Source

common.lisp.

Function: write-to-file (name object)
Package

black-tie.

Source

common.lisp.


6.2.4 Generic functions

Generic Reader: 1/p (object)
Package

black-tie.

Methods
Reader Method: 1/p ((voronoi-2d voronoi-2d))

automatically generated reader method

Source

voronoi.lisp.

Target Slot

1/p.

Generic Function: distances (v2d x y &key sorted)
Package

black-tie.

Methods
Method: distances ((v2d voronoi-2d) x y &key sorted)

X and Y need be a float between 0 and 1. This function will return a list of the distances to the nearest points for X and Y.

Source

voronoi.lisp.

Generic Reader: number-of-points (object)
Package

black-tie.

Methods
Reader Method: number-of-points ((voronoi-2d voronoi-2d))

automatically generated reader method

Source

voronoi.lisp.

Target Slot

number-of-points.

Generic Reader: points (object)
Package

black-tie.

Methods
Reader Method: points ((voronoi-2d voronoi-2d))

automatically generated reader method

Source

voronoi.lisp.

Target Slot

points.

Generic Reader: psqrt (object)
Package

black-tie.

Methods
Reader Method: psqrt ((voronoi-2d voronoi-2d))

automatically generated reader method

Source

voronoi.lisp.

Target Slot

psqrt.


6.2.5 Classes

Class: voronoi-2d
Package

black-tie.

Source

voronoi.lisp.

Direct methods
Direct slots
Slot: 1/p
Readers

1/p.

Writers

This slot is read-only.

Slot: number-of-points
Initform

64

Initargs

:number-of-points

Readers

number-of-points.

Writers

This slot is read-only.

Slot: points
Readers

points.

Writers

This slot is read-only.

Slot: psqrt
Readers

psqrt.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   1  
A   B   C   D   E   F   G   I   L   M   N   P   Q   R   S   T   V   W  
Index Entry  Section

1
1/p: Private generic functions
1/p: Private generic functions

A
append1: Private ordinary functions
asdf: Private ordinary functions

B
bands3d: Public ordinary functions

C
current-date-time-string: Private ordinary functions

D
defalias: Private ordinary functions
distances: Private generic functions
distances: Private generic functions

E
error-message: Private ordinary functions

F
fade: Private ordinary functions
fade-ref: Private ordinary functions
fade-sf: Private ordinary functions
fbm2d: Public ordinary functions
fbm3d: Public ordinary functions
Function, append1: Private ordinary functions
Function, asdf: Private ordinary functions
Function, bands3d: Public ordinary functions
Function, current-date-time-string: Private ordinary functions
Function, defalias: Private ordinary functions
Function, error-message: Private ordinary functions
Function, fade: Private ordinary functions
Function, fade-ref: Private ordinary functions
Function, fade-sf: Private ordinary functions
Function, fbm2d: Public ordinary functions
Function, fbm3d: Public ordinary functions
Function, grad: Private ordinary functions
Function, grad-ref: Private ordinary functions
Function, grad-sf: Private ordinary functions
Function, last1: Private ordinary functions
Function, lerp: Private ordinary functions
Function, lerp-ref: Private ordinary functions
Function, lerp-sf: Private ordinary functions
Function, mkfstr: Private ordinary functions
Function, mkstr: Private ordinary functions
Function, perlin-noise: Public ordinary functions
Function, perlin-noise-benchmark: Private ordinary functions
Function, perlin-noise-closure: Private ordinary functions
Function, perlin-noise-compare: Private ordinary functions
Function, perlin-noise-ref: Public ordinary functions
Function, perlin-noise-reference: Public ordinary functions
Function, perlin-noise-sf: Public ordinary functions
Function, perlin-noise-single-float: Public ordinary functions
Function, print-hash: Private ordinary functions
Function, quit: Private ordinary functions
Function, ridge3d: Public ordinary functions
Function, simplex-noise-1d: Public ordinary functions
Function, simplex-noise-1d-ref: Public ordinary functions
Function, simplex-noise-1d-reference: Public ordinary functions
Function, simplex-noise-1d-sf: Public ordinary functions
Function, simplex-noise-1d-single-float: Public ordinary functions
Function, simplex-noise-2d: Public ordinary functions
Function, simplex-noise-2d-ref: Public ordinary functions
Function, simplex-noise-2d-reference: Public ordinary functions
Function, simplex-noise-2d-sf: Public ordinary functions
Function, simplex-noise-2d-single-float: Public ordinary functions
Function, simplex-noise-3d: Public ordinary functions
Function, simplex-noise-3d-ref: Public ordinary functions
Function, simplex-noise-3d-reference: Public ordinary functions
Function, simplex-noise-3d-sf: Public ordinary functions
Function, simplex-noise-3d-single-float: Public ordinary functions
Function, simplex-noise-compare: Private ordinary functions
Function, sngrad1d: Private ordinary functions
Function, sngrad1d-ref: Private ordinary functions
Function, sngrad1d-sf: Private ordinary functions
Function, sngrad2d: Private ordinary functions
Function, sngrad2d-ref: Private ordinary functions
Function, sngrad2d-sf: Private ordinary functions
Function, sngrad3d: Private ordinary functions
Function, sngrad3d-ref: Private ordinary functions
Function, sngrad3d-sf: Private ordinary functions
Function, sngrad4d: Private ordinary functions
Function, turbulence3d: Public ordinary functions
Function, verbose: Private ordinary functions
Function, vlength: Private ordinary functions
Function, write-to-file: Private ordinary functions

G
Generic Function, 1/p: Private generic functions
Generic Function, distances: Private generic functions
Generic Function, number-of-points: Private generic functions
Generic Function, points: Private generic functions
Generic Function, psqrt: Private generic functions
grad: Private ordinary functions
grad-ref: Private ordinary functions
grad-sf: Private ordinary functions

I
initialize-instance: Public standalone methods

L
last1: Private ordinary functions
lerp: Private ordinary functions
lerp-ref: Private ordinary functions
lerp-sf: Private ordinary functions

M
Macro, with-2d: Private macros
Macro, with-3d: Private macros
Method, 1/p: Private generic functions
Method, distances: Private generic functions
Method, initialize-instance: Public standalone methods
Method, number-of-points: Private generic functions
Method, points: Private generic functions
Method, psqrt: Private generic functions
mkfstr: Private ordinary functions
mkstr: Private ordinary functions

N
number-of-points: Private generic functions
number-of-points: Private generic functions

P
perlin-noise: Public ordinary functions
perlin-noise-benchmark: Private ordinary functions
perlin-noise-closure: Private ordinary functions
perlin-noise-compare: Private ordinary functions
perlin-noise-ref: Public ordinary functions
perlin-noise-reference: Public ordinary functions
perlin-noise-sf: Public ordinary functions
perlin-noise-single-float: Public ordinary functions
points: Private generic functions
points: Private generic functions
print-hash: Private ordinary functions
psqrt: Private generic functions
psqrt: Private generic functions

Q
quit: Private ordinary functions

R
ridge3d: Public ordinary functions

S
simplex-noise-1d: Public ordinary functions
simplex-noise-1d-ref: Public ordinary functions
simplex-noise-1d-reference: Public ordinary functions
simplex-noise-1d-sf: Public ordinary functions
simplex-noise-1d-single-float: Public ordinary functions
simplex-noise-2d: Public ordinary functions
simplex-noise-2d-ref: Public ordinary functions
simplex-noise-2d-reference: Public ordinary functions
simplex-noise-2d-sf: Public ordinary functions
simplex-noise-2d-single-float: Public ordinary functions
simplex-noise-3d: Public ordinary functions
simplex-noise-3d-ref: Public ordinary functions
simplex-noise-3d-reference: Public ordinary functions
simplex-noise-3d-sf: Public ordinary functions
simplex-noise-3d-single-float: Public ordinary functions
simplex-noise-compare: Private ordinary functions
sngrad1d: Private ordinary functions
sngrad1d-ref: Private ordinary functions
sngrad1d-sf: Private ordinary functions
sngrad2d: Private ordinary functions
sngrad2d-ref: Private ordinary functions
sngrad2d-sf: Private ordinary functions
sngrad3d: Private ordinary functions
sngrad3d-ref: Private ordinary functions
sngrad3d-sf: Private ordinary functions
sngrad4d: Private ordinary functions

T
turbulence3d: Public ordinary functions

V
verbose: Private ordinary functions
vlength: Private ordinary functions

W
with-2d: Private macros
with-3d: Private macros
write-to-file: Private ordinary functions


A.4 Data types