More progress on documentation...

This commit is contained in:
RodZill4 2019-11-19 07:08:36 +01:00
parent 1db87750fb
commit 816a758652
44 changed files with 215 additions and 62 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.6 KiB

After

Width:  |  Height:  |  Size: 6.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.4 KiB

After

Width:  |  Height:  |  Size: 7.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.2 KiB

After

Width:  |  Height:  |  Size: 3.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.7 KiB

After

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.3 KiB

After

Width:  |  Height:  |  Size: 3.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 98 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.5 KiB

After

Width:  |  Height:  |  Size: 5.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 5.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 170 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.0 KiB

After

Width:  |  Height:  |  Size: 8.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 6.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.2 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View File

@ -1,24 +1,33 @@
AdjustHSV node
~~~~~~~~~~~~~~
The AdjustHSV node adjusts the hue, saturation and value of the input image.
The **AdjustHSV** node adjusts the hue, saturation and value of the input image.
.. image:: images/node_adjust_hsv.png
Inputs
++++++
The AdjustHSV node requires a color input texture.
The **AdjustHSV** node requires a color input texture.
Outputs
+++++++
The AdjustHSV node provides a single color texture.
The **AdjustHSV** node provides a single color texture.
Parameters
++++++++++
The AdjustHSV node has the following parameters:
* Hue defines how hue is affected.
* Saturation defines how the colorfulness or the texture is affected.
* Value defunes how the lightness is affected.
The **AdjustHSV** node has the following parameters:
* *Hue* defines how hue is affected.
* *Saturation* defines how the colorfulness or the texture is affected.
* *Value* defunes how the lightness is affected.
Example images
++++++++++++++
.. image:: images/node_adjust_hsv_samples.png
:align: center

View File

