The noisy Reference Manual

This is the noisy Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:09:56 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 noisy

Perlin noise for arbitrary numbers of dimensions.

Author

Kevin Galligan

License

MIT

Version

1.0.0

Dependency

random-state (system).

Source

noisy.asd.

Child Component

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

Source

noisy.asd.

Parent Component

noisy (system).

ASDF Systems

noisy.

Packages

noisy-asd.


3.1.2 noisy/noisy.lisp

Source

noisy.asd.

Parent Component

noisy (system).

Packages

noisy.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 noisy

Source

noisy.lisp.

Use List

common-lisp.

Public Interface
Internals

4.2 noisy-asd

Source

noisy.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: make-noise (dimensions &key seed lod falloff)
Package

noisy.

Source

noisy.lisp.

Function: noise (&rest coords)

Generates correlated noise for coordinates COORDS.
Use the stateful MAKE-NOISE and NOISE-GEN interface if multiple threads will be used.

Package

noisy.

Source

noisy.lisp.

Function: noise-detail (&key lod falloff)

Configure the ’character’ of the noise.
LOD stands for level of detail. It should be an integer value, determining how many noise values are generated and summed together. Low values -> smoother and more efficient, high values -> greater
level of detail.
The noise values are weighted by the order they are generated, so the first ones have more weight. FALLOFF should have a value between 0 and 1, it determines the weights. The i-th noise value will have a
weight of FALLOFF^i. A falloff of greater than 0.5 will possibly result in noise outputs of greater than 1. Based on: https://p5js.org/reference/#/p5/noiseDetail

Package

noisy.

Source

noisy.lisp.

Function: noise-gen (n &rest coords)
Package

noisy.

Source

noisy.lisp.

Function: noise-seed (seed)

Sets the seed for noise generation.

Package

noisy.

Source

noisy.lisp.

Function: set-noise-detail (n &key lod falloff)
Package

noisy.

Source

noisy.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *falloff*
Package

noisy.

Source

noisy.lisp.

Special Variable: *lod*
Package

noisy.

Source

noisy.lisp.

Special Variable: *noise-cache*
Package

noisy.

Source

noisy.lisp.

Special Variable: *noise-size*
Package

noisy.

Source

noisy.lisp.

Special Variable: *permutation-table*
Package

noisy.

Source

noisy.lisp.

Special Variable: *seed*
Package

noisy.

Source

noisy.lisp.


5.2.2 Ordinary functions

Function: combine-pairs! (binary-function list)
Package

noisy.

Source

noisy.lisp.

Function: dot-gradient-with-direction (gradient base-corner offset point)
Package

noisy.

Source

noisy.lisp.

Function: fetch-gradient (r base-corner offset)
Package

noisy.

Source

noisy.lisp.

Function: generate-corner-offsets (n)
Package

noisy.

Source

noisy.lisp.

Function: generate-point-on-unit-sphere (dimensions rng)
Package

noisy.

Source

noisy.lisp.

Function: get-gradient-index (base-corner offset)
Package

noisy.

Source

noisy.lisp.

Function: lerp (x1 x2 t0)

Linear interpolation between x1 and x2 given weight t0, 0<=t0<=1.

Package

noisy.

Source

noisy.lisp.

Function: list-euclidean-length (list)
Package

noisy.

Source

noisy.lisp.

Function: list-normalise! (list length)
Package

noisy.

Source

noisy.lisp.

Function: make-noise-function (dimensions seed)
Package

noisy.

Source

noisy.lisp.

Function: overwrite-list! (xs ys f)

Takes 2 lists XS and YS, of the same length. Overwrites the values of XS by calling the function F on each of the values of YS.

Package

noisy.

Source

noisy.lisp.

Function: permute (i)
Package

noisy.

Source

noisy.lisp.

Function: remap (x la ha lb hb)

Takes x from the interval [la, ha] and remaps it to the interval [lb, hb]. If x is outside the expected interval, then it gets clamped.

Package

noisy.

Source

noisy.lisp.

Function: smoothstep (t0)
Package

noisy.

Source

noisy.lisp.


5.2.3 Classes

Class: noise-state
Package

noisy.

Source

noisy.lisp.

Direct slots
Slot: noisefun
Initargs

:noisefun

Slot: lod
Initargs

:lod

Slot: falloff
Initargs

:falloff

Slot: input
Initargs

:input


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   D   F   G   L   M   N   O   P   R   S  
Index Entry  Section

C
combine-pairs!: Private ordinary functions

D
dot-gradient-with-direction: Private ordinary functions

F
fetch-gradient: Private ordinary functions
Function, combine-pairs!: Private ordinary functions
Function, dot-gradient-with-direction: Private ordinary functions
Function, fetch-gradient: Private ordinary functions
Function, generate-corner-offsets: Private ordinary functions
Function, generate-point-on-unit-sphere: Private ordinary functions
Function, get-gradient-index: Private ordinary functions
Function, lerp: Private ordinary functions
Function, list-euclidean-length: Private ordinary functions
Function, list-normalise!: Private ordinary functions
Function, make-noise: Public ordinary functions
Function, make-noise-function: Private ordinary functions
Function, noise: Public ordinary functions
Function, noise-detail: Public ordinary functions
Function, noise-gen: Public ordinary functions
Function, noise-seed: Public ordinary functions
Function, overwrite-list!: Private ordinary functions
Function, permute: Private ordinary functions
Function, remap: Private ordinary functions
Function, set-noise-detail: Public ordinary functions
Function, smoothstep: Private ordinary functions

G
generate-corner-offsets: Private ordinary functions
generate-point-on-unit-sphere: Private ordinary functions
get-gradient-index: Private ordinary functions

L
lerp: Private ordinary functions
list-euclidean-length: Private ordinary functions
list-normalise!: Private ordinary functions

M
make-noise: Public ordinary functions
make-noise-function: Private ordinary functions

N
noise: Public ordinary functions
noise-detail: Public ordinary functions
noise-gen: Public ordinary functions
noise-seed: Public ordinary functions

O
overwrite-list!: Private ordinary functions

P
permute: Private ordinary functions

R
remap: Private ordinary functions

S
set-noise-detail: Public ordinary functions
smoothstep: Private ordinary functions