Ruby Perlin Noise C Module
Switch branches/tags
Clone or download
Pull request Compare This branch is 45 commits ahead, 1 commit behind boj:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bench
examples
ext/perlin
lib
spec
.gitignore
.ruby-version
CHANGELOG
Gemfile
LICENSE
README.md
Rakefile
perlin.gemspec

README.md

Perlin

A fast Perlin/Simplex noise generator. Implemented as a Ruby C extension, it is considerably faster than the pure Ruby equivalent, perlin_noise.

By default, the noise generated uses Perlin's Simplex functions, but can produce "Classic" Perlin noise (not recommended, since it is significantly slower).

If a large number of noise values are required, requesting chunks of values can be faster, which can then be iterated through at leisure (or use the block version of #chunk).

CREDITS

USE CASES

One use for this gem would be to generate "randomness" for games, such as building levels for a rogue-alike game.

If generating textures, it is advised to use a Simplex noise shader instead of this gem, since shaders are considerably faster than setting pixels, for example by using TexPlay. The issue is not so much that generating the noise is faster, but that setting individual pixel colours from Ruby is very slow. However, if graphics shaders are not available, then this could be used, but would be painfully slow for anything but tiny images.

INSTALL

$ gem install perlin

USAGE

require 'perlin'

# Takes values seed, persistence, and octaves
gen = Perlin::Generator.new 123, 1.0, 1

# Returns a 'height' value for 2 or 3-dimensional noise.
gen[10, 20]        #=> 0.0011919947855197324
gen[5, 22.2, 99.8] #=> 0.692631933498385

# Returns a 2D array of 'heights' for a range (x, y, size_x, size_y, interval)
noise = gen.chunk 1, 1, 2, 3, 1

noise[1][2] #=> 0.28406014362476045
p noise     #= > [[-0.9227624778765608, -0.0016387049134645594, -0.4764434188330739],
            #     [0.24490384926510073, -0.4764434188330739, 0.28406014362476045]]


# Returns a 3D array of 'heights' for a range (x, y, size_x, size_y, interval)
noise = gen.chunk 0, 0, 0, 2, 3, 4, 0.5
noise.size       #=> 2
noise[0].size    #=> 3
noise[0][0].size #=> 4
noise[1][2][3]   #=>  -0.1585322813268602

# Can run in "Classic" Perlin mode (Not recommended - SLOW!)

gen.classic = true
gen[10, 20]        #=> -0.19936732947826385