The cricket Reference Manual

Table of Contents

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

The cricket Reference Manual

This is the cricket Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:46:45 2021 GMT+0.


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

1 Introduction

Cricket

Cricket is a comprehensive suite of coherent noise algorithms and composable tools for manipulating them to create interesting procedurally-generated imagery and other creative applications.

What is coherent noise?

Unlike its more random cousin, coherent noise has interesting properties that give it a smooth appearance. A coherent noise function is an N-arity function that emits a single scalar value as its output. All coherent noise functions exhibit the following properties:

  1. The same input parameters will always result in the same output.
  2. A small change in input will result in a small change in the output.
  3. A large change in input will result in a random output.

The dimensionality of a coherent noise function is determined by how many input parameters it accepts. Since inputs to a coherent noise function could be driven from any source of data, and output values are coherent in each of the function's supported dimensions, one could feed image coordinates into a 3-dimensional coherent noise function's first two parameters, and an incrementing time value as the third parameter, in order to smoothly animate an image effect such as clouds, fire, landscapes, or anything else creativity dreams up.

Coherent noise functions are especially ubiquitous in applications where memory is scarce, and in game development where one wants to generate 2-dimensional textures or 3-dimensional objects without storing any large chunks of image or geometry data on disk.

Overview

Cricket started out as a collection of noise algorithms for use in game development, but evolved over time into a more general form I thought could be useful to others outside of that domain. It borrows a lot of its ideas from C++'s libnoise, but adds numerous enhancements, corrections, and additional noise algorithms.

What's different from libnoise?

What's with the name Cricket?

Well, they are noisy!

How is it used?

In summary, you call a function depending on the coherent noise algorithm and dimensionality you want to generate to create a "generator". A generator can then be sampled from with a #'sample function, passing to it input coordinates for each of the generator's dimensional axes to sample by.

Also, there exist "modifiers", which, like generators, are created and sampled from in the same way. What makes modifiers special, is that they take samplers (generators or other modifiers) as inputs, allowing you to create complex pipelines that perform all sorts of processing of noise data.

Additionally, there are tools for conveniently working with entire regions of noise space in order to generate entire images effortlessly.

For usage instructions, see below.

What are the supported noise algorithms?

Currently, Cricket supports the following:

Install

(ql:quickload :cricket)

Running Unit Tests

To run the unit tests, first ensure you have prove installed:

(ql:quickload :prove)

Then run the tests:

(asdf:test-system :cricket)

Usage

The following usage instructions assumes you have added the "cricket" system to your list of dependencies, and is loaded and present in your Lisp image. It also assumes you are working in a package that has a package-local nickname mapping the cricket package to c in an effort to keep some of the example pipelines brief:

