The black-tie Reference Manual

Table of Contents

The black-tie Reference Manual

This is the black-tie Reference Manual, version 0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 14:12:50 2021 GMT+0.

1 Introduction

Black Tie

status: active

The canonical home page for this project is: https://git.sr.ht/~aerique/black-tie

(The library is also pushed to GitLab and GitHub but those sites are not monitored for support.)

A noise library in Common Lisp

Introduction

This library is still in it's infancy and only supports very few types of noise yet.

It offers both heavily optimized (tested only on SBCL so far) and reference implementations if they are available.

To Do

From Matrix #lispgamedev:matrix.org:

If anything, just grep for safety 0 and remove that ASAP :)

Or at least do it in a (locally (declare ..)) sparingly like around array accesses where you are sure your indices are correct.

License

This project is released under the simplified BSD license.

Features

• Perlin noise
• Simplex noise
• Voronoi noise

Documentation

None. See the examples/textures.lisp.

2 Systems

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

2.1 black-tie

Author

Erik Winkels <aerique@xs4all.nl>

License

BSD

Description

Noise library for Common Lisp.

Version

0.2

Source

black-tie.asd (file)

Component

src (module)

3 Modules

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

3.1 black-tie/src

Parent

black-tie (system)

Location

src/

Components

• package.lisp (file)
• config.lisp (file)
• macros.lisp (file)
• common.lisp (file)
• perlin-noise.lisp (file)
• simplex-noise.lisp (file)
• voronoi.lisp (file)
• noise-functions.lisp (file)

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

Location

black-tie.asd

Systems

black-tie (system)

4.1.2 black-tie/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

black-tie

4.1.3 black-tie/src/config.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/config.lisp

Internal Definitions

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

Parent

src (module)

Location

src/macros.lisp

Internal Definitions

• with-2d (macro)
• with-3d (macro)

4.1.5 black-tie/src/common.lisp

Dependency

macros.lisp (file)

Parent

src (module)

Location

src/common.lisp

Internal Definitions

• append1 (function)
• asdf (function)
• current-date-time-string (function)
• defalias (function)
• error-message (function)
• last1 (function)
• mkfstr (function)
• mkstr (function)
• print-hash (function)
• quit (function)
• verbose (function)
• vlength (function)
• write-to-file (function)

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

Dependency

common.lisp (file)

Parent

src (module)

Location

src/perlin-noise.lisp

Exported Definitions

• perlin-noise (function)
• perlin-noise-ref (function)
• perlin-noise-reference (function)
• perlin-noise-sf (function)
• perlin-noise-single-float (function)

Internal Definitions

• fade (function)
• fade-ref (function)
• fade-sf (function)
• grad (function)
• grad-ref (function)
• grad-sf (function)
• lerp (function)
• lerp-ref (function)
• lerp-sf (function)
• perlin-noise-benchmark (function)
• perlin-noise-closure (function)
• perlin-noise-compare (function)

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

Dependency

perlin-noise.lisp (file)

Parent

src (module)

Location

src/simplex-noise.lisp

Exported Definitions

• simplex-noise-1d (function)
• simplex-noise-1d-ref (function)
• simplex-noise-1d-reference (function)
• simplex-noise-1d-sf (function)
• simplex-noise-1d-single-float (function)
• simplex-noise-2d (function)
• simplex-noise-2d-ref (function)
• simplex-noise-2d-reference (function)
• simplex-noise-2d-sf (function)
• simplex-noise-2d-single-float (function)
• simplex-noise-3d (function)
• simplex-noise-3d-ref (function)
• simplex-noise-3d-reference (function)
• simplex-noise-3d-sf (function)
• simplex-noise-3d-single-float (function)

Internal Definitions

• simplex-noise-compare (function)
• sngrad1d (function)
• sngrad1d-ref (function)
• sngrad1d-sf (function)
• sngrad2d (function)
• sngrad2d-ref (function)
• sngrad2d-sf (function)
• sngrad3d (function)
• sngrad3d-ref (function)
• sngrad3d-sf (function)
• sngrad4d (function)

4.1.8 black-tie/src/voronoi.lisp

Dependency

simplex-noise.lisp (file)

Parent

src (module)

Location

src/voronoi.lisp

Internal Definitions

• 1/p (method)
• distances (method)
• number-of-points (method)
• points (method)
• psqrt (method)
• voronoi-2d (class)

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

Dependency

voronoi.lisp (file)

Parent

src (module)

Location

src/noise-functions.lisp

Exported Definitions

• bands3d (function)
• fbm2d (function)
• fbm3d (function)
• ridge3d (function)
• turbulence3d (function)

5 Packages

Packages are listed by definition order.