@ -1,7 +1,7 @@
Blend node
~~~~~~~~~~
The blend node blends two inputs using an optional opacity. It performs a blend operation
The **Blend** node blends two inputs using an optional opacity. It performs a blend operation
defined by the blend mode between both inputs, and mixes the result with the bottom input
using the opacity (defines by the *opacity* parameter, or the optional greyscale input).
@ -10,7 +10,7 @@ using the opacity (defines by the *opacity* parameter, or the optional greyscale
Inputs
++++++
The blend node accepts three inputs:
The **Blend** node accepts three inputs:
* The first input is the top layer.
@ -21,20 +21,27 @@ The blend node accepts three inputs:
Outputs
+++++++
The blend node outputs the result of the blend operation.
The **Blend** node outputs the result of the blend operation.
Parameters
++++++++++
The blend node has two parameters:
The **Blend** node has two parameters:
* The blend mode, that can be one of the following: Normal, Dissolve, Multiply, Screen,
Overlay, Hard Light, Soft Light, Burn, Dodge, Lighten, Darken, Difference.
* The *blend mode*, that can be one of the following: *Normal*, *Dissolve*, *Multiply*, *Screen*,
*Overlay*, *Hard Light*, *Soft Light*, *Burn*, *Dodge*, *Lighten*, *Darken*, *Difference*.
* The opacity used when mixing the result of the blend operation with the bottom input
when the corresponding input is not connected.
* The *opacity* used when mixing the result of the blend operation with the bottom input
when the corresponding input is not connected. When connected, the opacity channel is
multiplied with that parameter.
Notes
+++++
The *opacity* input will be considered (and implicitly converted to) greyscale if it is a color texture.
Example images
++++++++++++++
.. image:: images/node_blend_samples.png
:align: center

View File

@ -1,32 +1,38 @@
Blur node
~~~~~~~~~
The blur node applies a Gaussian blur algorithm to its inputs.
The **Blur** node applies a Gaussian blur algorithm to its input.
.. image:: images/node_blur.png
Inputs
++++++
The blur node has a single input.
The **Blur** node has a single input.
Outputs
+++++++
The blur node outputs the result of the blur operation.
The **Blur** node outputs the result of the blur operation.
Parameters
++++++++++
The blur node has three parameters:
The **Blur** node has three parameters:
* The grid size defines the size of the output image.
* The *grid size* defines the size of the output image.
* The direction specifies if the blur algorithm is applied horizontally, vertically or both.
* The *direction* specifies if the blur algorithm is applied horizontally, vertically or both.
* The sigma parameter defines how smooth the output will be.
* The *sigma* parameter defines how smooth the output will be.
Notes
+++++
This node outputs an image that has a fixed size.
Example images
++++++++++++++
.. image:: images/node_blur_samples.png
:align: center

View File

@ -1,7 +1,7 @@
Colorize node
~~~~~~~~~~~~~
The colorize node applies a user-defined gradient to a greyscale image: black pixels
The **Colorize** node applies a user-defined gradient to a greyscale image: black pixels
will be colored with the leftmost color of the gradient and white pixels will take
the rightmost color.
@ -10,21 +10,26 @@ the rightmost color.
Inputs
++++++
The colorize node requires a greyscale input texture.
The **Colorize** node requires a greyscale input texture.
Outputs
+++++++
The colorize node provides a single color texture.
.. image:: images/colorize.png
The **Colorize** node provides a single color texture.
Parameters
++++++++++
The colorize node has a single parameter that defines the gradient to be applied to the input image.
The **Colorize** node has a single parameter that defines the gradient to be applied to
the input image.
Notes
+++++
The input will be considered (and implicitly converted to) greyscale if it is a color texture.
Example images
++++++++++++++
.. image:: images/node_colorize_samples.png
:align: center

View File

@ -1,16 +1,16 @@
Combine node
~~~~~~~~~~~~
The combine node combines three greyscale inputs into a color output texture.
The **Combine** node combines four greyscale inputs into an RGBA output texture.
.. image:: images/node_combine.png
Inputs
++++++
The combine node has 3 inputs, one for each (red, green and blue) channel.
The combi**Combine**ne node has 3 inputs, one for each (red, green and blue) channel.
Outputs
+++++++
The combine node outputs a color image.
The **Combine** node outputs a color image.

View File

@ -1,16 +1,16 @@
Decompose node
~~~~~~~~~~~~~~
The decompose node decomposes a color input into three greyscale outputs.
The **Decompose** node decomposes anRGBA input into four greyscale outputs.
.. image:: images/node_decompose.png
Inputs
++++++
The decompose node has a single color input.
The **Decompose** node has a single color input.
Outputs
+++++++
The decompose node outputs 3 greyscale images, one for each (red, green and blue) channel.
The **Decompose** node outputs 4 greyscale images, one for each (red, green, blue and alpha) channel.

View File

@ -0,0 +1,38 @@
Directional Blur node
~~~~~~~~~~~~~~~~~~~~~
The **Directional Blur** node applies a Gaussian blur algorithm to its input in a given direction.
.. image:: images/node_directional_blur.png
Inputs
++++++
The **Directional Blur** node has a single input.
Outputs
+++++++
The **Directional Blur** node outputs the result of the blur operation.
Parameters
++++++++++
The **Directional Blur** node has three parameters:
* The *grid size* defines the size of the output image.
* The *sigma* parameter defines how smooth the output will be.
* The *angle* specifies the angle of the blur algorithm.
Notes
+++++
This node outputs an image that has a fixed size.
Example images
++++++++++++++
.. image:: images/node_directional_blur_samples.png
:align: center

View File

@ -1,26 +1,38 @@
Emboss node
~~~~~~~~~~~
The emboss node generates an image that simulates lighting on its input.
The **Emboss** node generates an image that simulates lighting on its input.
.. image:: images/node_emboss.png
Inputs
++++++
The emboss node has a single input.
The **Emboss** node has a single greyscale input, interpreted as a heightmap.
Outputs
+++++++
The emboss node outputs the result of the emboss operation.
The **Emboss** node outputs the result of the emboss operation.
Parameters
++++++++++
The emboss node has a single parameter that defines the position of the light source used for the emboss effect.
The **Emboss** node the following parameters:
* The *grid size* defines the size of the output image.
* the *angle* of the light source used for the emboss effect.
* the *strength* of the emboss effect.
Notes
+++++
This node outputs an image that has a fixed size.
Example images
++++++++++++++
.. image:: images/node_emboss_samples.png
:align: center

View File

@ -1,26 +1,38 @@
Normal map node
~~~~~~~~~~~~~~~~
The normal map node generates a normal map from its input.
The **Normal map** node generates a normal map from its input.
.. image:: images/node_normal_map.png
Inputs
++++++
The normal map node accepts a single greyscale image as input.
The **Normal map** node accepts a single greyscale image as input, interpreted as a heightmap.
Outputs
+++++++
The normal map node outputs the generated normal map.
The **Normal map** node outputs the generated normal map.
Parameters
++++++++++
The normal map node has a single parameter that defines the strength of the normal map effect.
The **Normal map** node has the following parameters:
* the *format* of the normal map (default, OpenGL or DirectX)
* the *size* of the normal map
* the *strength* of the normal map effect
Notes
+++++
This node outputs an image that has a fixed size.
Example images
++++++++++++++
.. image:: images/node_normal_map_samples.png
:align: center

View File

@ -0,0 +1,36 @@
Occlusion node
~~~~~~~~~~~~~~
The **Occlusion** node generates an ambient occlusion texture from its input.
.. image:: images/node_occlusion.png
Inputs
++++++
The **Occlusion** node accepts a single greyscale image as input, interpreted as a heightmap.
Outputs
+++++++
The **Occlusion** node outputs the generated normal map.
Parameters
++++++++++
The **Normal map** node has the following parameters:
* the *size* of the ambient occlusion map
* the *strength* of the ambient occlusion
Notes
+++++
This node outputs an image that has a fixed size.
Example images
++++++++++++++
.. image:: images/node_occlusion_samples.png
:align: center

View File

@ -1,27 +1,26 @@
Perlin noise node
~~~~~~~~~~~~~~~~~
The Perlin noise node outputs a texture generated as a sum of Perlin noise functions
with increasing frequencies and decreasing amplitudes.
The **Perlin** noise node outputs a texture generated as a sum of Perlin noise functions
with increasing frequencies and decreasing amplitudes. Perlin noise has a wide range of
applications, such as stains, wood, dust...
.. image:: images/node_perlin.png
Inputs
++++++
The Perlin noise node does not accept any input.
The **Perlin** noise node does not accept any input.
Outputs
+++++++
The Perlin noise node provides a greyscale Perlin noise texture.
.. image:: images/perlin.png
The **Perlin** noise node provides a greyscale Perlin noise texture.
Parameters
++++++++++
The Perlin noise node accepts the following parameters:
The **Perlin** noise node accepts the following parameters:
* *Scale X* and *Scale Y* are the subdivisions of the first iteration
@ -36,3 +35,9 @@ Notes
As with all random nodes, the seed is held by the node's position, so moving the node in the graph
will modify the texture, and the outputs will remain the same if its position and parameters
are not changed.
Example images
++++++++++++++
.. image:: images/node_perlin_samples.png
:align: center

View File

@ -1,7 +1,8 @@
Voronoi noise node
~~~~~~~~~~~~~~~~~~
The **Voronoi** noise node outputs Voronoi noise textures.
The **Voronoi** noise node outputs Voronoi noise textures that can be used for irregular
tiles, animal skin or scales, cracks...
.. image:: images/node_voronoi.png
@ -26,10 +27,14 @@ Parameters
The **Voronoi** noise node accepts the following parameters:
* *Scale X* and *Scale Y* define the number of feature points that define the noise
* *Scale X* and *Scale Y* define the number of feature points that define the noise.
* *Stretch X* and *Stretch Y* are applied to the distance functions.
* *Intensity* is a factor applied to the first output of the node.
* *Randomness* defines the location of feature points.
Notes
+++++

View File

@ -1,14 +1,14 @@
Transform node
~~~~~~~~~~~~~~
The transform node applies a scale operation, a rotation and a translation to the input image.
The **Transform** node applies a scale operation, a rotation and a translation to the input image.
.. image:: images/node_transform.png
Inputs
++++++
The transform node accepts a color image as input.
The **Transform** node accepts a color image as input.
It also accepts a greyscale input image for each transform parameter. In that case,
instead of applying a uniform transform to the input image, the transform parameter
@ -19,7 +19,7 @@ by -1, a white pixel will not change the parameter, a grey50 pixel will set it t
Outputs
+++++++
The transform node outputs the transformed image.
The **Transform** node outputs the transformed image.
The input image is first rotated around its center, then the scale operation is applied and
finally the translation.
@ -30,7 +30,7 @@ input does not rely on resolution dependant nodes.
Parameters
++++++++++
The transform node has the following parameters:
The **Transform** node has the following parameters:
* *Translate X* and *Translate Y* define the translation.
@ -39,3 +39,9 @@ The transform node has the following parameters:
* *Scale X* and *Scale Y* define the scale operations along the X and Y axes.
* If *Repeat* is checked, zooming out will repeat the image, otherwise it will be clamped.
Example images
++++++++++++++
.. image:: images/node_transform_samples.png
:align: center

View File

@ -1,14 +1,14 @@
Warp node
~~~~~~~~~
The warp node deforms an input image according to the derivative of the second input image.
The **Warp** node deforms an input image according to the derivative of the second input image.
.. image:: images/node_warp.png
Inputs
++++++
The warp node accepts two inputs:
The **Warp** node accepts two inputs:
* The *Source* inputs is the image to be deformed.
@ -17,9 +17,19 @@ The warp node accepts two inputs:
Outputs
+++++++
The warp node outputs the deformed image.
The **Warp** node outputs the deformed image.
Parameters
++++++++++
The warp node has the a single parameter that will be used to scale the warp effect.
The **Warp** node has two parameters:
* *strength* to scale the warp effect.
* *epsilon* is used to evaluate the second input's derivative
Example images
++++++++++++++
.. image:: images/node_warp_samples.png
:align: center

View File

@ -6,9 +6,11 @@ The filter nodes accept one or several inputs and generate one or several images
.. toctree::
:maxdepth: 1
node_filter_adjust_hsv
node_filter_colorize
node_filter_blend
node_filter_blur
node_filter_blur_directional
node_filter_colorize
node_filter_directional_blur
node_filter_emboss
node_filter_normal_map
node_filter_occlusion

View File

@ -1,5 +1,5 @@
Transform nodes
------------
---------------
The transform nodes are nodes that affect the geometry of their input.