(defpackage #:my-package
  (:local-nicknames (#:c #:cricket))
  (:use #:cl))

(in-package #:my-package)

To get started, let's get a feel for how to create and sample from a generator for one of the supported noise algorithms. Perlin noise is a well-known algorithm so let's create a 2D Perlin generator and sample from it:

(let ((p2d (c:perlin-2d)))
  (c:sample p2d 0.1d0 42.5d0))

To create a generator we simply call a function, and we can sample from it using any double-precision floating point values as input coordinates, corresponding to the dimensionality of the noise generator - in this case, we are using a 2-dimensional noise algorithm, so we supplied 2 input coordinates.

There is one potential problem with the above code though: every time we run it it will produce a different output. Doesn't that conflict with the first property of coherent noise mentioned at the top of this document? No, it doesn't. By not supplying any arguments to #'perlin-2d, we are telling Cricket to randomly seed this generator's random number generator. All generators have a random number generator, and it is how we can retrieve different results with the same input. We can change this behavior by supplying our own seed value.

(let ((p2d (c:perlin-2d :seed "abc")))
  (c:sample p2d 0.1d0 42.5d0))

Now, when we run this multiple times, we will always get the same answer, and this is guaranteed to produce the same answer on different Lisp implementations or operating systems. Truly portable synthesized images is a nice feature to have!

In summary, one creates a generator with a function whose name consists of the algorithm name, followed by a hyphen, followed by the dimensionality. All generators take a :seed keyword argument, which is used to seed its own random number generator.

Of note is that all generators take a seed argument, even ones that don't make use of any random numbers in their implementation. This is needed for modifiers, which we'll use to build upon this example next.

There are about a couple dozen modifiers, all located in the src/modifiers directory with documentation strings to get a basic idea of how they operate. Let's use the "addition" (+) modifier, to combine two different noise generators into a single value when sampled.

(let* ((p2d (c:perlin-2d :seed "abc"))
       (p3d (c:perlin-3d :seed "def"))
       (add (c:+ p2d p3d)))
  (c:sample add 0.1d0 42.5d0 13.6d0))

Here, we created both a Perlin 2D and a Perlin 3D generator, then we used a modifier which takes 2 samplers as arguments and returns a new sampler. Then, we sampled from the new sampler in the same way we did earlier. The result of the addition modifier is the same as if you were to sample from both of the Perlin generators individually, and then called #'cl:+ on their results; it simply adds the two results together to obtain a new result.

The important thing to realize here, is that both generators and modifiers are "samplers", and can be sampled from in the same way with #'c:sample. The only difference between the two, is generators do not take samplers as inputs (in most cases); they are leaf nodes in an arbitrarily deep tree of samplers.

Once we have more than a few modifiers in a sampler tree, it gets very messy:

(let ((tree (c:turbulence
             (c:fractalize
              (c:uniform-scale
               (c:perlin-3d :seed "example") 1.5)
              :fbm :frequency 1.3 :octaves 6 :lacunarity 3 :persistence 0.22)
             (c:open-simplex-3d :seed "foo") :power 1.2 :roughness 4)))
  (c:sample tree 0.1d0 42.5d0 13.5d0))

Cricket re-exports the -> arrow macro from arrow-macros that can help us here. Rewriting the last sampler tree using the -> operator looks like this:

(c:-> (c:perlin-3d :seed "example")
  (c:uniform-scale 1.5)
  (c:fractalize :fbm :frequency 1.3 :octaves 6 :lacunarity 3 :persistence 0.22)
  (c:turbulence (c:open-simplex-3d :seed "foo") :power 1.2 :roughness 4)
  (c:sample 0.1d0 42.5d0 13.6d0))

That is much easier to read, and working with this library you'll likely be creating much more complex sampler trees.

So far, we've only sampled from a sampler once, but to create an image, we'd want to do that for each pixel of the image. Cricket has convenient tools to process arrays of noise values.

First, let's slightly modify our last complex sampler tree to add one more step at the end, which will generate an array of all the sampled outputs over a 2-dimensional area:

(c:-> (c:perlin-3d :seed "example")
  (c:uniform-scale 1.5)
  (c:fractalize :fbm :frequency 1.3 :octaves 6 :lacunarity 3 :persistence 0.22)
  (c:turbulence (c:open-simplex-3d :seed "foo") :power 1.2 :roughness 4)
  (c:make-map :width 1024 :height 1024))

Here, we removed the call to #'c:sample and replaced it with a call to #'c:make-map. This function takes a width and height and returns an object containing an array of all sampled output values for each X/Y coordinate pair. This data structure is called a "map", and it can be used on its own, or processed further by other functions. For example, let's add one more function to our pipeline:

(c:-> (c:perlin-3d :seed "example")
  (c:uniform-scale 1.5)
  (c:fractalize :fbm :frequency 1.3 :octaves 6 :lacunarity 3 :persistence 0.22)
  (c:turbulence (c:open-simplex-3d :seed "foo") :power 1.2 :roughness 4)
  (c:make-map :width 1024 :height 1024)
  (c:render-map))

Here #'c:render-map takes the previously constructed map as its input, and returns an "image", which is an object containing an array of RGBA pixel colors, that can then be inspected or written to disk as an image format we can view in an image viewing application. To write the image object to an image file on disk, we can add one more call to our pipeline:

(c:-> (c:perlin-3d :seed "example")
  (c:uniform-scale 1.5)
  (c:fractalize :fbm :frequency 1.3 :octaves 6 :lacunarity 3 :persistence 0.22)
  (c:turbulence (c:open-simplex-3d :seed "foo") :power 1.2 :roughness 4)
  (c:make-map :width 1024 :height 1024)
  (c:render-map)
  (c:write-image "/tmp/example.png"))

This will process the image object and write it to a PNG image file on disk. You can now go ahead and open it up in your image viewing application. It should look like this:

Pretty nice, although it is a bit boring. We could add some color to it bring out the texture. Cricket includes a few gradients that we can apply when rendering a map with #'c:render-map. You can also define your own with define-gradient, but for now, let's use the built-in :terrain gradient, to try to make this look like some terrain. Modify the call to #'c:render-map like so:

(c:-> (c:perlin-3d :seed "example")
  (c:uniform-scale 1.5)
  (c:fractalize :fbm :frequency 1.3 :octaves 6 :lacunarity 3 :persistence 0.22)
  (c:turbulence (c:open-simplex-3d :seed "foo") :power 1.2 :roughness 4)
  (c:make-map :width 1024 :height 1024)
  (c:render-map :gradient :terrain)
  (c:write-image "/tmp/example.png"))

Now our generated image looks like this:

This concludes the basic overview of working with Cricket. More extensive documentation is on the list of things to add, but for now, if you have any questions or requests, please feel free to send me an email or contact me on the usual forums.

License

Copyright © Michael Fiano mail@mfiano.net.

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 cricket

Author

Michael Fiano <mail@mfiano.net>

Home Page

https://git.mfiano.net/mfiano/cricket

License

MIT

Description

A library for generating and manipulating coherent noise

Dependencies
Source

cricket.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 cricket/generators

Dependency

common.lisp (file)

Parent

cricket (system)

Location

generators/

Components

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

3.2 cricket/modifiers

Dependency

generators (module)

Parent

cricket (system)

Location

modifiers/

Components

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

3.3 cricket/map

Dependency

modifiers (module)

Parent

cricket (system)

Location

map/

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

Location

/home/quickref/quicklisp/dists/quicklisp/software/cricket-20210411-git/cricket.asd

Systems

cricket (system)


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

4.1.2 cricket/package.lisp

Parent

cricket (system)

Location

package.lisp

Packages

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

4.1.3 cricket/conditions.lisp

Dependency

package.lisp (file)

Parent

cricket (system)

Location

conditions.lisp

Exported Definitions
Internal Definitions

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

4.1.4 cricket/common.lisp

Dependency

conditions.lisp (file)

Parent

cricket (system)

Location

common.lisp

Exported Definitions
Internal Definitions

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

4.1.5 cricket/generators/perlin-1d.lisp

Parent

generators (module)

Location

generators/perlin-1d.lisp

Packages

%cricket.generators.perlin-1d

Exported Definitions
Internal Definitions

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

4.1.6 cricket/generators/perlin-2d.lisp

Parent

generators (module)

Location

generators/perlin-2d.lisp

Packages

%cricket.generators.perlin-2d

Exported Definitions
Internal Definitions

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

4.1.7 cricket/generators/perlin-3d.lisp

Parent

generators (module)

Location

generators/perlin-3d.lisp

Packages

%cricket.generators.perlin-3d

Exported Definitions
Internal Definitions

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

4.1.8 cricket/generators/perlin-4d.lisp

Parent

generators (module)

Location

generators/perlin-4d.lisp

Packages

%cricket.generators.perlin-4d

Exported Definitions
Internal Definitions

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

4.1.9 cricket/generators/simplex-1d.lisp

Parent

generators (module)

Location

generators/simplex-1d.lisp

Packages

%cricket.generators.simplex-1d

Exported Definitions
Internal Definitions

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

4.1.10 cricket/generators/simplex-2d.lisp

Parent

generators (module)

Location

generators/simplex-2d.lisp

Packages

%cricket.generators.simplex-2d

Exported Definitions
Internal Definitions

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

4.1.11 cricket/generators/simplex-3d.lisp

Parent

generators (module)

Location

generators/simplex-3d.lisp

Packages

%cricket.generators.simplex-3d

Exported Definitions
Internal Definitions

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

4.1.12 cricket/generators/simplex-4d.lisp

Parent

generators (module)

Location

generators/simplex-4d.lisp

Packages

%cricket.generators.simplex-4d

Exported Definitions
Internal Definitions

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

4.1.13 cricket/generators/open-simplex-2d.lisp

Parent

generators (module)

Location

generators/open-simplex-2d.lisp

Packages

%cricket.generators.open-simplex-2d

Exported Definitions
Internal Definitions

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

4.1.14 cricket/generators/open-simplex-3d.lisp

Parent

generators (module)

Location

generators/open-simplex-3d.lisp

Packages

%cricket.generators.open-simplex-3d

Exported Definitions
Internal Definitions

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

4.1.15 cricket/generators/open-simplex-4d.lisp

Parent

generators (module)

Location

generators/open-simplex-4d.lisp

Packages

%cricket.generators.open-simplex-4d

Exported Definitions
Internal Definitions

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

4.1.16 cricket/generators/open-simplex2f-2d.lisp

Parent

generators (module)

Location

generators/open-simplex2f-2d.lisp

Packages

%cricket.generators.open-simplex2f-2d

Exported Definitions
Internal Definitions

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

4.1.17 cricket/generators/open-simplex2f-3d.lisp

Parent

generators (module)

Location

generators/open-simplex2f-3d.lisp

Packages

%cricket.generators.open-simplex2f-3d

Exported Definitions
Internal Definitions

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

4.1.18 cricket/generators/open-simplex2f-4d.lisp

Parent

generators (module)

Location

generators/open-simplex2f-4d.lisp

Packages

%cricket.generators.open-simplex2f-4d

Exported Definitions
Internal Definitions

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

4.1.19 cricket/generators/open-simplex2s-2d.lisp

Parent

generators (module)

Location

generators/open-simplex2s-2d.lisp

Packages

%cricket.generators.open-simplex2s-2d

Exported Definitions
Internal Definitions

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

4.1.20 cricket/generators/open-simplex2s-3d.lisp

Parent

generators (module)

Location

generators/open-simplex2s-3d.lisp

Packages

%cricket.generators.open-simplex2s-3d

Exported Definitions
Internal Definitions

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

4.1.21 cricket/generators/open-simplex2s-4d.lisp

Parent

generators (module)

Location

generators/open-simplex2s-4d.lisp

Packages

%cricket.generators.open-simplex2s-4d

Exported Definitions
Internal Definitions

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

4.1.22 cricket/generators/value-2d.lisp

Parent

generators (module)

Location

generators/value-2d.lisp

Packages

%cricket.generators.value-2d

Exported Definitions
Internal Definitions

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

4.1.23 cricket/generators/value-3d.lisp

Parent

generators (module)

Location

generators/value-3d.lisp

Packages

%cricket.generators.value-3d

Exported Definitions
Internal Definitions

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

4.1.24 cricket/generators/cellular-2d.lisp

Parent

generators (module)

Location

generators/cellular-2d.lisp

Packages

%cricket.generators.cellular-2d

Exported Definitions
Internal Definitions

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

4.1.25 cricket/generators/cellular-3d.lisp

Parent

generators (module)

Location

generators/cellular-3d.lisp

Packages

%cricket.generators.cellular-3d

Exported Definitions
Internal Definitions

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

4.1.26 cricket/generators/cylinders-3d.lisp

Parent

generators (module)

Location

generators/cylinders-3d.lisp

Packages

%cricket.generators.cylinders-3d

Exported Definitions
Internal Definitions

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

4.1.27 cricket/generators/spheres-3d.lisp

Parent

generators (module)

Location

generators/spheres-3d.lisp

Packages

%cricket.generators.spheres-3d

Exported Definitions
Internal Definitions

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

4.1.28 cricket/generators/checker-2d.lisp

Parent

generators (module)

Location

generators/checker-2d.lisp

Packages

%cricket.generators.checker-2d

Exported Definitions
Internal Definitions

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

4.1.29 cricket/generators/constant.lisp

Parent

generators (module)

Location

generators/constant.lisp

Packages

%cricket.generators.constant

Exported Definitions
Internal Definitions

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

4.1.30 cricket/generators/fbm-2d.lisp

Parent

generators (module)

Location

generators/fbm-2d.lisp

Packages

%cricket.generators.fbm-2d

Exported Definitions
Internal Definitions

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

4.1.31 cricket/generators/fbm-3d.lisp

Parent

generators (module)

Location

generators/fbm-3d.lisp

Packages

%cricket.generators.fbm-3d

Exported Definitions
Internal Definitions

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

4.1.32 cricket/generators/fbm-4d.lisp

Parent

generators (module)

Location

generators/fbm-4d.lisp

Packages

%cricket.generators.fbm-4d

Exported Definitions
Internal Definitions

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

4.1.33 cricket/generators/billow-2d.lisp

Parent

generators (module)

Location

generators/billow-2d.lisp

Packages

%cricket.generators.billow-2d

Exported Definitions
Internal Definitions

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

4.1.34 cricket/generators/billow-3d.lisp

Parent

generators (module)

Location

generators/billow-3d.lisp

Packages

%cricket.generators.billow-3d

Exported Definitions
Internal Definitions

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

4.1.35 cricket/generators/billow-4d.lisp

Parent

generators (module)

Location

generators/billow-4d.lisp

Packages

%cricket.generators.billow-4d

Exported Definitions
Internal Definitions

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

4.1.36 cricket/generators/multifractal-2d.lisp

Parent

generators (module)

Location

generators/multifractal-2d.lisp

Packages

%cricket.generators.multifractal-2d

Exported Definitions
Internal Definitions

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

4.1.37 cricket/generators/multifractal-3d.lisp

Parent

generators (module)

Location

generators/multifractal-3d.lisp

Packages

%cricket.generators.multifractal-3d

Exported Definitions
Internal Definitions

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

4.1.38 cricket/generators/multifractal-4d.lisp

Parent

generators (module)

Location

generators/multifractal-4d.lisp

Packages

%cricket.generators.multifractal-4d

Exported Definitions
Internal Definitions

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

4.1.39 cricket/generators/hybrid-multifractal-2d.lisp

Parent

generators (module)

Location

generators/hybrid-multifractal-2d.lisp

Packages

%cricket.generators.hybrid-multifractal-2d

Exported Definitions
Internal Definitions

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

4.1.40 cricket/generators/hybrid-multifractal-3d.lisp

Parent

generators (module)

Location

generators/hybrid-multifractal-3d.lisp

Packages

%cricket.generators.hybrid-multifractal-3d

Exported Definitions
Internal Definitions

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

4.1.41 cricket/generators/hybrid-multifractal-4d.lisp

Parent

generators (module)

Location

generators/hybrid-multifractal-4d.lisp

Packages

%cricket.generators.hybrid-multifractal-4d

Exported Definitions
Internal Definitions

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

4.1.42 cricket/generators/ridged-multifractal-2d.lisp

Parent

generators (module)

Location

generators/ridged-multifractal-2d.lisp

Packages

%cricket.generators.ridged-multifractal-2d

Exported Definitions
Internal Definitions

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

4.1.43 cricket/generators/ridged-multifractal-3d.lisp

Parent

generators (module)

Location

generators/ridged-multifractal-3d.lisp

Packages

%cricket.generators.ridged-multifractal-3d

Exported Definitions
Internal Definitions

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

4.1.44 cricket/generators/ridged-multifractal-4d.lisp

Parent

generators (module)

Location

generators/ridged-multifractal-4d.lisp

Packages

%cricket.generators.ridged-multifractal-4d

Exported Definitions
Internal Definitions

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

4.1.45 cricket/modifiers/abs.lisp

Parent

modifiers (module)

Location

modifiers/abs.lisp

Packages

%cricket.modifiers.abs

Exported Definitions
Internal Definitions

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

4.1.46 cricket/modifiers/add.lisp

Parent

modifiers (module)

Location

modifiers/add.lisp

Packages

%cricket.modifiers.add

Exported Definitions
Internal Definitions

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

4.1.47 cricket/modifiers/blend.lisp

Parent

modifiers (module)

Location

modifiers/blend.lisp

Packages

%cricket.modifiers.blend

Exported Definitions
Internal Definitions

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

4.1.48 cricket/modifiers/cache.lisp

Parent

modifiers (module)

Location

modifiers/cache.lisp

Packages

%cricket.modifiers.cache

Exported Definitions
Internal Definitions

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

4.1.49 cricket/modifiers/clamp.lisp

Parent

modifiers (module)

Location

modifiers/clamp.lisp

Packages

%cricket.modifiers.clamp

Exported Definitions
Internal Definitions

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

4.1.50 cricket/modifiers/curve.lisp

Parent

modifiers (module)

Location

modifiers/curve.lisp

Packages

%cricket.modifiers.curve

Exported Definitions
Internal Definitions

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

4.1.51 cricket/modifiers/displace.lisp

Parent

modifiers (module)

Location

modifiers/displace.lisp

Packages

%cricket.modifiers.displace

Exported Definitions
Internal Definitions

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

4.1.52 cricket/modifiers/divide.lisp

Parent

modifiers (module)

Location

modifiers/divide.lisp

Packages

%cricket.modifiers.divide

Exported Definitions
Internal Definitions

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

4.1.53 cricket/modifiers/expt.lisp

Parent

modifiers (module)

Location

modifiers/expt.lisp

Packages

%cricket.modifiers.expt

Exported Definitions
Internal Definitions

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

4.1.54 cricket/modifiers/fractalize.lisp

Parent

modifiers (module)

Location

modifiers/fractalize.lisp

Packages

%cricket.modifiers.fractalize

Exported Definitions

fractalize (function)


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

4.1.55 cricket/modifiers/max.lisp

Parent

modifiers (module)

Location

modifiers/max.lisp

Packages

%cricket.modifiers.max

Exported Definitions
Internal Definitions

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

4.1.56 cricket/modifiers/min.lisp

Parent

modifiers (module)

Location

modifiers/min.lisp

Packages

%cricket.modifiers.min

Exported Definitions
Internal Definitions

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

4.1.57 cricket/modifiers/negate.lisp

Parent

modifiers (module)

Location

modifiers/negate.lisp

Packages

%cricket.modifiers.negate

Exported Definitions
Internal Definitions

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

4.1.58 cricket/modifiers/multiply.lisp

Parent

modifiers (module)

Location

modifiers/multiply.lisp

Packages

%cricket.modifiers.multiply

Exported Definitions
Internal Definitions

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

4.1.59 cricket/modifiers/power.lisp

Parent

modifiers (module)

Location

modifiers/power.lisp

Packages

%cricket.modifiers.power

Exported Definitions
Internal Definitions

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

4.1.60 cricket/modifiers/rotate.lisp

Parent

modifiers (module)

Location

modifiers/rotate.lisp

Packages

%cricket.modifiers.rotate

Exported Definitions
Internal Definitions

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

4.1.61 cricket/modifiers/scale.lisp

Parent

modifiers (module)

Location

modifiers/scale.lisp

Packages

%cricket.modifiers.scale

Exported Definitions
Internal Definitions

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

4.1.62 cricket/modifiers/select.lisp

Parent

modifiers (module)

Location

modifiers/select.lisp

Packages

%cricket.modifiers.select

Exported Definitions
Internal Definitions

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

4.1.63 cricket/modifiers/strengthen.lisp

Parent

modifiers (module)

Location

modifiers/strengthen.lisp

Packages

%cricket.modifiers.strengthen

Exported Definitions
Internal Definitions

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

4.1.64 cricket/modifiers/subtract.lisp

Parent

modifiers (module)

Location

modifiers/subtract.lisp

Packages

%cricket.modifiers.subtract

Exported Definitions
Internal Definitions

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

4.1.65 cricket/modifiers/terrace.lisp

Parent

modifiers (module)

Location

modifiers/terrace.lisp

Packages

%cricket.modifiers.terrace

Exported Definitions
Internal Definitions

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

4.1.66 cricket/modifiers/translate.lisp

Parent

modifiers (module)

Location

modifiers/translate.lisp

Packages

%cricket.modifiers.translate

Exported Definitions
Internal Definitions

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

4.1.67 cricket/modifiers/turbulence.lisp

Parent

modifiers (module)

Location

modifiers/turbulence.lisp

Packages

%cricket.modifiers.turbulence

Exported Definitions
Internal Definitions

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

4.1.68 cricket/map/color.lisp

Parent

map (module)

Location

map/color.lisp

Internal Definitions

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

4.1.69 cricket/map/gradient.lisp

Parent

map (module)

Location

map/gradient.lisp

Exported Definitions

define-gradient (macro)

Internal Definitions

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

4.1.70 cricket/map/image.lisp

Parent

map (module)

Location

map/image.lisp

Exported Definitions
Internal Definitions

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

4.1.71 cricket/map/map.lisp

Parent

map (module)

Location

map/map.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 %cricket.generators

Source

package.lisp (file)

Used By List

cricket

Exported Definitions

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

5.2 cricket

Source

package.lisp (file)

Use List

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

5.3 %cricket.modifiers

Source

package.lisp (file)

Used By List

cricket

Exported Definitions

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

5.4 %cricket.internal

Source

package.lisp (file)

Use List

common-lisp

Used By List

cricket

Exported Definitions
Internal Definitions

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

5.5 %cricket.map

Source

package.lisp (file)

Use List

common-lisp

Used By List

cricket

Exported Definitions
Internal Definitions

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

5.6 %cricket.generators.perlin-1d

Source

perlin-1d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.7 %cricket.generators.perlin-2d

Source

perlin-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.8 %cricket.generators.perlin-3d

Source

perlin-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.9 %cricket.generators.perlin-4d

Source

perlin-4d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.10 %cricket.generators.simplex-1d

Source

simplex-1d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.11 %cricket.generators.simplex-2d

Source

simplex-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.12 %cricket.generators.simplex-3d

Source

simplex-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.13 %cricket.generators.simplex-4d

Source

simplex-4d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.14 %cricket.generators.open-simplex-2d

Source

open-simplex-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.15 %cricket.generators.open-simplex-3d

Source

open-simplex-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.16 %cricket.generators.open-simplex-4d

Source

open-simplex-4d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.17 %cricket.generators.open-simplex2f-2d

Source

open-simplex2f-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.18 %cricket.generators.open-simplex2f-3d

Source

open-simplex2f-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.19 %cricket.generators.open-simplex2f-4d

Source

open-simplex2f-4d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.20 %cricket.generators.open-simplex2s-2d

Source

open-simplex2s-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.21 %cricket.generators.open-simplex2s-3d

Source

open-simplex2s-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.22 %cricket.generators.open-simplex2s-4d

Source

open-simplex2s-4d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.23 %cricket.generators.value-2d

Source

value-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.24 %cricket.generators.value-3d

Source

value-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.25 %cricket.generators.cellular-2d

Source

cellular-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.26 %cricket.generators.cellular-3d

Source

cellular-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.27 %cricket.generators.cylinders-3d

Source

cylinders-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.28 %cricket.generators.spheres-3d

Source

spheres-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.29 %cricket.generators.checker-2d

Source

checker-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.30 %cricket.generators.constant

Source

constant.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.31 %cricket.generators.fbm-2d

Source

fbm-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.32 %cricket.generators.fbm-3d

Source

fbm-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.33 %cricket.generators.fbm-4d

Source

fbm-4d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.34 %cricket.generators.billow-2d

Source

billow-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.35 %cricket.generators.billow-3d

Source

billow-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.36 %cricket.generators.billow-4d

Source

billow-4d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.37 %cricket.generators.multifractal-2d

Source

multifractal-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.38 %cricket.generators.multifractal-3d

Source

multifractal-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.39 %cricket.generators.multifractal-4d

Source

multifractal-4d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.40 %cricket.generators.hybrid-multifractal-2d

Source

hybrid-multifractal-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.41 %cricket.generators.hybrid-multifractal-3d

Source

hybrid-multifractal-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.42 %cricket.generators.hybrid-multifractal-4d

Source

hybrid-multifractal-4d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.43 %cricket.generators.ridged-multifractal-2d

Source

ridged-multifractal-2d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.44 %cricket.generators.ridged-multifractal-3d

Source

ridged-multifractal-3d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.45 %cricket.generators.ridged-multifractal-4d

Source

ridged-multifractal-4d.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.46 %cricket.modifiers.abs

Source

abs.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.47 %cricket.modifiers.add

Source

add.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.48 %cricket.modifiers.blend

Source

blend.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.49 %cricket.modifiers.cache

Source

cache.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.50 %cricket.modifiers.clamp

Source

clamp.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.51 %cricket.modifiers.curve

Source

curve.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.52 %cricket.modifiers.displace

Source

displace.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.53 %cricket.modifiers.divide

Source

divide.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.54 %cricket.modifiers.expt

Source

expt.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.55 %cricket.modifiers.fractalize

Source

fractalize.lisp (file)

Use List

common-lisp


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

5.56 %cricket.modifiers.max

Source

max.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.57 %cricket.modifiers.min

Source

min.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.58 %cricket.modifiers.negate

Source

negate.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.59 %cricket.modifiers.multiply

Source

multiply.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.60 %cricket.modifiers.power

Source

power.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.61 %cricket.modifiers.rotate

Source

rotate.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.62 %cricket.modifiers.scale

Source

scale.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.63 %cricket.modifiers.select

Source

select.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.64 %cricket.modifiers.strengthen

Source

strengthen.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.65 %cricket.modifiers.subtract

Source

subtract.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.66 %cricket.modifiers.terrace

Source

terrace.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.67 %cricket.modifiers.translate

Source

translate.lisp (file)

Use List

common-lisp

Internal Definitions

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

5.68 %cricket.modifiers.turbulence

Source

turbulence.lisp (file)

Use List

common-lisp

Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Macros

Macro: define-gradient (TYPE) &body BODY
Package

%cricket.map

Source

gradient.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: * SOURCE1 SOURCE2

Construct a sampler that, when sampled, outputs the result of multiplying the outputs of ‘source1‘ and ‘source2‘.

‘source1‘: The first input sampler (required).

‘source2‘: The second input sampler (required).

Package

%cricket.modifiers

Source

multiply.lisp (file)

Function: + SOURCE1 SOURCE2

Construct a sampler that, when sampled, outputs the result of adding the outputs of ‘source1‘ and ‘source2‘.

‘source1‘: The first input sampler (required).

‘source2‘: The second input sampler (required).

Package

%cricket.modifiers

Source

add.lisp (file)

Function: - SOURCE1 SOURCE2

Construct a sampler that, when sampled, outputs the result of subtracting the output ‘source2‘ from the output of ‘source1‘.

‘source1‘: The first input sampler (required).

‘source2‘: The second input sampler (required).

Package

%cricket.modifiers

Source

subtract.lisp (file)

Function: / SOURCE1 SOURCE2

Construct a sampler that, when sampled, outputs the result of dividing the output ‘source1‘ by the output of ‘source2‘.

‘source1‘: The first input sampler (required).

‘source2‘: The second input sampler (required).

Package

%cricket.modifiers

Source

divide.lisp (file)

Function: abs SOURCE

Construct a sampler that, when sampled, outputs the absolute value of the output of ‘source‘.

‘source‘: The input sampler (required).

Package

%cricket.modifiers

Source

abs.lisp (file)

Function: billow-2d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 2-dimensional billow fractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 2-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-2d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.5).

Package

%cricket.generators

Source

billow-2d.lisp (file)

Function: billow-3d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 3-dimensional billow fractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 3-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-3d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.5).

Package

%cricket.generators

Source

billow-3d.lisp (file)

Function: billow-4d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 4-dimensional billow fractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 4-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-4d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.5).

Package

%cricket.generators

Source

billow-4d.lisp (file)

Function: blend SOURCE1 SOURCE2 CONTROL

Construct a sampler that, when sampled, outputs a blend between the outputs of ‘source1‘ and ‘source2‘, by means of a linear interpolation using the output value of ‘control‘ as the interpolation parameter.

If the output of ‘control‘ is negative, the blended output is weighted towards the output of ‘source1‘. If the output of ‘control‘ is positive, the blended output is weighted towards the output of ‘source2‘.

‘source1‘: The sampler to weight towards if the output of ‘control‘ is negative (required).

‘source2‘: The sampler to weight towards if the output of ‘control‘ is positive (required).

‘control‘: The sampler that determines the weight of the blending operation (required).

Package

%cricket.modifiers

Source

blend.lisp (file)

Function: cache SOURCE

Construct a sampler that, when sampled, caches the set of input coordinates and the output of its input sampler. If a set of input coordinates differs from the previous input coordinates, the cache is invalidated and the new input coordinates and output value is cached.

Caching is useful if a sampler is used as a source for multiple modifiers. Without caching, the duplicated input sources would redundantly compute the same outputs, which would be expensive, especially if long modifier chains are shared.

‘source‘: The sampler to cache (required).

Package

%cricket.modifiers

Source

cache.lisp (file)

Function: cellular-2d &key SEED DISTANCE-METHOD OUTPUT-TYPE JITTER

Construct a sampler that, when sampled, outputs 2-dimensional cellular noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘distance-method‘: One of ‘:manhattan‘, ‘:euclidean‘, ‘:euclidean-squared‘, ‘:chebyshev‘, or ‘:minkowski4‘, denoting the distance function to use (optional, default: ‘:euclidean‘).

‘output-type‘: One of ‘:value‘, ‘:f1‘, ‘:f2‘, ‘:f1+f2‘, ‘:f2-f1‘, ‘:f1*f2‘, or ‘:f1/f2‘ denoting the features to use (optional, default: ‘:f1‘).

‘jitter‘: A real number between 0.0 and 1.0, with values closer to one randomly distributing cells away from their grid alignment (optional, default: 1.0).

Package

%cricket.generators

Source

cellular-2d.lisp (file)

Function: cellular-3d &key SEED DISTANCE-METHOD OUTPUT-TYPE JITTER

Construct a sampler that, when sampled, outputs 3-dimensional cellular noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘distance-method‘: One of ‘:manhattan‘, ‘:euclidean‘, ‘:euclidean-squared‘, ‘:chebyshev‘, or ‘:minkowski4‘, denoting the distance function to use (optional, default: ‘:euclidean‘).

‘output-type‘: One of ‘:value‘, ‘:f1‘, ‘:f2‘, ‘:f1+f2‘, ‘:f2-f1‘, ‘:f1*f2‘, or ‘:f1/f2‘ denoting the features to use (optional, default: ‘:f1‘).

‘jitter‘: A real number between 0.0 and 1.0, with values closer to one randomly distributing cells away from their grid alignment (optional, default: 1.0).

Package

%cricket.generators

Source

cellular-3d.lisp (file)

Function: checker-2d &key SEED

Construct a sampler that, when sampled, outputs a 2-dimensional checkered grid pattern, with values being either -1.0 or 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

checker-2d.lisp (file)

Function: clamp SOURCE MIN MAX

Construct a sampler that, when sampled, clamps the output of ‘source‘ to be within the range ‘min‘..‘max‘. If the output of ‘source‘ is less than ‘min‘, the result will be ‘min‘. If the output of ‘source‘ is greater than ‘max‘, the result will be ‘max‘.

‘source‘: The input sampler to clamp (required).

‘min‘: A real number denoting the lower bound of the clamping range (required).

‘max‘: A real number denoting the upper bound of the clamping range (required).

Package

%cricket.modifiers

Source

clamp.lisp (file)

Function: constant VALUE &key SEED

Construct a sampler that, when sampled, outputs the constant ‘value‘ supplied. This is useful for debugging and applications where you need to combine a constant value.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

constant.lisp (file)

Function: curve SOURCE &key POINTS

Construct a sampler that, when sampled, outputs the result of sampling from ‘source‘ after remapping to an arbitrary curve.

The curve is defined by a list of point pairs given with ‘points‘, with its format being a list of cons cells. Each cons cell in the list of points represents an input and an output number. The curve is a cubic spline, and so ‘points‘ must contain a list of four point pairs at a minimum. Additionally, no two point pairs can contain the same input point value.

When sampling the input sampler ‘source‘, the result is evaluated using the curve data, and maps it to a new output value.

‘source‘: The input sampler to map onto the curve (required).

‘points‘: A list of cons pairs denoting input (car) and output (cdr) control points of the curve (required).

Package

%cricket.modifiers

Source

curve.lisp (file)

Function: cylinders-3d &key SEED FREQUENCY

Construct a sampler that, when sampled, outputs 3-dimensional concentric cylinder values ranging from -1.0 to 1.0. The cylinders are oriented with their length along the Z axis.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘frequency‘: The frequency of the signal, which controls how small or large the cylinders are (optional, default: 1.0).

Package

%cricket.generators

Source

cylinders-3d.lisp (file)

Function: displace SOURCE &key X Y Z W

Construct a sampler that, when sampled, modifies the input coordinates of its input sampler ‘source‘, before sampling from it. ‘x‘, ‘y‘, ‘z‘, and ‘w‘ are samplers, where the result of sampling from them are added to the input coordinate of the corresponding axis. After modifying of the input coordinates, ‘source‘ is then sampled with the new input coordinate set. Any displacement samplers that are not specified will not displace the corresponding axis of the input sampler.

‘source‘: The input sampler to displace (required).

‘x‘: A sampler that is evaluated and added to the X axis input coordinate of ‘source‘ (optional).

‘y‘: A sampler that is evaluated and added to the Y axis input coordinate of ‘source‘ (optional).

‘z‘: A sampler that is evaluated and added to the Z axis input coordinate of ‘source‘ (optional).

‘w‘: A sampler that is evaluated and added to the W axis input coordinate of ‘source‘ (optional).

Package

%cricket.modifiers

Source

displace.lisp (file)

Function: expt SOURCE POWER

Construct a sampler that, when sampled, raises the power of the output of ‘source‘ to ‘power‘.

‘source‘: The input sampler (required).

‘power‘: The power to raise the output to (required).

Package

%cricket.modifiers

Source

expt.lisp (file)

Function: fbm-2d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 2-dimensional fractional Brownian motion noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 2-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2f-2d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.5).

Package

%cricket.generators

Source

fbm-2d.lisp (file)

Function: fbm-3d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 3-dimensional fractional Brownian motion noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 3-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2f-3d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.5).

