Noisex.Noise.new

You're seeing just the function new, go back to Noisex.Noise module for more information.

Returns a new noise reference using the default options.

iex> {:ok, _ref} = Noisex.Noise.new()

Specs

new(options()) :: {:ok, noise_ref()} | {:error, :unsupported_noise}

Returns a new noise reference using the provided options.

iex> {:ok, _ref} = Noisex.Noise.new(%Noisex.Options{seed: 100})

iex> {:error, :unsupported_noise} = Noisex.Noise.new(%Noisex.Options{noise_type: :foobar})