Merge pull request #118 from Keavon/rust-port

Rust port
Auburn · Oct 6, 2023 · 8facc71 · 8facc71
2 parents 7aefb5a + 334100c
commit 8facc71
Show file tree

Hide file tree

Showing 15 changed files with 3,054 additions and 18 deletions.
diff --git a/.gitignore b/.gitignore
@@ -23,6 +23,7 @@ nupkg/
 [Rr]elease/
 [Rr]eleases/
 [Pp]ublish/
+[Tt]arget/
 x64/
 x86/
 build/

diff --git a/C/FastNoiseLite.h b/C/FastNoiseLite.h
@@ -45,7 +45,7 @@
 //       ....',;;clodxkkOOOkkdolc:;,,,,,,,,'..........,;:clodxkO0KKXKK0Okxdolcc::;;,,,;;:codkO0XXNNNNXKK0OOOOOkkkkxxdoollloodxkO0KKKXXXXX
 //
 // VERSION: 1.0.1
-// https://github.com/Auburn/FastNoise
+// https://github.com/Auburn/FastNoiseLite
 
 // In *one* C or C++ file, use #define FNL_IMPL to generate implementation
 

diff --git a/CSharp/FastNoiseLite.cs b/CSharp/FastNoiseLite.cs
@@ -1,4 +1,4 @@
-// MIT License
+// MIT License
 //
 // Copyright(c) 2020 Jordan Peck ([email protected])
 // Copyright(c) 2020 Contributors
@@ -45,7 +45,7 @@
 //       ....',;;clodxkkOOOkkdolc:;,,,,,,,,'..........,;:clodxkO0KKXKK0Okxdolcc::;;,,,;;:codkO0XXNNNNXKK0OOOOOkkkkxxdoollloodxkO0KKKXXXXX
 //
 // VERSION: 1.0.1
-// https://github.com/Auburn/FastNoise
+// https://github.com/Auburn/FastNoiseLite
 
 using System;
 using System.Runtime.CompilerServices;

diff --git a/Cpp/FastNoiseLite.h b/Cpp/FastNoiseLite.h
@@ -45,7 +45,7 @@
 //       ....',;;clodxkkOOOkkdolc:;,,,,,,,,'..........,;:clodxkO0KKXKK0Okxdolcc::;;,,,;;:codkO0XXNNNNXKK0OOOOOkkkkxxdoollloodxkO0KKKXXXXX
 //
 // VERSION: 1.0.1
-// https://github.com/Auburn/FastNoise
+// https://github.com/Auburn/FastNoiseLite
 
 #ifndef FASTNOISELITE_H
 #define FASTNOISELITE_H

diff --git a/GLSL/FastNoiseLite.glsl b/GLSL/FastNoiseLite.glsl
@@ -45,7 +45,7 @@
 //       ....',;;clodxkkOOOkkdolc:;,,,,,,,,'..........,;:clodxkO0KKXKK0Okxdolcc::;;,,,;;:codkO0XXNNNNXKK0OOOOOkkkkxxdoollloodxkO0KKKXXXXX
 //
 // VERSION: 1.0.1
-// https://github.com/Auburn/FastNoise
+// https://github.com/Auburn/FastNoiseLite
 
 // Switch between using floats or doubles for input position
 #define FNLfloat float

diff --git a/Go/fastnoise.go b/Go/fastnoise.go
@@ -45,7 +45,7 @@
 //       ....',;;clodxkkOOOkkdolc:;,,,,,,,,'..........,;:clodxkO0KKXKK0Okxdolcc::;;,,,;;:codkO0XXNNNNXKK0OOOOOkkkkxxdoollloodxkO0KKKXXXXX
 //
 // VERSION: 1.0.1
-// https://github.com/Auburn/FastNoise
+// https://github.com/Auburn/FastNoiseLite
 
 package fastnoise
 

diff --git a/HLSL/FastNoiseLite.hlsl b/HLSL/FastNoiseLite.hlsl
@@ -45,7 +45,7 @@
 //       ....',;;clodxkkOOOkkdolc:;,,,,,,,,'..........,;:clodxkO0KKXKK0Okxdolcc::;;,,,;;:codkO0XXNNNNXKK0OOOOOkkkkxxdoollloodxkO0KKKXXXXX
 //
 // VERSION: 1.0.1
-// https://github.com/Auburn/FastNoise
+// https://github.com/Auburn/FastNoiseLite
 
 // Switch between using floats or doubles for input position
 typedef float FNLfloat;

