noisex

defmodule Noisex.Noise do
  @moduledoc """
  Provide functions to work with different types of noises.

  This library provides Elixir bindings to the rust's [bracket-noise](https://crates.io/crates/bracket-noise)
  library, which is a rust port of [FastNoise](https://github.com/Auburn/FastNoiseLite).
  """

  alias Noisex.NIF
  alias Noisex.Options

  @typedoc """
  A reference to the noise generator. This is
  needed for most of the library functions.
  """
  @type noise_ref() :: reference()

  @typedoc """
  A noisemap object, represented by a list
  containing lists of floats (the noise values).
  """
  @type noisemap() :: [[float()]]

  @typedoc """
  A coordinate {x, y} in a cartesian plane.
  """
  @type coord() :: {integer(), integer()}

  @typedoc """
  A tuple containing width and height
  """
  @type size() :: {non_neg_integer(), non_neg_integer()}

  @typedoc """
  Options available when initializing the noise.
  """
  @type options() :: Options.t()

  @doc """
  Returns a new noise object.
  Use default noise options if options are not provided.
  """
  @spec new(options()) :: {atom, noise_ref()}
  def new(), do: NIF.new(%Options{})

  def new(options),
    do: NIF.new(options)

  @doc """
  Returns a 2D noise map from `start_point` to `end_point`
  """
  @spec chunk(noise_ref(), coord(), coord()) :: noisemap()
  def chunk(noise, start_point, end_point)

  def chunk(noise, {start_x, start_y}, {end_x, end_y}),
    do: NIF.chunk(noise, start_x, start_y, end_x, end_y)

  @doc """
  Returns the noise value for two given floats `f1` and `f2`.
  """
  @spec get_noise(noise_ref(), float(), float()) :: float()
  def get_noise(noise, f1, f2), do: NIF.get_noise(noise, f1, f2)

  @doc """
  Generates a 2D noise map of `size` and returns it.
  """
  @spec noise_map(reference(), size()) :: noisemap()
  def noise_map(noise, size)
  def noise_map(noise, {w, h}), do: NIF.noise_map(noise, w, h)
end