Skip to content

Commit efd3eb4

Browse files
committed
!noise documentation improvements
1 parent efc63ac commit efd3eb4

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

docs/shaders.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -554,22 +554,22 @@ with the `border` and `repeat` attributes as described above for
554554

555555
### `!noise`
556556

557-
The `!noise` node is primarily an image generator that generates slices through
558-
[OpenSimplex 2S](https://github.com/KdotJPG/OpenSimplex2) 3D ("improved XY")
559-
noise. The shape of the slice is controlled with the `shape` attribute, as
560-
follows:
557+
The `!noise` node is primarily an image generator that outputs slices through
558+
[OpenSimplex 2S](https://github.com/KdotJPG/OpenSimplex2) 3D noise. The shape
559+
of the slice is controlled with the `shape` attribute, as follows:
561560

562561
`shape=:plane` (the default)
563-
: The image is constructed from an XY plane of the 'ImproveXY' variant of the
564-
OpenSimplex 2S noise function.
562+
: The image is constructed from a rectangle in the XY plane of the *Improved
563+
XY* variant of the OpenSimplex 2S noise function.
565564

566565
`shape=:cylinder`
567-
: The image is constructed from a cylinder aligned along the Z axis of the
568-
conventional OpenSimplex 2S noise function. This will result in an evenly
569-
distributed noise image that seamlessly wraps on the left and right edges.
566+
: The image is constructed from the outer surface of a cylinder aligned along
567+
the Z axis of the conventional OpenSimplex 2S noise function. This will result
568+
in an evenly distributed noise image that seamlessly wraps on the left and
569+
right edges.
570570

571571
`shape=:sphere`
572-
: The image is constructed from a sphere aligned with its poles along the Z
572+
: The image is constructed from the surface of a sphere with its poles on the Z
573573
axis of the conventional noise function. The image will appear distorted at the
574574
top and bottom edges, but will seamlessly texture-map onto a shape using
575575
Equirectangular UV coordinates.
@@ -605,8 +605,7 @@ passed into the noise function, default `1`.
605605

606606
:::{note}
607607
The `origin` and `z` attributes are designed primarily for animating the default
608-
`shape=:plane` noise form. Results will be more complicated for cylindrical
609-
and spherical noise.
608+
`shape=:plane` noise.
610609
:::
611610

612611
`multiplier=` *MULTIPLIER*
@@ -636,4 +635,7 @@ the noise function as X, Y and Z offsets, controlled with the attribute:
636635

637636
`tscale=` *TX*`;`*TY*`;`*TZ*
638637
: Specifies a scaling factor for the RGB values read from the input image into
639-
offsets that will be added to the pre-`scale`d noise coordinates, default `1`.
638+
offsets that will be added to the *pre-scaled* noise coordinates, default `1`.
639+
640+
This allows per-pixel variation of the inputs to the noise function, including
641+
nesting one `!noise` generator within another.

0 commit comments

Comments
 (0)