diff --git a/Java/FastNoiseLite.java b/Java/FastNoiseLite.java
@@ -45,7 +45,7 @@
 //       ....',;;clodxkkOOOkkdolc:;,,,,,,,,'..........,;:clodxkO0KKXKK0Okxdolcc::;;,,,;;:codkO0XXNNNNXKK0OOOOOkkkkxxdoollloodxkO0KKKXXXXX
 //
 // VERSION: 1.0.1
-// https://github.com/Auburn/FastNoise
+// https://github.com/Auburn/FastNoiseLite
 
 // To switch between using floats or doubles for input position,
 // perform a file-wide replace on the following strings (including /*FNLfloat*/)

diff --git a/JavaScript/FastNoiseLite.js b/JavaScript/FastNoiseLite.js
@@ -49,8 +49,8 @@
 // https://www.npmjs.com/package/fastnoise-lite
 // https://discord.gg/SHVaVfV
 //
-// Ported to Javascript by storm (Patrick U):
-// Discord: storm#8888 (prefered) | Email: [email protected] | Github: stormy482 (https://github.com/stormy482)
+// Ported to JavaScript by storm (Patrick U):
+// Discord: storm#8888 (preferred) | Email: [email protected] | GitHub: stormy482 (https://github.com/stormy482)
 //
 
 

diff --git a/PreviewApp/FastNoiseLiteGUI.cs b/PreviewApp/FastNoiseLiteGUI.cs
@@ -377,7 +377,7 @@ public FastNoiseLiteGUI()
                 stack.Items.Add(new StackLayoutItem(save));
 
                 var github = new Button { Text = "GitHub" };
-                github.Click += (sender, e) => { Process.Start(new ProcessStartInfo("https://github.com/Auburn/FastNoise") { UseShellExecute = true }); };
+                github.Click += (sender, e) => { Process.Start(new ProcessStartInfo("https://github.com/Auburn/FastNoiseLite") { UseShellExecute = true }); };
                 stack.Items.Add(new StackLayoutItem(github));
 
                 controlPanel.Items.Add(stack);