Package

%cricket.generators

Source

fbm-3d.lisp (file)

Function: fbm-4d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 4-dimensional fractional Brownian motion noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 4-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2f-4d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.5).

Package

%cricket.generators

Source

fbm-4d.lisp (file)

Function: fractalize SOURCE TYPE &rest ARGS &key OCTAVES FREQUENCY LACUNARITY PERSISTENCE ATTENUATION

Construct a sampler that, when sampled, outputs the result of fractalizing its input sampler’s output over an arbitrary number of octaves. ‘type‘ may be a keyword denoting any of the built-in generator fractal types:

‘:fbm‘: Fractional Brownian motion.

‘:billow‘: Creates billowy cloud or rock-like formations.

‘:multi‘: Multifractal whose fractal dimensions vary.

‘:hybrid-multi‘: Multifractal noise that results in valleys having smooth bottoms.

‘:ridged-multi‘: Creates ridges suitable for terrain generation.

The parameters supplied to this modifier are consistent with the behaviors they provide for the corresponding fractal generator.

There are a few differences between this modifier and the corresponding generator:

- This modifier fractalizes each dimension of the input sampler; there is no ability to specify the dimensionality of the output.

- The default parameter values of this modifier are generic, and may not match the default values of the corresponding generator. You should ensure that you are calling this with the desired parameter values if leaving any unspecified.

