A 2D texture generator based on Perlin noise written in Go.
It comes with both CLI and GUI built in, but can also be used directly as a library. In this README you will find examples of how to use noise with each of these approaches.
git clone git@github.com:htaunay/noise.git
cd $GOPATH/github.com/htaunay/noise
# installs necessary Go dependencies
make installThe install script only takes care of dependencies in Go, however GLFW has different dependencies for each OS, read more about them here, or see this working example for Debian-like distributions here.
The noise package's interface is basically a single function that receives
the NoiseOptions struct and from it generates as an output a 2D matrix of
values varying from 0-255.
However, in order to use it properly, it is recommended to understand well how each of the parameters influences the pseudo-random texture generation.
Side of square texture length, in pixels
Period at which data is sampled. Think of it as way of defining how many variations (i.e tiles) of the noise will appear in a side of the texture, e.g. if the frequency is set to two, you would have 2x2 samples in the output.
This parameters accepts floats, and therefore if you give it a non-integer input, the trailing sampled data in each dimension will be capped accordingly.
Number of times that different noise functions - varying between each other based on the lacunarity and persistence values - will be added toguether.
If set to the minimum of 1, there will be a single layer, and therefore only the frequency and offsets will infleunce the generation of the texture.
Multiplier that determines how quickly the frequency increases for each successive octave.
The initial ratio starts at 1.0 for the first layer, add is multiplied by the lacunarity on each extra octave.
Determines how much influence should each successive octave have, quantitatively over the previous one.
Influence starts at 1.0 for the first layer, add is multiplied by the persistence on each extra octave.
Horizontal and vertical ratios for which the sample generation will be shifted.
The amount is based of the textures size, e.g. an offset of 1.0 means that a given axis will start exactly after the last pixel of sample generated with the default value of 0.
The x-axis shifts to the right, while the y-axis shifts downward.
Number of Go channels to be used during texture generation. What happens here is that all lines of a randomly generated texture are distributed equally between each channel, and therefore can be processed in parallel (within each hardware's limitation).
import "github.com/htaunay/noise"
opts := noise.NoiseOptions{
// example values
Size: 1024,
Octaves: 2,
Frequency: 16,
Lacunarity: 2.5,
Persistence: 0.75,
XOffset: 0,
YOffset: 0,
Channels: 1,
}
// returns [][]uint8 with values varying from 0-255
matrix := noise.Build(opts)If installation completed correctly, the CLI bin should be located in the Go's bin folder.
// In case you haven't added it to your $PATH
cd $GOPATH/bin
// Check out the options available
noise-cli --helpIf installation completed correctly, the GUI bin should be located in the Go's bin folder.
// In case you haven't added it to your $PATH
cd $GOPATH/bin
// Should open a window
noise-gui| Keys | Command | Shift modifier |
|---|---|---|
| ← and → arrows | Move X offset | none |
| ↑ and ↓ arrows | Move Y offset | none |
| Q key | Increase frequency | Decrease frequency |
| O key | Increase octaves | Decrease octaves |
| L key | Increase lacunarity | Decrease lacunarity |
| P key | Increase persistence | Decrease persistence |
| F key | Toggle filter | none |