diff --git a/README.md b/README.md
@@ -1,11 +1,10 @@
-[![discord](https://img.shields.io/discord/703636892901441577?style=flat-square&logo=discord "Discord")](https://discord.gg/SHVaVfV)
-[![npm](https://img.shields.io/npm/v/fastnoise-lite)](https://www.npmjs.com/package/fastnoise-lite)
+[![discord](https://img.shields.io/discord/703636892901441577?logo=discord "Discord")](https://discord.gg/SHVaVfV)
 
 # FastNoise Lite
 
 FastNoise Lite is an extremely portable open source noise generation library with a large selection of noise algorithms. This library focuses on high performance while avoiding platform/language specific features, allowing for easy ports to as many possible languages.
 
-This project is an evolution of the [original FastNoise](https://github.com/Auburn/FastNoise/tree/FastNoise-Legacy) library and shares the same goal: An easy to use library that can quickly be integrated into a project and provides performant modern noise generation. See a breakdown of changes from the transition to FastNoise Lite [here](https://github.com/Auburn/FastNoise/pull/49)
+This project is an evolution of the [original FastNoise](https://github.com/Auburn/FastNoiseLite/tree/FastNoise-Legacy) library and shares the same goal: An easy to use library that can quickly be integrated into a project and provides performant modern noise generation. See a breakdown of changes from the transition to FastNoise Lite [here](https://github.com/Auburn/FastNoiseLite/pull/49)
 
 If you are looking for a more extensive noise generation library consider using [FastNoise2](https://github.com/Auburn/FastNoise2). It provides large performance gains thanks to SIMD and uses a node graph structure to allow complex noise configurations with lots of flexibility.
 
@@ -28,11 +27,14 @@ If you are looking for a more extensive noise generation library consider using
 - [C#](/CSharp/)
 - [C++98](/Cpp/)
 - [C99](/C/)
-- [Java](/Java/)
-- [JavaScript](/JavaScript/)
 - [HLSL](/HLSL/)
 - [GLSL](/GLSL/)
 - [Go](/Go/)
+- [Java](/Java/)
+- [JavaScript](/JavaScript/)  
+  [![npm](https://img.shields.io/npm/v/fastnoise-lite?logo=npm "npm")](https://www.npmjs.com/package/fastnoise-lite)
+- [Rust](/Rust/)  
+  [![crates.io](https://img.shields.io/crates/v/fastnoise-lite?logo=rust "crates.io")](https://crates.io/crates/fastnoise-lite)
 
 ### [Getting Started](https://github.com/Auburn/FastNoiseLite/wiki#getting-started)
 ### [Documentation](https://github.com/Auburn/FastNoiseLite/wiki/Documentation)
@@ -72,12 +74,13 @@ Million points of noise generated per second (higher = better)
 ## Credits:
 
 - [OpenSimplex2](https://github.com/KdotJPG/OpenSimplex2) for the OpenSimplex2 noise algorithm
-- [@KdotJPG](https://github.com/KdotJPG) for implementing all the OpenSimplex alogrithms and the Java port
+- [@KdotJPG](https://github.com/KdotJPG) for implementing all the OpenSimplex algorithms and the Java port
 - [CubicNoise](https://github.com/jobtalle/CubicNoise) for the Value (Cubic) noise algorithm
 - [@Rover656](https://github.com/Rover656) for creating the preview GUI and porting FastNoise Lite to C and HLSL.
-- [@Stormy482](https://github.com/stormy482) for creating the Javascript port.
+- [@Stormy482](https://github.com/stormy482) for creating the JavaScript port.
 - [@dotlogix](https://github.com/dotlogix) for creating the GLSL port.
 - [@ForeverZer0](https://github.com/ForeverZer0) for creating the Go port.
+- [@Keavon](https://github.com/stormy482) for creating the Rust port.
 
 # Examples
 

diff --git a/Rust/Cargo.lock b/Rust/Cargo.lock
diff --git a/Rust/Cargo.toml b/Rust/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "fastnoise-lite"
+version = "1.0.1"
+edition = "2021"
+license = "MIT"
+description = "FastNoiseLite Lite is an extremely portable open source noise generation library with a large selection of noise algorithms"
+repository = "https://github.com/Auburn/FastNoiseLite"
+readme = "README.md"
+authors = ["Jordan Peck", "Keavon Chambers"]
+
+[features]
+f64 = []
diff --git a/Rust/README.md b/Rust/README.md
@@ -0,0 +1,50 @@
+[crates.io](https://crates.io/crates/fastnoise-lite) • [docs.rs](https://docs.rs/fastnoise-lite/latest/bezier_rs/) • [repo](https://github.com/GraphiteEditor/Graphite/tree/master/libraries/fastnoise-lite)
+
+# FastNoise Lite
+
+FastNoise Lite is an extremely portable open source noise generation library with a large selection of noise algorithms. This library focuses on high performance while avoiding platform/language specific features, allowing for easy ports to as many possible languages.
+
+## Features
+
+- 2D & 3D
+- OpenSimplex2 Noise
+- OpenSimplex2S Noise
+- Cellular (Voronoi) Noise
+- Perlin Noise
+- Value Noise
+- Value Cubic Noise
+- OpenSimplex2-based Domain Warp
+- Basic Grid Gradient Domain Warp
+- Multiple fractal options for all of the above
+- Supports floats and/or doubles
+  - Switch from `f32` to `f64` position inputs with the `"f64"` feature flag in your `Cargo.toml`
+
+## Getting Started
+
+Below is an example for creating a 128x128 array of OpenSimplex2 noise.
+
+Additional documentation is available at [docs.rs](https://docs.rs/fastnoise-lite/latest/bezier_rs/) and the project's [Getting Started](https://github.com/Auburn/FastNoiseLite/wiki#getting-started) and [Documentation](https://github.com/Auburn/FastNoiseLite/wiki/Documentation) pages from its GitHub wiki.
+
+```rs
+use fastnoise_lite::*;
+
+// Create and configure FastNoise object
+let mut noise = FastNoiseLite::new();
+noise.SetNoiseType(NoiseType::OpenSimplex2);
+
+// Gather noise data
+const WIDTH: usize = 128;
+const HEIGHT: usize = 128;
+
+let mut noise_data = [0.; WIDTH * HEIGHT];
+
+for y in 0..HEIGHT {
+    for x in 0..WIDTH {
+        // Enable `features = ["f64"]` in Cargo.toml to pass f64 values here instead of f32.
+        // Use `noise.get_noise_3d(x, y, z)` for 3D noise instead of 2D.
+        noise_data[WIDTH * y + x] = noise.get_noise_2d(x as f32, y as f32);
+    }
+}
+
+// Do something with this data...
+```