- The input sampler’s output is used for each octave of the generated fractal. This is in contrast to generator fractals, where their octaves are other generators each being seeded differently.

‘source‘: The input sampler (required).

‘type‘: A keyword denoting one of the valid fractal types (required).

‘octaves‘: The number of octaves to generate (optional, default: 4).

‘frequency‘: The frequency of the first octave (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.5).

‘attenuation‘: The attenuation to apply to the weight of each octave - only applicable for the ‘:ridged-multi‘ type (optional, default: 2.0)

Package

%cricket.modifiers

Source

fractalize.lisp (file)

Function: get-image-pixel IMAGE X Y
Package

%cricket.map

Source

image.lisp (file)

Function: hybrid-multifractal-2d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 2-dimensional hybrid multifractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 2-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-2d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.25).

Package

%cricket.generators

Source

hybrid-multifractal-2d.lisp (file)

Function: hybrid-multifractal-3d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 3-dimensional hybrid multifractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 3-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-3d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.25).

Package

%cricket.generators

Source

hybrid-multifractal-3d.lisp (file)

Function: hybrid-multifractal-4d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 4-dimensional hybrid multifractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 4-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-4d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.25).

Package

%cricket.generators

Source

hybrid-multifractal-4d.lisp (file)

Function: image-data INSTANCE
Function: (setf image-data) VALUE INSTANCE
Package

%cricket.map

Source

image.lisp (file)

Function: image-height INSTANCE
Function: (setf image-height) VALUE INSTANCE
Package

%cricket.map

Source

image.lisp (file)

Function: image-width INSTANCE
Function: (setf image-width) VALUE INSTANCE
Package

%cricket.map

Source

image.lisp (file)

Function: make-map SOURCE &key WIDTH HEIGHT X-MIN X-MAX Y-MIN Y-MAX PARALLEL-P
Package

%cricket.map

Source

map.lisp (file)

Function: map-data INSTANCE
Function: (setf map-data) VALUE INSTANCE
Package

%cricket.map

