Skip to content
develop
Switch branches/tags
Code

Github Link CI Status Documentation Version MSRV


Noise-rs

Procedural Noise Generation library for Rust
Explore the docs »

Report Bug · Request Feature

[dependencies]
noise = "0.7"

About The Project

Noise-rs is a Rust library to generate smoothly varying noise for textural use and graphical display.

Noise generators are contained in NoiseFn modules, and can be combined to make very complex noise results.

Planetary Surface Example

planet surface image planet surface 4x planet surface 16x

Gradient Noise

Gradient noise produces a smooth, continuous value over space. It's achieved by dividing space into regions, placing a random gradient at each vertex, and then blending between those gradients.

Noise Functions

These are the actual noise functions, which just take a coordinate using get() and return a value. They can be chained together when declared, creating very complex noise results.

See the individual function pages for their descriptions, and the examples for their usage.

Usage

use noise::Fbm;
use noise::utils::PlaneMapBuilder;

fn main() {
  let fbm = Fbm::new();

  PlaneMapBuilder::new(&fbm)
          .set_size(1000, 1000)
          .set_x_bounds(-5.0, 5.0)
          .set_y_bounds(-5.0, 5.0)
          .build()
          .write_to_file("fbm.png");
}

FBM Noise

For more examples, refer to the Examples

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as below, without any additional terms or conditions.

License

Licensed under either of

at your option.

Contact

Project Link: https://github.com/razaekel/noise-rs