Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

noise: add simplex noise #207

Merged
merged 11 commits into from
Aug 5, 2024
Merged

noise: add simplex noise #207

Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
dc7e687
noise: add simplex 2d implementation
PottierLoic Jul 3, 2024
cb9f649
noise: add simplex 1d/3d implementation
PottierLoic Jul 4, 2024
88a9e48
noise: add simplex 4d implementation
PottierLoic Jul 5, 2024
b0d2484
noise: fmt and clean
PottierLoic Jul 7, 2024
3f64daa
noise: rename `Perlin` struct to `Generator` and add tests for simple…
PottierLoic Jul 8, 2024
d6d226f
noise: add comments
PottierLoic Jul 13, 2024
c8f94bf
noise: examples
PottierLoic Jul 23, 2024
53c91c0
noise: add fractal noise example
PottierLoic Jul 23, 2024
4861581
noise: fmt
PottierLoic Jul 23, 2024
f918cdf
Update README.md
ulises-jeremias Aug 5, 2024
80d461c
Update README.md
ulises-jeremias Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
394 changes: 394 additions & 0 deletions noise/simplex.v
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,394 @@
module noise

import math

// skewing factors for 2d case
const f2 = 0.5 * (math.sqrt(3.0) - 1.0)
const g2 = (3.0 - math.sqrt(3)) / 6.0
// skewing factors for 3d case
const f3 = f64(1.0 / 3.0)
const g3 = f64(1.0 / 6.0)
// skewing factors for 4d case
const f4 = f64((math.sqrt(5.0) - 1.0) / 4)
const g4 = f64((5.0 - math.sqrt(5.0)) / 20.0)

// vfmt off
const simplex := [
PottierLoic marked this conversation as resolved.
Show resolved Hide resolved
[0, 1, 2, 3], [0, 1, 3, 2], [0, 0, 0, 0], [0, 2, 3, 1], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [1, 2, 3, 0],
[0, 2, 1, 3], [0, 0, 0, 0], [0, 3, 1, 2], [0, 3, 2, 1], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [1, 3, 2, 0],
[0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0],
[1, 2, 0, 3], [0, 0, 0, 0], [1, 3, 0, 2], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [2, 3, 0, 1], [2, 3, 1, 0],
[1, 0, 2, 3], [1, 0, 3, 2], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [2, 0, 3, 1], [0, 0, 0, 0], [2, 1, 3, 0],
[0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0],
[2, 0, 1, 3], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [3, 0, 1, 2], [3, 0, 2, 1], [0, 0, 0, 0], [3, 1, 2, 0],
[2, 1, 0, 3], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [3, 1, 0, 2], [0, 0, 0, 0], [3, 2, 0, 1], [3, 2, 1, 0]
]
// vfmt on

fn grad_1d(hash int, x f64) f64 {
h := hash & 15
mut grad := 1.0 + f64(h & 7)
grad = if h & 8 == 0 { grad } else { -grad }
return grad * x
}

fn grad_2d(hash int, x f64, y f64) f64 {
h := hash & 7
u := if h < 4 { x } else { y }
v := if h < 4 { y } else { x }
return (if h & 1 == 0 {
u
} else {
-u
}) + (if h & 2 == 0 {
2.0 * v
} else {
-2.0 * v
})
}

fn grad_3d(hash int, x f64, y f64, z f64) f64 {
h := hash & 15
u := if h < 8 { x } else { y }
v := if h < 4 {
y
} else {
if h == 12 || h == 14 { x } else { z }
}
return (if h & 1 == 0 {
u
} else {
-u
}) + (if h & 2 == 0 {
v
} else {
-v
})
}

fn grad_4d(hash int, x f64, y f64, z f64, t f64) f64 {
h := hash & 31
u := if h < 24 { x } else { y }
v := if h < 16 { y } else { z }
w := if h < 8 { z } else { t }
return (if h & 1 == 0 {
u
} else {
-u
}) + (if h & 2 == 0 {
v
} else {
-v
}) + (if h & 4 == 0 {
w
} else {
-w
})
}

pub fn simplex_1d(x f64) f64 {
i0 := int(x)
i1 := i0 + 1
x0 := x - i0
x1 := x0 - 1

mut t0 := 1.0 - x0 * x0
t0 *= t0
n0 := t0 * t0 * grad_1d(permutations[i0 & 0xff], x0)

mut t1 := 1.0 - x1 * x1
t1 *= t1
n1 := t1 * t1 * grad_1d(permutations[i1 & 0xff], x1)

// we scale it to [-1, 1]
return 0.395 * (n0 + n1)
}

pub fn simplex_2d(x f64, y f64) f64 {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Main Simplex Noise function is correct but can be improved.

The simplex_2d function correctly implements the 2D Simplex Noise algorithm. However, some improvements can be suggested for readability and performance.

Refactor suggestion: Use descriptive variable names.

Using more descriptive variable names can improve readability. For example, i1 and j1 could be renamed to offset_x and offset_y.

Refactor suggestion: Inline small calculations.

Inlining small calculations, such as f2 and g2, can improve performance by reducing the number of operations.

// skew the input space to determine which simplex cell we're in
s := (x + y) * noise.f2
i := int(x + s)
j := int(y + s)

// unskew the cell origin back to x, y space
t := f64(i + j) * noise.g2
// distances from the cell origin
x0 := x - (i - t)
y0 := y - (j - t)

i1, j1 := if x0 > y0 {
// lower triangle
1, 0
} else {
// upper triangle
0, 1
}

x1 := x0 - f64(i1) + noise.g2
y1 := y0 - f64(j1) + noise.g2
x2 := x0 - 1.0 + noise.g2 * 2.0
y2 := y0 - 1.0 + noise.g2 * 2.0

// avoid oob
ii := i & 0xff
jj := j & 0xff

// calculate the 3 corners
mut t0 := 0.5 - x0 * x0 - y0 * y0
mut n0 := 0.0
if t0 < 0 {
n0 = 0.0
} else {
t0 *= t0
n0 = t0 * t0 * grad_2d(permutations[ii + permutations[jj]], x0, y0)
}

mut t1 := 0.5 - x1 * x1 - y1 * y1
mut n1 := 0.0
if t1 < 0 {
n1 = 0.0
} else {
t1 *= t1
n1 = t1 * t1 * grad_2d(permutations[ii + i1 + permutations[jj + j1]], x1, y1)
}

mut t2 := 0.5 - x2 * x2 - y2 * y2
mut n2 := 0.0
if t2 < 0 {
n2 = 0.0
} else {
t2 *= t2
n2 = t2 * t2 * grad_2d(permutations[ii + 1 + permutations[jj + 1]], x2, y2)
}

// scale the return value to [-1, 1]
return 40.0 * (n0 + n1 + n2)
}

pub fn simplex_3d(x f64, y f64, z f64) f64 {
// skew the input space to determine which simplex cell we're in
s := (x + y + z) * noise.f3
xs := x + s
ys := y + s
zs := z + s
i := int(xs)
j := int(ys)
k := int(zs)

// unskew the cell origin back to x, y, z space
t := f64(i + j + k) * noise.g3
// distances from cell origin
x0 := x - (i - t)
y0 := y - (j - t)
z0 := z - (k - t)

mut i1 := 0
mut j1 := 0
mut k1 := 0
mut i2 := 0
mut j2 := 0
mut k2 := 0

if x0 >= y0 {
if y0 >= z0 {
i1 = 1
i2 = 1
j2 = 1
} else if x0 >= z0 {
i1 = 1
i2 = 1
k2 = 1
} else {
k1 = 1
i2 = 1
k2 = 1
}
} else {
if y0 < z0 {
k1 = 1
j2 = 1
k2 = 1
} else if x0 < z0 {
j1 = 1
j2 = 1
k2 = 1
} else {
j1 = 1
i2 = 1
j2 = 1
}
}

// offsets for corners in x, y, z coords
x1 := x0 - i1 + noise.g3
y1 := y0 - j1 + noise.g3
z1 := z0 - k1 + noise.g3
x2 := x0 - i2 + 2.0 * noise.g3
y2 := y0 - j2 + 2.0 * noise.g3
z2 := z0 - k2 + 2.0 * noise.g3
x3 := x0 - 1.0 + 3.0 * noise.g3
y3 := y0 - 1.0 + 3.0 * noise.g3
z3 := z0 - 1.0 + 3.0 * noise.g3

ii := i & 0xff
jj := j & 0xff
kk := k & 0xff

mut t0 := 0.6 - x0 * x0 - y0 * y0 - z0 * z0
mut n0 := 0.0
if t0 < 0 {
n0 = 0.0
} else {
t0 *= t0
n0 = t0 * t0 * grad_3d(permutations[ii + permutations[jj + permutations[kk]]],
x0, y0, z0)
}

mut t1 := 0.6 - x1 * x1 - y1 * y1 - z1 * z1
mut n1 := 0.0
if t1 < 0 {
n1 = 0.0
} else {
t1 *= t1
n1 = t1 * t1 * grad_3d(permutations[ii + i1 + permutations[jj + j1 + permutations[kk + k1]]],
x1, y1, z1)
}

mut t2 := 0.6 - x2 * x2 - y2 * y2 - z2 * z2
mut n2 := 0.0
if t2 < 0 {
n2 = 0.0
} else {
t2 *= t2
n2 = t2 * t2 * grad_3d(permutations[ii + i2 + permutations[jj + j2 + permutations[kk + k2]]],
x2, y2, z2)
}

mut t3 := 0.6 - x3 * x3 - y3 * y3 - z3 * z3
mut n3 := 0.0
if t3 < 0 {
n3 = 0.0
} else {
t3 *= t3
n3 = t3 * t3 * grad_3d(permutations[ii + 1 + permutations[jj + 1 + permutations[kk + 1]]],
x3, y3, z3)
}

// scale the return value to [-1, 1]
return 32.0 * (n0 + n1 + n2 + n3)
}