Source

map.lisp (file)

Function: map-height INSTANCE
Function: (setf map-height) VALUE INSTANCE
Package

%cricket.map

Source

map.lisp (file)

Function: map-value MAP X Y
Function: (setf map-value) VALUE MAP X Y
Package

%cricket.map

Source

map.lisp (file)

Function: map-width INSTANCE
Function: (setf map-width) VALUE INSTANCE
Package

%cricket.map

Source

map.lisp (file)

Function: max SOURCE1 SOURCE2

Construct a sampler that, when sampled, outputs the maximum of the outputs of its two input samplers.

‘source1‘: The first input sampler (required).

‘source2‘: The second input sampler (required).

Package

%cricket.modifiers

Source

max.lisp (file)

Function: min SOURCE1 SOURCE2

Construct a sampler that, when sampled, outputs the minimum of the outputs of its two input samplers.

‘source1‘: The first input sampler (required).

‘source2‘: The second input sampler (required).

Package

%cricket.modifiers

Source

min.lisp (file)

Function: multifractal-2d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 2-dimensional multifractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 2-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-2d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.5).

Package

%cricket.generators

Source

multifractal-2d.lisp (file)

Function: multifractal-3d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 3-dimensional multifractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 3-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-3d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.5).

Package

%cricket.generators

Source

multifractal-3d.lisp (file)

Function: multifractal-4d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 4-dimensional multifractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 4-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-4d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 0.5).

Package

%cricket.generators

Source

multifractal-4d.lisp (file)

Function: negate SOURCE

Construct a sampler that, when sampled, negates the output value of its input sampler.

‘source‘: The input sampler (required).

Package

%cricket.modifiers

Source

negate.lisp (file)

Function: open-simplex-2d &key SEED

Construct a sampler that, when sampled, outputs 2-dimensional OpenSimplex noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

open-simplex-2d.lisp (file)

Function: open-simplex-3d &key SEED

Construct a sampler that, when sampled, outputs 3-dimensional OpenSimplex noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

open-simplex-3d.lisp (file)

Function: open-simplex-4d &key SEED

Construct a sampler that, when sampled, outputs 4-dimensional OpenSimplex noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

open-simplex-4d.lisp (file)

Function: open-simplex2f-2d &key SEED ORIENTATION

Construct a sampler that, when sampled, outputs 2-dimensional OpenSimplex2F noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘orientation‘: One of ‘:standard‘ or ‘:x/y‘, denoting the orientation of the lattice. ‘:x/y‘ has the Y axis pointing down the main diagonal, which might be more suitable for a game where Y is vertical (optional, default: ‘:standard‘).

Package

%cricket.generators

Source

open-simplex2f-2d.lisp (file)

Function: open-simplex2f-3d &key SEED ORIENTATION

Construct a sampler that, when sampled, outputs 3-dimensional OpenSimplex2F noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘orientation‘: One of ‘:standard‘, ‘:xy/z‘, or ‘:xz/y‘, denoting the orientation of the lattice. ‘:xy/z‘ has better visual isotropy in XY, and ‘:xz/y‘ has better visual isotropy in XZ (optional, default: ‘:standard‘).

Package

%cricket.generators

Source

open-simplex2f-3d.lisp (file)

Function: open-simplex2f-4d &key SEED ORIENTATION

Construct a sampler that, when sampled, outputs 4-dimensional OpenSimplex2F noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘orientation‘: One of ‘:standard‘, ‘:xy/zw‘, ‘:xz/yw‘, or ‘:xyz/w‘, denoting the orientation of the lattice. ‘:xy/zw‘ is recommended for 3D terrain where X/Y or Z/W are horizontal. ‘:xz/yw‘ is recommended for 3D terrain where X/Z or Y/W are horizontal. ‘:xyz/w‘ is recommended for time-varied animations of 3D objects, where W is time (optional, default: ‘:standard‘).

Package

%cricket.generators

Source

open-simplex2f-4d.lisp (file)

Function: open-simplex2s-2d &key SEED ORIENTATION

Construct a sampler that, when sampled, outputs 2-dimensional OpenSimplex2S noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘orientation‘: One of ‘:standard‘ or ‘:x/y‘, denoting the orientation of the lattice. ‘:x/y‘ has the Y axis pointing down the main diagonal, which might be more suitable for a game where Y is vertical (optional, default: ‘:standard‘).

Package

%cricket.generators

Source

open-simplex2s-2d.lisp (file)

Function: open-simplex2s-3d &key SEED ORIENTATION

Construct a sampler that, when sampled, outputs 3-dimensional OpenSimplex2S noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘orientation‘: One of ‘:standard‘, ‘:xy/z‘, or ‘:xz/y‘, denoting the orientation of the lattice. ‘:xy/z‘ has better visual isotropy in XY, and ‘:xz/y‘ has better visual isotropy in XZ (optional, default: ‘:standard‘).

Package

%cricket.generators

Source

open-simplex2s-3d.lisp (file)

Function: open-simplex2s-4d &key SEED ORIENTATION

Construct a sampler that, when sampled, outputs 4-dimensional OpenSimplex2S noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘orientation‘: One of ‘:standard‘, ‘:xy/zw‘, ‘:xz/yw‘, or ‘:xyz/w‘, denoting the orientation of the lattice. ‘:xy/zw‘ is recommended for 3D terrain where X/Y or Z/W are horizontal. ‘:xz/yw‘ is recommended for 3D terrain where X/Z or Y/W are horizontal. ‘:xyz/w‘ is recommended for time-varied animations of 3D objects, where W is time (optional, default: ‘:standard‘).

Package

%cricket.generators

Source

open-simplex2s-4d.lisp (file)

Function: perlin-1d &key SEED

Construct a sampler that, when sampled, outputs 1-dimensional Perlin Improved noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

perlin-1d.lisp (file)

Function: perlin-2d &key SEED

Construct a sampler that, when sampled, outputs 2-dimensional Perlin Improved noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

perlin-2d.lisp (file)

Function: perlin-3d &key SEED

Construct a sampler that, when sampled, outputs 3-dimensional Perlin Improved noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

perlin-3d.lisp (file)

Function: perlin-4d &key SEED

Construct a sampler that, when sampled, outputs 4-dimensional Perlin Improved noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

perlin-4d.lisp (file)

Function: power SOURCE1 SOURCE2

Construct a sampler that, when sampled, raises the output of ‘source1‘ to the power of the output of ‘source2‘.

‘source1‘: The first input sampler (required).

‘source2‘: The second input sampler (required).

Package

%cricket.modifiers

Source

power.lisp (file)

Function: render-map MAP &key GRADIENT
Package

%cricket.map

Source

map.lisp (file)

Function: ridged-multifractal-2d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE ATTENUATION

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 2-dimensional ridged multifractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 2-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-2d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 1.0).

‘attenuation‘: The attenuation to apply to the weight of each octave (optional, default: 2.0).

Package

%cricket.generators

Source

ridged-multifractal-2d.lisp (file)

Function: ridged-multifractal-3d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE ATTENUATION

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 3-dimensional ridged multifractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 3-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-3d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 1.0).

‘attenuation‘: The attenuation to apply to the weight of each octave (optional, default: 2.0).

Package

%cricket.generators

Source

ridged-multifractal-3d.lisp (file)

Function: ridged-multifractal-4d &key SEED GENERATOR OCTAVES FREQUENCY LACUNARITY PERSISTENCE ATTENUATION