5.1 black-tie

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• bands3d (function)
• fbm2d (function)
• fbm3d (function)
• perlin-noise (function)
• perlin-noise-ref (function)
• perlin-noise-reference (function)
• perlin-noise-sf (function)
• perlin-noise-single-float (function)
• ridge3d (function)
• simplex-noise-1d (function)
• simplex-noise-1d-ref (function)
• simplex-noise-1d-reference (function)
• simplex-noise-1d-sf (function)
• simplex-noise-1d-single-float (function)
• simplex-noise-2d (function)
• simplex-noise-2d-ref (function)
• simplex-noise-2d-reference (function)
• simplex-noise-2d-sf (function)
• simplex-noise-2d-single-float (function)
• simplex-noise-3d (function)
• simplex-noise-3d-ref (function)
• simplex-noise-3d-reference (function)
• simplex-noise-3d-sf (function)
• simplex-noise-3d-single-float (function)
• turbulence3d (function)

Internal Definitions

• +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)
• 1/p (generic function)
• 1/p (method)
• append1 (function)
• asdf (function)
• current-date-time-string (function)
• defalias (function)
• distances (generic function)
• distances (method)
• error-message (function)
• fade (function)
• fade-ref (function)
• fade-sf (function)
• grad (function)
• grad-ref (function)
• grad-sf (function)
• last1 (function)
• lerp (function)
• lerp-ref (function)
• lerp-sf (function)
• mkfstr (function)
• mkstr (function)
• number-of-points (generic function)
• number-of-points (method)
• perlin-noise-benchmark (function)
• perlin-noise-closure (function)
• perlin-noise-compare (function)
• points (generic function)
• points (method)
• print-hash (function)
• psqrt (generic function)
• psqrt (method)
• quit (function)
• simplex-noise-compare (function)
• sngrad1d (function)
• sngrad1d-ref (function)
• sngrad1d-sf (function)
• sngrad2d (function)
• sngrad2d-ref (function)
• sngrad2d-sf (function)
• sngrad3d (function)
• sngrad3d-ref (function)
• sngrad3d-sf (function)
• sngrad4d (function)
• verbose (function)
• vlength (function)
• voronoi-2d (class)
• with-2d (macro)
• with-3d (macro)
• write-to-file (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: bands3d X Y Z &key FN OCTAVES MULTIPLIER

Package

black-tie

Source

noise-functions.lisp (file)

Function: fbm2d X Y &key FN OCTAVES MULTIPLIER

Package

black-tie

Source

noise-functions.lisp (file)

Function: fbm3d X Y Z &key FN OCTAVES MULTIPLIER

Package

black-tie

Source

noise-functions.lisp (file)

Function: perlin-noise ()

Package

black-tie

Source

perlin-noise.lisp (file)

Function: perlin-noise-ref X Y Z

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

Package

black-tie

Source

perlin-noise.lisp (file)

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

Function: perlin-noise-sf ()

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

Package

black-tie

Source

perlin-noise.lisp (file)

Function: perlin-noise-single-float ()

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

Package

black-tie

Source

perlin-noise.lisp (file)

Function: ridge3d X Y Z &key FN OCTAVES MULTIPLIER RIDGE

Package

black-tie

Source

noise-functions.lisp (file)

Function: simplex-noise-1d ()

Package

black-tie

Source

simplex-noise.lisp (file)

Function: simplex-noise-1d-ref X

Package

black-tie

Source

simplex-noise.lisp (file)

Function: simplex-noise-1d-reference X

Package

black-tie

Source

simplex-noise.lisp (file)

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

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

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

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

Function: simplex-noise-2d ()

Package

black-tie

Source

simplex-noise.lisp (file)

Function: simplex-noise-2d-ref X Y

Package

black-tie

Source

simplex-noise.lisp (file)

Function: simplex-noise-2d-reference X Y

Package

black-tie

Source

simplex-noise.lisp (file)

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

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

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

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

Function: simplex-noise-3d ()

Package

black-tie

Source

simplex-noise.lisp (file)

Function: simplex-noise-3d-ref X Y Z

Package

black-tie

Source

simplex-noise.lisp (file)

Function: simplex-noise-3d-reference X Y Z

Package

black-tie

Source

simplex-noise.lisp (file)

Function: simplex-noise-3d-sf ()

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

Function: simplex-noise-3d-single-float ()

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

Function: turbulence3d X Y Z &key FN OCTAVES MULTIPLIER

Package

black-tie

Source

noise-functions.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: +f2+

Package

black-tie

Source

config.lisp (file)

Special Variable: +f3+

Package

black-tie

Source

config.lisp (file)

Special Variable: +g2*2+

Package

black-tie

Source

config.lisp (file)

Special Variable: +g2+

Package

black-tie

Source

config.lisp (file)

Special Variable: +g3*2+

Package

black-tie

Source

config.lisp (file)

Special Variable: +g3*3+

Package

black-tie

Source

config.lisp (file)

Special Variable: +g3+

Package

black-tie

Source

config.lisp (file)

Special Variable: +pnp+

Package

black-tie

Source

config.lisp (file)

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

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

6.2.3 Functions

Function: append1 LST OBJ

Package

black-tie

Source

common.lisp (file)

Function: asdf SYSTEM

Package

black-tie

Source

common.lisp (file)

Function: current-date-time-string ()

Package

black-tie

Source

common.lisp (file)

Function: defalias FUNCTION ALIAS

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

Package

black-tie

Source

common.lisp (file)

Function: error-message MSG

Package

black-tie

Source

common.lisp (file)

Function: fade ()

Package

black-tie

Source

perlin-noise.lisp (file)

Function: fade-ref V

Package

black-tie

Source

perlin-noise.lisp (file)

Function: fade-sf ()

Package

black-tie

Source

perlin-noise.lisp (file)

Function: grad ()

Package

black-tie

Source

perlin-noise.lisp (file)

Function: grad-ref HASH X Y Z

Package

black-tie

Source

perlin-noise.lisp (file)

Function: grad-sf ()

Package

black-tie

Source

perlin-noise.lisp (file)

Function: last1 LST

Package

black-tie

Source

common.lisp (file)

Function: lerp ()

Package

black-tie

Source

perlin-noise.lisp (file)

Function: lerp-ref V A B

Package

black-tie

Source

perlin-noise.lisp (file)

Function: lerp-sf ()

Package

black-tie

Source

perlin-noise.lisp (file)

Function: mkfstr &rest ARGS

Package

black-tie

Source

common.lisp (file)

Function: mkstr &rest ARGS

Package

black-tie

Source

common.lisp (file)

Function: perlin-noise-benchmark &key FN ITERATIONS

Package

black-tie

Source

perlin-noise.lisp (file)

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

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

Function: print-hash HASH

Package

black-tie

Source

common.lisp (file)

Function: quit ()

Package

black-tie

Source

common.lisp (file)

Function: simplex-noise-compare FN1 FN2 &key LINES SLEEP-TIME

Package

black-tie

Source

simplex-noise.lisp (file)

Function: sngrad1d ()

Package

black-tie

Source

simplex-noise.lisp (file)

Function: sngrad1d-ref HASH X

Package

black-tie

Source

simplex-noise.lisp (file)

Function: sngrad1d-sf ()

Package

black-tie

Source

simplex-noise.lisp (file)

Function: sngrad2d ()

Package

black-tie

Source

simplex-noise.lisp (file)

Function: sngrad2d-ref HASH X Y

Package

black-tie

Source

simplex-noise.lisp (file)

Function: sngrad2d-sf ()

Package

black-tie

Source

simplex-noise.lisp (file)

Function: sngrad3d ()

Package

black-tie

Source

simplex-noise.lisp (file)

Function: sngrad3d-ref HASH X Y Z

Package

black-tie

Source

simplex-noise.lisp (file)

Function: sngrad3d-sf ()

Package

black-tie

Source

simplex-noise.lisp (file)

Function: sngrad4d HASH X Y Z TT

Package

black-tie

Source

simplex-noise.lisp (file)

Function: verbose MSG

Package

black-tie

Source

common.lisp (file)

Function: vlength V

Returns the length of vector V.

Package

black-tie

Source

common.lisp (file)

Function: write-to-file NAME OBJECT

Package

black-tie

Source

common.lisp (file)

6.2.4 Generic functions

Generic Function: 1/p OBJECT

Package

black-tie

Methods

Method: 1/p (VORONOI-2D voronoi-2d)

automatically generated reader method

Source

voronoi.lisp (file)

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

Generic Function: number-of-points OBJECT

Package

black-tie

Methods

Method: number-of-points (VORONOI-2D voronoi-2d)

automatically generated reader method

Source

voronoi.lisp (file)

Generic Function: points OBJECT

Package

black-tie

Methods

Method: points (VORONOI-2D voronoi-2d)

automatically generated reader method

Source

voronoi.lisp (file)

Generic Function: psqrt OBJECT

Package

black-tie

Methods

Method: psqrt (VORONOI-2D voronoi-2d)

automatically generated reader method

Source

voronoi.lisp (file)

6.2.5 Classes

Class: voronoi-2d ()

Package

black-tie

Source

voronoi.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• distances (method)
• initialize-instance (method)
• psqrt (method)
• points (method)
• number-of-points (method)
• 1/p (method)

Direct slots

Slot: 1/p

Readers

1/p (generic function)

Slot: number-of-points

Initargs

:number-of-points

Initform

64

Readers

number-of-points (generic function)

Slot: points

Readers

points (generic function)

Slot: psqrt

Readers

psqrt (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types