pub fn simplex_4d(x f64, y f64, z f64, w f64) f64 {
s := (x + y + z + w) * noise.f4
xs := x + s
ys := y + s
zs := z + s
ws := w + s
i := int(xs)
j := int(ys)
k := int(zs)
l := int(ws)

t := f64(i + j + k + l) * noise.g4
x0 := x - (i - t)
y0 := y - (j - t)
z0 := z - (k - t)
w0 := w - (l - t)

c1 := if x0 > y0 { 32 } else { 0 }
c2 := if x0 > z0 { 16 } else { 0 }
c3 := if y0 > z0 { 8 } else { 0 }
c4 := if x0 > w0 { 4 } else { 0 }
c5 := if y0 > w0 { 2 } else { 0 }
c6 := if z0 > w0 { 1 } else { 0 }
c := c1 + c2 + c3 + c4 + c5 + c6

i1 := if noise.simplex[c][0] >= 3 { 1 } else { 0 }
j1 := if noise.simplex[c][1] >= 3 { 1 } else { 0 }
k1 := if noise.simplex[c][2] >= 3 { 1 } else { 0 }
l1 := if noise.simplex[c][3] >= 3 { 1 } else { 0 }

i2 := if noise.simplex[c][0] >= 2 { 1 } else { 0 }
j2 := if noise.simplex[c][1] >= 2 { 1 } else { 0 }
k2 := if noise.simplex[c][2] >= 2 { 1 } else { 0 }
l2 := if noise.simplex[c][3] >= 2 { 1 } else { 0 }

i3 := if noise.simplex[c][0] >= 1 { 1 } else { 0 }
j3 := if noise.simplex[c][1] >= 1 { 1 } else { 0 }
k3 := if noise.simplex[c][2] >= 1 { 1 } else { 0 }
l3 := if noise.simplex[c][3] >= 1 { 1 } else { 0 }

x1 := x0 - i1 + noise.g4
y1 := y0 - j1 + noise.g4
z1 := z0 - k1 + noise.g4
w1 := w0 - l1 + noise.g4
x2 := x0 - i2 + 2.0 * noise.g4
y2 := y0 - j2 + 2.0 * noise.g4
z2 := z0 - k2 + 2.0 * noise.g4
w2 := w0 - l2 + 2.0 * noise.g4
x3 := x0 - i3 + 3.0 * noise.g4
y3 := y0 - j3 + 3.0 * noise.g4
z3 := z0 - k3 + 3.0 * noise.g4
w3 := w0 - l3 + 3.0 * noise.g4
x4 := x0 - 1.0 + 4.0 * noise.g4
y4 := y0 - 1.0 + 4.0 * noise.g4
z4 := z0 - 1.0 + 4.0 * noise.g4
w4 := w0 - 1.0 + 4.0 * noise.g4

ii := i & 0xff
jj := j & 0xff
kk := k & 0xff
ll := l & 0xff

mut t0 := 0.6 - x0 * x0 - y0 * y0 - z0 * z0 - w0 * w0
mut n0 := 0.0
if t0 < 0.0 {
n0 = 0.0
} else {
t0 *= t0
n0 = t0 * t0 * grad_4d(permutations[ii + permutations[jj + permutations[kk +
permutations[ll]]]], x0, y0, z0, w0)
}

mut t1 := 0.6 - x1 * x1 - y1 * y1 - z1 * z1 - w1 * w1
mut n1 := 0.0
if t1 < 0.0 {
n1 = 0.0
} else {
t1 *= t1
n1 = t1 * t1 * grad_4d(permutations[ii + i1 + permutations[jj + j1 + permutations[kk + k1 +
permutations[ll + l1]]]], x1, y1, z1, w1)
}

mut t2 := 0.6 - x2 * x2 - y2 * y2 - z2 * z2 - w2 * w2
mut n2 := 0.0
if t2 < 0.0 {
n2 = 0.0
} else {
t2 *= t2
n2 = t2 * t2 * grad_4d(permutations[ii + i2 + permutations[jj + j2 + permutations[kk + k2 +
permutations[ll + l2]]]], x2, y2, z2, w2)
}

mut t3 := 0.6 - x3 * x3 - y3 * y3 - z3 * z3 - w3 * w3
mut n3 := 0.0
if t3 < 0.0 {
n3 = 0.0
} else {
t3 *= t3
n3 = t3 * t3 * grad_4d(permutations[ii + i3 + permutations[jj + j3 + permutations[kk + k3 +
permutations[ll + l3]]]], x3, y3, z3, w3)
}

mut t4 := 0.6 - x4 * x4 - y4 * y4 - z4 * z4 - w4 * w4
mut n4 := 0.0
if t4 < 0.0 {
n4 = 0.0
} else {
t4 *= t4
n4 = t4 * t4 * grad_4d(permutations[ii + 1 + permutations[jj + 1 + permutations[kk + 1 +
permutations[ll + 1]]]], x4, y4, z4, w4)
}

return 27.0 * (n0 + n1 + n2 + n3 + n4)
}
Loading