Construct a sampler that, when sampled, outputs the application of multiple octaves of a 4-dimensional ridged multifractal noise, using the supplied ‘generator‘ function to construct each octave’s sampler.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘generator‘: a function object pointing to one of the built-in 4-dimensional generators that is used to construct a different sampler, each with a different seed, for each octave (optional, default ‘#’open-simplex2s-4d‘).

‘octaves‘: An integer between 1 and 32, denoting the number of octaves to apply (optional, default: 4).

‘frequency‘: The frequency of the first octave’s signal (optional, default: 1.0).

‘lacunarity‘: A multiplier that determines how quickly the frequency increases for successive octaves (optional, default: 2.0).

‘persistence‘: A multiplier that determines how quickly the amplitude diminishes for successive octaves (optional, default 1.0).

‘attenuation‘: The attenuation to apply to the weight of each octave (optional, default: 2.0).

Package

%cricket.generators

Source

ridged-multifractal-4d.lisp (file)

Function: rotate SOURCE &key X Y Z

Construct a sampler that, when sampled, rotates the input coordinates around the origin before sampling from it. The coordinate system is assumed to be left-handed. The angle of rotation around each of the ‘x‘, ‘y‘, and ‘z‘ axes can be set individually.

‘source‘: The input sampler (required).

‘x‘: The angle in radians to rotate around the X axis (optional, default: 0.0).

‘y‘: The angle in radians to rotate around the Y axis (optional, default: 0.0).

‘z‘: The angle in radians to rotate around the Z axis (optional, default: 0.0).

Package

%cricket.modifiers

Source

rotate.lisp (file)

Function: scale SOURCE &key X Y Z W

Construct a sampler that, when sampled, scales the input coordinates of ‘source‘ down (increases the wavelength, and decreases the frequency), by the amounts given for each of the ‘x‘, ‘y‘, ‘z‘, and ‘w‘ axes.

‘source‘: The input sampler (required).

‘x‘: The amount to scale along the X axis (optional, default: 1.0).

‘y‘: The amount to scale along the Y axis (optional, default: 1.0).

‘z‘: The amount to scale along the Z axis (optional, default: 1.0).

‘w‘: The amount to scale along the W axis (optional, default: 1.0).

Package

%cricket.modifiers

Source

scale.lisp (file)

Function: select SOURCE1 SOURCE2 CONTROL &key MIN MAX FALLOFF

Construct a sampler that, when sampled, outputs the result of sampling from either ‘source1‘ or ‘source2‘. The input sampler chosen is decided based upon the output of the ‘control‘ sampler.

If the output of ‘control‘ is within the range denoted by ‘min‘ and ‘max‘, ‘source2‘ is chosen. If the output of ‘control‘ is outside of this range, ‘source1‘ is chosen.

‘source1‘: The first input sampler (required).

‘source2‘: The second input sampler (required).

‘control‘: The sampler that determines the sampler to output (required).

‘min‘: A real number between -1.0 and 1.0 defining the lower bound of the selection range (optional, default: -1.0).

‘max‘: A real number between -1.0 and 1.0 defining the upper bound of the selection range (optional, default: 1.0).

‘falloff‘: A real number between 0.0 and 1.0 specifying the smoothness of the transition (optional, default: 0.0).

Package

%cricket.modifiers

Source

select.lisp (file)

Function: simplex-1d &key SEED

Construct a sampler that, when sampled, outputs 1-dimensional Simplex noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

simplex-1d.lisp (file)

Function: simplex-2d &key SEED

Construct a sampler that, when sampled, outputs 2-dimensional Simplex noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

simplex-2d.lisp (file)

Function: simplex-3d &key SEED

Construct a sampler that, when sampled, outputs 3-dimensional Simplex noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

simplex-3d.lisp (file)

Function: simplex-4d &key SEED

Construct a sampler that, when sampled, outputs 4-dimensional Simplex noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

simplex-4d.lisp (file)

Function: spheres-3d &key SEED FREQUENCY

Construct a sampler that, when sampled, outputs 3-dimensional concentric sphere values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

‘frequency‘: The frequency of the signal, which controls how small or large the spheres are (optional, default: 1.0).

Package

%cricket.generators

Source

spheres-3d.lisp (file)

Function: strengthen SOURCE STRENGTH &key BIAS

Construct a sampler that, when sampled, modifies the output value of ‘source‘ by multiplying it by ‘strength‘, and optionally adding ‘bias‘ afterwards.

‘source‘: The input sampler (required).

‘strength‘: A multiplier to apply to the output of ‘source‘ (required).

‘bias‘: An additional bias amount to add to the result (optional, default: 0.0).

Package

%cricket.modifiers

Source

strengthen.lisp (file)

Function: terrace SOURCE &key POINTS INVERT-P

Construct a sampler that, when sampled, maps the output of its input sampler onto a terrace-forming curve, defined by the list of ‘points‘. ‘points‘ is a list of at least 2 real numbers, each with a unique value.

‘source‘: The input sampler (required).

‘points‘: A list of at least two control points that define the curve (required).

‘invert-p‘: Whether the curve is inverted between the control points (optional, default: nil).

Package

%cricket.modifiers

Source

terrace.lisp (file)

Function: translate SOURCE &key X Y Z W

Construct a sampler that, when sampled, offsets the input coordinates of ‘source‘ by the amounts supplied each of the ‘x‘, ‘y‘, ‘z‘, and ‘w‘ axes, before sampling from it.

‘source‘: The input sampler (required).

‘x‘: The amount to offset along the X axis (optional, default: 0.0).

‘y‘: The amount to offset along the Y axis (optional, default: 0.0).

‘z‘: The amount to offset along the Z axis (optional, default: 0.0).

‘w‘: The amount to offset along the W axis (optional, default: 0.0).

Package

%cricket.modifiers

Source

translate.lisp (file)

Function: turbulence SOURCE DISPLACEMENT &key FREQUENCY POWER ROUGHNESS

Construct a sampler that, when sampled, displaces the input coordinates of its ‘source‘ input sampler before sampling from it. The displacement values come from the result of sampling a fractional Brownian motion application of the supplied ‘displacement‘ sampler, along with randomly generated values retrieved using the random number generator of ‘source‘.

‘source‘: The input sampler whose input coordinates are displaced (required).

‘displacement‘: A sampler that has ‘roughness‘ octaves of fractional Brownian motion applied to it to determine the random displacement (required).

‘frequency‘: The frequency of the fractional Brownian motion displacement (optional, default 1.0).

‘power‘: A scaling factor that is applied to the displacement amount (optional, default: 1.0).

‘roughness‘: The number of octaves to apply for the displacement fractional Brownian motion (optional, default: 3).

Package

%cricket.modifiers

Source

turbulence.lisp (file)

Function: uniform-scale SOURCE SCALAR
Package

%cricket.modifiers

Source

scale.lisp (file)

Function: value-2d &key SEED

Construct a sampler that, when sampled, outputs 2-dimensional value noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

value-2d.lisp (file)

Function: value-3d &key SEED

Construct a sampler that, when sampled, outputs 3-dimensional value noise values ranging from -1.0 to 1.0.

‘seed‘: A string used to seed the random number generator for this sampler, or NIL. If a seed is not supplied, one will be generated automatically which will negatively affect the reproducibility of the noise (optional, default: NIL).

Package

%cricket.generators

Source

value-3d.lisp (file)

Function: write-image IMAGE FILE-PATH
Package

%cricket.map

Source

image.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Generic functions

Generic Function: sample SAMPLER X &optional Y Z W
Package

%cricket.internal

Source

common.lisp (file)

Methods
Method: sample (SAMPLER turbulence) X &optional Y Z W
Source

turbulence.lisp (file)

Method: sample (SAMPLER translate) X &optional Y Z W
Source

translate.lisp (file)

Method: sample (SAMPLER terrace) X &optional Y Z W
Source

terrace.lisp (file)

Method: sample (SAMPLER -) X &optional Y Z W
Source

subtract.lisp (file)

Method: sample (SAMPLER strengthen) X &optional Y Z W
Source

strengthen.lisp (file)

Method: sample (SAMPLER select) X &optional Y Z W
Source

select.lisp (file)

Method: sample (SAMPLER scale) X &optional Y Z W
Source

scale.lisp (file)

Method: sample (SAMPLER rotate) X &optional Y Z W
Source

rotate.lisp (file)

Method: sample (SAMPLER power) X &optional Y Z W
Source

power.lisp (file)

Method: sample (SAMPLER *) X &optional Y Z W
Source

multiply.lisp (file)

Method: sample (SAMPLER negate) X &optional Y Z W
Source

negate.lisp (file)

Method: sample (SAMPLER min) X &optional Y Z W
Source

min.lisp (file)

Method: sample (SAMPLER max) X &optional Y Z W
Source

max.lisp (file)

Method: sample (SAMPLER expt) X &optional Y Z W
Source

expt.lisp (file)

Method: sample (SAMPLER /) X &optional Y Z W
Source

divide.lisp (file)

Method: sample (SAMPLER displace) X &optional Y Z W
Source

displace.lisp (file)

Method: sample (SAMPLER curve) X &optional Y Z W
Source

curve.lisp (file)

Method: sample (SAMPLER clamp) X &optional Y Z W
Source

clamp.lisp (file)

Method: sample (SAMPLER cache) X &optional Y Z W
Source

cache.lisp (file)

Method: sample (SAMPLER blend) X &optional Y Z W
Source

blend.lisp (file)

Method: sample (SAMPLER +) X &optional Y Z W
Source

add.lisp (file)

Method: sample (SAMPLER abs) X &optional Y Z W
Source

abs.lisp (file)

Method: sample (SAMPLER ridged-multifractal-4d) X &optional Y Z W
Source

ridged-multifractal-4d.lisp (file)

Method: sample (SAMPLER ridged-multifractal-3d) X &optional Y Z W
Source

ridged-multifractal-3d.lisp (file)

Method: sample (SAMPLER ridged-multifractal-2d) X &optional Y Z W
Source

ridged-multifractal-2d.lisp (file)

Method: sample (SAMPLER hybrid-multifractal-4d) X &optional Y Z W
Source

hybrid-multifractal-4d.lisp (file)

Method: sample (SAMPLER hybrid-multifractal-3d) X &optional Y Z W
Source

hybrid-multifractal-3d.lisp (file)

Method: sample (SAMPLER hybrid-multifractal-2d) X &optional Y Z W
Source

hybrid-multifractal-2d.lisp (file)

Method: sample (SAMPLER multifractal-4d) X &optional Y Z W
Source

multifractal-4d.lisp (file)

Method: sample (SAMPLER multifractal-3d) X &optional Y Z W
Source

multifractal-3d.lisp (file)

Method: sample (SAMPLER multifractal-2d) X &optional Y Z W
Source

multifractal-2d.lisp (file)

Method: sample (SAMPLER billow-4d) X &optional Y Z W
Source

billow-4d.lisp (file)

Method: sample (SAMPLER billow-3d) X &optional Y Z W
Source

billow-3d.lisp (file)

Method: sample (SAMPLER billow-2d) X &optional Y Z W
Source

billow-2d.lisp (file)

Method: sample (SAMPLER fbm-4d) X &optional Y Z W
Source

fbm-4d.lisp (file)

Method: sample (SAMPLER fbm-3d) X &optional Y Z W
Source

fbm-3d.lisp (file)

Method: sample (SAMPLER fbm-2d) X &optional Y Z W
Source

fbm-2d.lisp (file)

Method: sample (SAMPLER constant) X &optional Y Z W
Source

constant.lisp (file)

Method: sample (SAMPLER checker-2d) X &optional Y Z W
Source

checker-2d.lisp (file)

Method: sample (SAMPLER spheres-3d) X &optional Y Z W
Source

spheres-3d.lisp (file)

Method: sample (SAMPLER cylinders-3d) X &optional Y Z W
Source

cylinders-3d.lisp (file)

Method: sample (SAMPLER cellular-3d) X &optional Y Z W
Source

cellular-3d.lisp (file)

Method: sample (SAMPLER cellular-2d) X &optional Y Z W
Source

cellular-2d.lisp (file)

Method: sample (SAMPLER value-3d) X &optional Y Z W
Source

value-3d.lisp (file)

Method: sample (SAMPLER value-2d) X &optional Y Z W
Source

value-2d.lisp (file)

Method: sample (SAMPLER open-simplex2s-4d) X &optional Y Z W
Source

open-simplex2s-4d.lisp (file)

Method: sample (SAMPLER open-simplex2s-3d) X &optional Y Z W
Source

open-simplex2s-3d.lisp (file)

Method: sample (SAMPLER open-simplex2s-2d) X &optional Y Z W
Source

open-simplex2s-2d.lisp (file)

Method: sample (SAMPLER open-simplex2f-4d) X &optional Y Z W
Source

open-simplex2f-4d.lisp (file)

Method: sample (SAMPLER open-simplex2f-3d) X &optional Y Z W
Source

open-simplex2f-3d.lisp (file)

Method: sample (SAMPLER open-simplex2f-2d) X &optional Y Z W
Source

open-simplex2f-2d.lisp (file)

Method: sample (SAMPLER open-simplex-4d) X &optional Y Z W
Source

open-simplex-4d.lisp (file)

Method: sample (SAMPLER open-simplex-3d) X &optional Y Z W
Source

open-simplex-3d.lisp (file)

Method: sample (SAMPLER open-simplex-2d) X &optional Y Z W
Source

open-simplex-2d.lisp (file)

Method: sample (SAMPLER simplex-4d) X &optional Y Z W
Source

simplex-4d.lisp (file)

Method: sample (SAMPLER simplex-3d) X &optional Y Z W
Source

simplex-3d.lisp (file)

Method: sample (SAMPLER simplex-2d) X &optional Y Z W
Source

simplex-2d.lisp (file)

Method: sample (SAMPLER simplex-1d) X &optional Y Z W
Source

simplex-1d.lisp (file)

Method: sample (SAMPLER perlin-4d) X &optional Y Z W
Source

perlin-4d.lisp (file)

Method: sample (SAMPLER perlin-3d) X &optional Y Z W
Source

perlin-3d.lisp (file)

Method: sample (SAMPLER perlin-2d) X &optional Y Z W
Source

perlin-2d.lisp (file)

Method: sample (SAMPLER perlin-1d) X &optional Y Z W
Source

perlin-1d.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Conditions

Condition: cricket-error ()
Package

%cricket.internal

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods

sampler-type (method)

Direct slots
Slot: %sampler-type
Initargs

:sampler-type

Readers

sampler-type (generic function)

Condition: invalid-cellular-distance-method ()
Package

%cricket.internal

Source

conditions.lisp (file)

Direct superclasses

cricket-error (condition)

Direct methods
Direct slots
Slot: %distance-method
Initargs

:distance-method

Readers

distance-method (generic function)

Slot: %valid-distance-methods
Initargs

:valid-distance-methods

Readers

valid-distance-methods (generic function)

Condition: invalid-cellular-output-type ()
Package

%cricket.internal

Source

conditions.lisp (file)

Direct superclasses

cricket-error (condition)

Direct methods
Direct slots
Slot: %output-type
Initargs

:output-type

Readers

output-type (generic function)

Slot: %valid-output-types
Initargs

:valid-output-types

Readers

valid-output-types (generic function)

Condition: invalid-fractal-octave-count ()
Package

%cricket.internal

Source

conditions.lisp (file)

Direct superclasses

cricket-error (condition)

Direct methods

value (method)

Direct slots
Slot: %value
Initargs

:value

Readers

value (generic function)

Condition: invalid-open-simplex2-orientation ()
Package

%cricket.internal

Source

conditions.lisp (file)

Direct superclasses

cricket-error (condition)

Direct methods
Direct slots
Slot: %orientation
Initargs

:orientation

Readers

orientation (generic function)

Slot: %valid-orientations
Initargs

:valid-orientations

Readers

valid-orientations (generic function)

Condition: invalid-real-argument ()
Package

%cricket.internal

Source

conditions.lisp (file)

Direct superclasses

cricket-error (condition)

Direct methods
Direct slots
Slot: %argument
Initargs

:argument

Readers

argument (generic function)

Slot: %value
Initargs

:value

Readers

value (generic function)

Condition: invalid-sampler-argument ()
Package

%cricket.internal

Source

conditions.lisp (file)

Direct superclasses

cricket-error (condition)

Direct methods
Direct slots
Slot: %argument
Initargs

:argument

Readers

argument (generic function)

Slot: %value
Initargs

:value

Readers

value (generic function)

Condition: invalid-seed ()
Package

%cricket.internal

Source

conditions.lisp (file)

Direct superclasses

cricket-error (condition)

Direct methods

seed (method)

Direct slots
Slot: %seed
Initargs

:seed

Readers

seed (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.5 Structures

Structure: * ()
Package

%cricket.modifiers

Source

multiply.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source1
Type

%cricket.internal:sampler

Readers

source1 (function)

Writers

(setf source1) (function)

Slot: source2
Type

%cricket.internal:sampler

Readers

source2 (function)

Writers

(setf source2) (function)

Structure: + ()
Package

%cricket.modifiers

Source

add.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source1
Type

%cricket.internal:sampler

Readers

source1 (function)

Writers

(setf source1) (function)

Slot: source2
Type

%cricket.internal:sampler

Readers

source2 (function)

Writers

(setf source2) (function)

Structure: - ()
Package

%cricket.modifiers

Source

subtract.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source1
Type

%cricket.internal:sampler

Readers

source1 (function)

Writers

(setf source1) (function)

Slot: source2
Type

%cricket.internal:sampler

Readers

source2 (function)

Writers

(setf source2) (function)

Structure: / ()
Package

%cricket.modifiers

Source

divide.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source1
Type

%cricket.internal:sampler

Readers

source1 (function)

Writers

(setf source1) (function)

Slot: source2
Type

%cricket.internal:sampler

Readers

source2 (function)

Writers

(setf source2) (function)

Structure: abs ()
Package

%cricket.modifiers

Source

abs.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source
Type

%cricket.internal:sampler

Readers

source (function)

Writers

(setf source) (function)

Structure: billow-2d ()
Package

%cricket.generators

Source

billow-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.5

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: billow-3d ()
Package

%cricket.generators

Source

billow-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.5

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: billow-4d ()
Package

%cricket.generators

Source

billow-4d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.5

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: blend ()
Package

%cricket.modifiers

Source

blend.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source1
Type

%cricket.internal:sampler

Readers

source1 (function)

Writers

(setf source1) (function)

Slot: source2
Type

%cricket.internal:sampler

Readers

source2 (function)

Writers

(setf source2) (function)

Slot: control
Type

%cricket.internal:sampler

Readers

control (function)

Writers

(setf control) (function)

Structure: cache ()
Package

%cricket.modifiers

Source

cache.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source
Type

%cricket.internal:sampler

Readers

source (function)

Writers

(setf source) (function)

Slot: cached-p
Type

boolean

Readers

cached-p (function)

Writers

(setf cached-p) (function)

Slot: value
Type

golden-utils:f32

Initform

0.0

Readers

value (function)

Writers

(setf value) (function)

Slot: x
Type

golden-utils:f64

Initform

0.0d0

Readers

x (function)

Writers

(setf x) (function)

Slot: y
Type

golden-utils:f64

Initform

0.0d0

Readers

y (function)

Writers

(setf y) (function)

Slot: z
Type

golden-utils:f64

Initform

0.0d0

Readers

z (function)

Writers

(setf z) (function)

Slot: w
Type

golden-utils:f64

Initform

0.0d0

Readers

w (function)

Writers

(setf w) (function)

Structure: cellular-2d ()
Package

%cricket.generators

Source

cellular-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: seed
Type

golden-utils:ub32

Initform

0

Readers

seed (function)

Writers

(setf seed) (function)

Slot: distance-method
Type

(member :manhattan :euclidean :euclidean-squared :chebyshev :minkowski4)

Initform

:euclidean

Readers

distance-method (function)

Writers

(setf distance-method) (function)

Slot: output-type
Type

(member :value :f1 :f2 :f1+f2 :f2-f1 :f1*f2 :f1/f2)

Initform

:f1

Readers

output-type (function)

Writers

(setf output-type) (function)

Slot: jitter
Type

golden-utils:f64

Initform

1.0d0

Readers

jitter (function)

Writers

(setf jitter) (function)

Structure: cellular-3d ()
Package

%cricket.generators

Source

cellular-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: seed
Type

golden-utils:ub32

Initform

0

Readers

seed (function)

Writers

(setf seed) (function)

Slot: distance-method
Type

(member :manhattan :euclidean :euclidean-squared :chebyshev :minkowski4)

Initform

:euclidean

Readers

distance-method (function)

Writers

(setf distance-method) (function)

Slot: output-type
Type

(member :value :f1 :f2 :f1+f2 :f2-f1 :f1*f2 :f1/f2)

Initform

:f1

Readers

output-type (function)

Writers

(setf output-type) (function)

Slot: jitter
Type

golden-utils:f64

Initform

1.0d0

Readers

jitter (function)

Writers

(setf jitter) (function)

Structure: checker-2d ()
Package

%cricket.generators

Source

checker-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Structure: clamp ()
Package

%cricket.modifiers

Source

clamp.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source
Type

%cricket.internal:sampler

Readers

source (function)

Writers

(setf source) (function)

Slot: min
Type

golden-utils:f32

Initform

-1.0

Readers

min (function)

Writers

(setf min) (function)

Slot: max
Type

golden-utils:f32

Initform

1.0

Readers

max (function)

Writers

(setf max) (function)

Structure: constant ()
Package

%cricket.generators

Source

constant.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: value
Type

golden-utils:f32

Initform

0.5

Readers

value (function)

Writers

(setf value) (function)

Structure: curve ()
Package

%cricket.modifiers

Source

curve.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source
Type

%cricket.internal:sampler

Readers

source (function)

Writers

(setf source) (function)

Slot: control-points
Type

simple-vector

Initform

(make-array 0)

Readers

control-points (function)

Writers

(setf control-points) (function)

Structure: cylinders-3d ()
Package

%cricket.generators

Source

cylinders-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: frequency
Type

golden-utils:f64

Initform

1.0d0

Readers

frequency (function)

Writers

(setf frequency) (function)

Structure: displace ()
Package

%cricket.modifiers

Source

displace.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source
Type

%cricket.internal:sampler

Readers

source (function)

Writers

(setf source) (function)

Slot: x
Type

(or %cricket.internal:sampler null)

Readers

x (function)

Writers

(setf x) (function)

Slot: y
Type

(or %cricket.internal:sampler null)

Readers

y (function)

Writers

(setf y) (function)

Slot: z
Type

(or %cricket.internal:sampler null)

Readers

z (function)

Writers

(setf z) (function)

Slot: w
Type

(or %cricket.internal:sampler null)

Readers

w (function)

Writers

(setf w) (function)

Structure: expt ()
Package

%cricket.modifiers

Source

expt.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source
Type

%cricket.internal:sampler

Readers

source (function)

Writers

(setf source) (function)

Slot: power
Type

golden-utils:f32

Initform

1.0

Readers

power (function)

Writers

(setf power) (function)

Structure: fbm-2d ()
Package

%cricket.generators

Source

fbm-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.5

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: fbm-3d ()
Package

%cricket.generators

Source

fbm-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.5

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: fbm-4d ()
Package

%cricket.generators

Source

fbm-4d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.5

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: hybrid-multifractal-2d ()
Package

%cricket.generators

Source

hybrid-multifractal-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.25

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: hybrid-multifractal-3d ()
Package

%cricket.generators

Source

hybrid-multifractal-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.25

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: hybrid-multifractal-4d ()
Package

%cricket.generators

Source

hybrid-multifractal-4d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.25

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: image ()
Package

%cricket.map

Source

image.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: width
Type

golden-utils:ub32

Initform

0

Readers

image-width (function)

Writers

(setf image-width) (function)

Slot: height
Type

golden-utils:ub32

Initform

0

Readers

image-height (function)

Writers

(setf image-height) (function)

Slot: data
Type

simple-vector

Initform

(make-array 0)

Readers

image-data (function)

Writers

(setf image-data) (function)

Structure: map ()
Package

%cricket.map

Source

map.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: width
Type

golden-utils:ub24

Initform

512

Readers

map-width (function)

Writers

(setf map-width) (function)

Slot: height
Type

golden-utils:ub24

Initform

512

Readers

map-height (function)

Writers

(setf map-height) (function)

Slot: data
Type

golden-utils:f32a

Initform

(golden-utils:make-f32-array 0)

Readers

map-data (function)

Writers

(setf map-data) (function)

Structure: max ()
Package

%cricket.modifiers

Source

max.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source1
Type

%cricket.internal:sampler

Readers

source1 (function)

Writers

(setf source1) (function)

Slot: source2
Type

%cricket.internal:sampler

Readers

source2 (function)

Writers

(setf source2) (function)

Structure: min ()
Package

%cricket.modifiers

Source

min.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source1
Type

%cricket.internal:sampler

Readers

source1 (function)

Writers

(setf source1) (function)

Slot: source2
Type

%cricket.internal:sampler

Readers

source2 (function)

Writers

(setf source2) (function)

Structure: multifractal-2d ()
Package

%cricket.generators

Source

multifractal-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.5

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: multifractal-3d ()
Package

%cricket.generators

Source

multifractal-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.5

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: multifractal-4d ()
Package

%cricket.generators

Source

multifractal-4d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

0.5

Readers

persistence (function)

Writers

(setf persistence) (function)

Structure: negate ()
Package

%cricket.modifiers

Source

negate.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source
Type

%cricket.internal:sampler

Readers

source (function)

Writers

(setf source) (function)

Structure: open-simplex-2d ()
Package

%cricket.generators

Source

open-simplex-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: table
Type

(golden-utils:ub8a 512)

Readers

table (function)

Writers

(setf table) (function)

Structure: open-simplex-3d ()
Package

%cricket.generators

Source

open-simplex-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: table
Type

(golden-utils:ub8a 256)

Initform

%cricket.generators.open-simplex-3d::+permutation+

Readers

table (function)

Writers

(setf table) (function)

Structure: open-simplex-4d ()
Package

%cricket.generators

Source

open-simplex-4d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: table
Type

(golden-utils:ub8a 512)

Readers

table (function)

Writers

(setf table) (function)

Structure: open-simplex2f-2d ()
Package

%cricket.generators

Source

open-simplex2f-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: gradients
Type

(golden-utils:f64a 4096)

Initform

(golden-utils:make-f64-array 4096)

Readers

gradients (function)

Writers

(setf gradients) (function)

Slot: table
Type

(golden-utils:b16a 2048)

Initform

(golden-utils:make-b16-array 2048)

Readers

table (function)

Writers

(setf table) (function)

Slot: orientation
Type

(member :standard :x/y)

Initform

:standard

Readers

orientation (function)

Writers

(setf orientation) (function)

Structure: open-simplex2f-3d ()
Package

%cricket.generators

Source

open-simplex2f-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: gradients
Type

(golden-utils:f64a 6144)

Initform

(golden-utils:make-f64-array 6144)

Readers

gradients (function)

Writers

(setf gradients) (function)

Slot: table
Type

(golden-utils:b16a 2048)

Initform

(golden-utils:make-b16-array 2048)

Readers

table (function)

Writers

(setf table) (function)

Slot: orientation
Type

(member :standard :xy/z :xz/y)

Initform

:standard

Readers

orientation (function)

Writers

(setf orientation) (function)

Structure: open-simplex2f-4d ()
Package

%cricket.generators

Source

open-simplex2f-4d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: gradients
Type

(golden-utils:f64a 8192)

Initform

(golden-utils:make-f64-array 8192)

Readers

gradients (function)

Writers

(setf gradients) (function)

Slot: table
Type

(golden-utils:b16a 2048)

Initform

(golden-utils:make-b16-array 2048)

Readers

table (function)

Writers

(setf table) (function)

Slot: orientation
Type

(member :standard :xy/zw :xz/yw :xyz/w)

Initform

:standard

Readers

orientation (function)

Writers

(setf orientation) (function)

Structure: open-simplex2s-2d ()
Package

%cricket.generators

Source

open-simplex2s-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: gradients
Type

(golden-utils:f64a 4096)

Initform

(golden-utils:make-f64-array 4096)

Readers

gradients (function)

Writers

(setf gradients) (function)

Slot: table
Type

(golden-utils:b16a 2048)

Initform

(golden-utils:make-b16-array 2048)

Readers

table (function)

Writers

(setf table) (function)

Slot: orientation
Type

(member :standard :x/y)

Initform

:standard

Readers

orientation (function)

Writers

(setf orientation) (function)

Structure: open-simplex2s-3d ()
Package

%cricket.generators

Source

open-simplex2s-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: gradients
Type

(golden-utils:f64a 6144)

Initform

(golden-utils:make-f64-array 6144)

Readers

gradients (function)

Writers

(setf gradients) (function)

Slot: table
Type

(golden-utils:b16a 2048)

Initform

(golden-utils:make-b16-array 2048)

Readers

table (function)

Writers

(setf table) (function)

Slot: orientation
Type

(member :standard :xy/z :xz/y)

Initform

:standard

Readers

orientation (function)

Writers

(setf orientation) (function)

Structure: open-simplex2s-4d ()
Package

%cricket.generators

Source

open-simplex2s-4d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: gradients
Type

(golden-utils:f64a 8192)

Initform

(golden-utils:make-f64-array 8192)

Readers

gradients (function)

Writers

(setf gradients) (function)

Slot: table
Type

(golden-utils:b16a 2048)

Initform

(golden-utils:make-b16-array 2048)

Readers

table (function)

Writers

(setf table) (function)

Slot: orientation
Type

(member :standard :xy/zw :xz/yw :xyz/w)

Initform

:standard

Readers

orientation (function)

Writers

(setf orientation) (function)

Structure: perlin-1d ()
Package

%cricket.generators

Source

perlin-1d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: table
Type

(golden-utils:ub8a 512)

Readers

table (function)

Writers

(setf table) (function)

Structure: perlin-2d ()
Package

%cricket.generators

Source

perlin-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: table
Type

(golden-utils:ub8a 512)

Readers

table (function)

Writers

(setf table) (function)

Structure: perlin-3d ()
Package

%cricket.generators

Source

perlin-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: table
Type

(golden-utils:ub8a 512)

Readers

table (function)

Writers

(setf table) (function)

Structure: perlin-4d ()
Package

%cricket.generators

Source

perlin-4d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: table
Type

(golden-utils:ub8a 512)

Readers

table (function)

Writers

(setf table) (function)

Structure: power ()
Package

%cricket.modifiers

Source

power.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source1
Type

%cricket.internal:sampler

Readers

source1 (function)

Writers

(setf source1) (function)

Slot: source2
Type

%cricket.internal:sampler

Readers

source2 (function)

Writers

(setf source2) (function)

Structure: ridged-multifractal-2d ()
Package

%cricket.generators

Source

ridged-multifractal-2d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

1.0

Readers

persistence (function)

Writers

(setf persistence) (function)

Slot: attenuation
Type

golden-utils:f32

Initform

2.0

Readers

attenuation (function)

Writers

(setf attenuation) (function)

Structure: ridged-multifractal-3d ()
Package

%cricket.generators

Source

ridged-multifractal-3d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

1.0

Readers

persistence (function)

Writers

(setf persistence) (function)

Slot: attenuation
Type

golden-utils:f32

Initform

2.0

Readers

attenuation (function)

Writers

(setf attenuation) (function)

Structure: ridged-multifractal-4d ()
Package

%cricket.generators

Source

ridged-multifractal-4d.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: sources
Type

simple-vector

Initform

(vector)

Readers

sources (function)

Writers

(setf sources) (function)

Slot: scale
Type

golden-utils:f32

Initform

1.0

Readers

scale (function)

Writers

(setf scale) (function)

Slot: octaves
Type

(integer 1 32)

Initform

4

Readers

octaves (function)

Writers

(setf octaves) (function)

Slot: frequency
Type

golden-utils:f32

Initform

1.0

Readers

frequency (function)

Writers

(setf frequency) (function)

Slot: lacunarity
Type

golden-utils:f32

Initform

2.0

Readers

lacunarity (function)

Writers

(setf lacunarity) (function)

Slot: persistence
Type

golden-utils:f32

Initform

1.0

Readers

persistence (function)

Writers

(setf persistence) (function)

Slot: attenuation
Type

golden-utils:f32

Initform

2.0

Readers

attenuation (function)

Writers

(setf attenuation) (function)

Structure: rotate ()
Package

%cricket.modifiers

Source

rotate.lisp (file)

Direct superclasses

sampler (structure)

Direct methods

sample (method)

Direct slots
Slot: source
Type

%cricket.internal:sampler

Readers

source (function)

Writers

(setf source) (function)

Slot: rx1
Type

golden-utils:f64

Initform

0.0d0

Readers

rx1 (function)

Writers

(setf rx1) (function)

Slot: rx2
Type

golden-utils:f64

Initform

0.0d0

Readers

rx2 (function)

Writers

(setf rx2) (function)

Slot: rx3
Type

golden-utils:f64

Initform

0.0d0

Readers

rx3 (function)

Writers

(setf rx3) (function)

Slot: ry1
Type

golden-utils:f64

Initform

0.0d0

Readers

ry1 (function)

Writers

(setf ry1) (function)

Slot: ry2
Type

golden-utils:f64

Initform

0.0d0

Readers

ry2 (function)

Writers

(setf ry2) (function)

Slot: ry3
Type

golden-utils:f64

Initform

0.0d0

Readers

ry3 (function)

Writers

(setf ry3) (function)

Slot: rz1
Type

golden-utils:f64

Initform

0.0d0

Readers

rz1 (function)

Writers

(setf rz1) (function)

Slot: rz2
Type

golden-utils:f64

Initform

0.0d0

Readers

rz2 (function)

Writers

(setf rz2) (function)

Slot: rz3
Type

golden-utils:f64

Initform

0.0d0

Readers

rz3 (function)

Writers

(setf rz3) (function)

Structure: sampler ()
Package

%cricket.internal

Source

common.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses