Skip to content

Commit a12ee5a

Browse files
committed
chore: update document
1 parent 632f111 commit a12ee5a

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

noise.go

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
"github.com/pkg/errors"
77
)
88

9-
// Algo represents a noise type of the algorithm to generate noise.
9+
// Algo represents the algorithm of the noise to generate.
1010
type Algo int
1111

1212
const (
@@ -31,6 +31,9 @@ type Generator interface {
3131
// Eval32(x)
3232
// Eval32(x, y)
3333
// Eval32(x, y, z)
34+
//
35+
// Implementations of this method must return the same value if the seed
36+
// value is the same.
3437
Eval32(dim ...float32) float32
3538
// Eval64 returns a float64 noise value at given coordinates. The maximum
3639
// number of arguments is three.
@@ -39,6 +42,9 @@ type Generator interface {
3942
// Eval64(x)
4043
// Eval64(x, y)
4144
// Eval64(x, y, z)
45+
//
46+
// Implementations of this method must return the same value if the seed
47+
// value is the same.
4248
Eval64(dim ...float64) float64
4349
}
4450

0 commit comments

Comments
 (0)