Updated doc

alelievr · Dec 22, 2020 · 682a5ca · 682a5ca
1 parent 4a78b0c
commit 682a5ca
Show file tree

Hide file tree

Showing 132 changed files with 338 additions and 85 deletions.
diff --git a/Assets/Tools/Documentation/Editor/MixtureDocumentationWindow.cs b/Assets/Tools/Documentation/Editor/MixtureDocumentationWindow.cs
@@ -108,6 +108,8 @@ IEnumerator GenerateScreenshots()
             graphView.UpdateViewTransform(new Vector3(0, 0, 0), Vector3.one * graphView.scale);
             graphView.Focus();
 
+            MixtureGraphProcessor.RunOnce(docGraph);
+
             yield return new WaitForEndOfFrame();
 
             if (window == null)

diff --git a/docs/docfx/images/Mixture.AddNode.png b/docs/docfx/images/Mixture.AddNode.png
diff --git a/docs/docfx/images/Mixture.BlackAndWhiteNode.png b/docs/docfx/images/Mixture.BlackAndWhiteNode.png
diff --git a/docs/docfx/images/Mixture.BlendNode.png b/docs/docfx/images/Mixture.BlendNode.png
diff --git a/docs/docfx/images/Mixture.Blur.png b/docs/docfx/images/Mixture.Blur.png
diff --git a/docs/docfx/images/Mixture.CellularNoise.png b/docs/docfx/images/Mixture.CellularNoise.png
diff --git a/docs/docfx/images/Mixture.CheckerBoard.png b/docs/docfx/images/Mixture.CheckerBoard.png
diff --git a/docs/docfx/images/Mixture.Circles.png b/docs/docfx/images/Mixture.Circles.png
diff --git a/docs/docfx/images/Mixture.ClampNode.png b/docs/docfx/images/Mixture.ClampNode.png
diff --git a/docs/docfx/images/Mixture.ColorMatteNode.png b/docs/docfx/images/Mixture.ColorMatteNode.png
diff --git a/docs/docfx/images/Mixture.CombineNode.png b/docs/docfx/images/Mixture.CombineNode.png
diff --git a/docs/docfx/images/Mixture.CrossSection.png b/docs/docfx/images/Mixture.CrossSection.png
diff --git a/docs/docfx/images/Mixture.CubeTo2DLatLonNode.png b/docs/docfx/images/Mixture.CubeTo2DLatLonNode.png
diff --git a/docs/docfx/images/Mixture.DirectionalBlur.png b/docs/docfx/images/Mixture.DirectionalBlur.png
diff --git a/docs/docfx/images/Mixture.Distance.png b/docs/docfx/images/Mixture.Distance.png
diff --git a/docs/docfx/images/Mixture.DivNode.png b/docs/docfx/images/Mixture.DivNode.png
diff --git a/docs/docfx/images/Mixture.EdgeDetect.png b/docs/docfx/images/Mixture.EdgeDetect.png
diff --git a/docs/docfx/images/Mixture.FractalBrownianMotionNoise.png b/docs/docfx/images/Mixture.FractalBrownianMotionNoise.png
diff --git a/docs/docfx/images/Mixture.GenerateMipMaps.png b/docs/docfx/images/Mixture.GenerateMipMaps.png
diff --git a/docs/docfx/images/Mixture.GradienMattetNode.png b/docs/docfx/images/Mixture.GradienMattetNode.png
diff --git a/docs/docfx/images/Mixture.HDRPDetailCombine.png b/docs/docfx/images/Mixture.HDRPDetailCombine.png
diff --git a/docs/docfx/images/Mixture.HDRPMaskCombine.png b/docs/docfx/images/Mixture.HDRPMaskCombine.png
diff --git a/docs/docfx/images/Mixture.HSVNode.png b/docs/docfx/images/Mixture.HSVNode.png
diff --git a/docs/docfx/images/Mixture.InvertNode.png b/docs/docfx/images/Mixture.InvertNode.png
diff --git a/docs/docfx/images/Mixture.Julia.png b/docs/docfx/images/Mixture.Julia.png
diff --git a/docs/docfx/images/Mixture.Levels.png b/docs/docfx/images/Mixture.Levels.png
diff --git a/docs/docfx/images/Mixture.LinearToSRGB.png b/docs/docfx/images/Mixture.LinearToSRGB.png
diff --git a/docs/docfx/images/Mixture.Lines.png b/docs/docfx/images/Mixture.Lines.png
diff --git a/docs/docfx/images/Mixture.Mandelbrot.png b/docs/docfx/images/Mixture.Mandelbrot.png
diff --git a/docs/docfx/images/Mixture.MaskNode.png b/docs/docfx/images/Mixture.MaskNode.png
diff --git a/docs/docfx/images/Mixture.MengerSponge.png b/docs/docfx/images/Mixture.MengerSponge.png
diff --git a/docs/docfx/images/Mixture.ModNode.png b/docs/docfx/images/Mixture.ModNode.png
diff --git a/docs/docfx/images/Mixture.MulNode.png b/docs/docfx/images/Mixture.MulNode.png
diff --git a/docs/docfx/images/Mixture.NormalAdd.png b/docs/docfx/images/Mixture.NormalAdd.png
diff --git a/docs/docfx/images/Mixture.NormalBlend.png b/docs/docfx/images/Mixture.NormalBlend.png
diff --git a/docs/docfx/images/Mixture.NormalFromHeight.png b/docs/docfx/images/Mixture.NormalFromHeight.png
diff --git a/docs/docfx/images/Mixture.NormalMul.png b/docs/docfx/images/Mixture.NormalMul.png
diff --git a/docs/docfx/images/Mixture.NormalRotate.png b/docs/docfx/images/Mixture.NormalRotate.png
diff --git a/docs/docfx/images/Mixture.PerlinNoise.png b/docs/docfx/images/Mixture.PerlinNoise.png
diff --git a/docs/docfx/images/Mixture.PrefabCaptureNode.png b/docs/docfx/images/Mixture.PrefabCaptureNode.png
diff --git a/docs/docfx/images/Mixture.RandomColorNode.png b/docs/docfx/images/Mixture.RandomColorNode.png
diff --git a/docs/docfx/images/Mixture.RectanglesNode.png b/docs/docfx/images/Mixture.RectanglesNode.png
diff --git a/docs/docfx/images/Mixture.RemapNode.png b/docs/docfx/images/Mixture.RemapNode.png
diff --git a/docs/docfx/images/Mixture.RidgedCellularNoise.png b/docs/docfx/images/Mixture.RidgedCellularNoise.png
diff --git a/docs/docfx/images/Mixture.RidgedPerlinNoise.png b/docs/docfx/images/Mixture.RidgedPerlinNoise.png
diff --git a/docs/docfx/images/Mixture.RingsNode.png b/docs/docfx/images/Mixture.RingsNode.png
diff --git a/docs/docfx/images/Mixture.SRGBToLinear.png b/docs/docfx/images/Mixture.SRGBToLinear.png
diff --git a/docs/docfx/images/Mixture.ScaleBiasNode.png b/docs/docfx/images/Mixture.ScaleBiasNode.png
diff --git a/docs/docfx/images/Mixture.ShaderNode.png b/docs/docfx/images/Mixture.ShaderNode.png
diff --git a/docs/docfx/images/Mixture.Sharpen.png b/docs/docfx/images/Mixture.Sharpen.png
diff --git a/docs/docfx/images/Mixture.SplatterNode.png b/docs/docfx/images/Mixture.SplatterNode.png
diff --git a/docs/docfx/images/Mixture.SpriteSheetToVolume.png b/docs/docfx/images/Mixture.SpriteSheetToVolume.png
diff --git a/docs/docfx/images/Mixture.SubNode.png b/docs/docfx/images/Mixture.SubNode.png
diff --git a/docs/docfx/images/Mixture.SwizzleNode.png b/docs/docfx/images/Mixture.SwizzleNode.png
diff --git a/docs/docfx/images/Mixture.TextureMatteNode.png b/docs/docfx/images/Mixture.TextureMatteNode.png
diff --git a/docs/docfx/images/Mixture.TextureNode.png b/docs/docfx/images/Mixture.TextureNode.png
diff --git a/docs/docfx/images/Mixture.TextureSampleNode.png b/docs/docfx/images/Mixture.TextureSampleNode.png
diff --git a/docs/docfx/images/Mixture.ThresholdNode.png b/docs/docfx/images/Mixture.ThresholdNode.png
diff --git a/docs/docfx/images/Mixture.TileWrapNode.png b/docs/docfx/images/Mixture.TileWrapNode.png
diff --git a/docs/docfx/images/Mixture.Transform.png b/docs/docfx/images/Mixture.Transform.png
diff --git a/docs/docfx/images/Mixture.UVDistortNode.png b/docs/docfx/images/Mixture.UVDistortNode.png
diff --git a/docs/docfx/images/Mixture.UVNode.png b/docs/docfx/images/Mixture.UVNode.png
diff --git a/docs/docfx/images/Mixture.VolumeToSpriteSheet.png b/docs/docfx/images/Mixture.VolumeToSpriteSheet.png
diff --git a/docs/docfx/images/Mixture.VolumeToVectorField.png b/docs/docfx/images/Mixture.VolumeToVectorField.png
diff --git a/docs/docfx/images/Mixture.Warp.png b/docs/docfx/images/Mixture.Warp.png
diff --git a/docs/docfx/images/Mixture.WhiteNoise.png b/docs/docfx/images/Mixture.WhiteNoise.png
diff --git a/docs/docfx/manual/nodes/Mixture.AddNode.md b/docs/docfx/manual/nodes/Mixture.AddNode.md
@@ -10,7 +10,7 @@ Value | Additional Value
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Perform an addition with `source A`, `source B` and Color and writes the result to output like so:

diff --git a/docs/docfx/manual/nodes/Mixture.BlackAndWhiteNode.md b/docs/docfx/manual/nodes/Mixture.BlackAndWhiteNode.md
@@ -10,7 +10,7 @@ Keep Lum |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Convert RGB image to White and Black. With the Mode property you can change how the black and white color is computed:

diff --git a/docs/docfx/manual/nodes/Mixture.BlendNode.md b/docs/docfx/manual/nodes/Mixture.BlendNode.md
@@ -10,7 +10,7 @@ Mask |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Blend between two textures, you can use different blend mode depending which texture you want to blend (depth, color, ect.).

diff --git a/docs/docfx/manual/nodes/Mixture.Blur.md b/docs/docfx/manual/nodes/Mixture.Blur.md
@@ -9,7 +9,7 @@ Radius | Blur radius in pixels
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Gaussian blur filter in two passes. You might see some artifacts with large blur values because there is a fixed amount of samples (64) in the shader.

diff --git a/docs/docfx/manual/nodes/Mixture.CellularNoise.md b/docs/docfx/manual/nodes/Mixture.CellularNoise.md
@@ -12,7 +12,7 @@ Seed |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Voronoi/Cellular Noise generator.

diff --git a/docs/docfx/manual/nodes/Mixture.CheckerBoard.md b/docs/docfx/manual/nodes/Mixture.CheckerBoard.md
@@ -3,6 +3,7 @@
 ## Inputs
 Port Name | Description
 --- | ---
+UV | 
 Even Color | 
 Odd Color | 
 X Cell Count | 
@@ -13,7 +14,7 @@ Smooth |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Generate a checkerboard patter, in 3D this node generates a cubic checkerboard pattern.

diff --git a/docs/docfx/manual/nodes/Mixture.Circles.md b/docs/docfx/manual/nodes/Mixture.Circles.md
@@ -3,6 +3,7 @@
 ## Inputs
 Port Name | Description
 --- | ---
+UV | 
 SphereColor | 
 OuterColor | 
 Inner Size | 
@@ -11,7 +12,7 @@ Smooth |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Generate a Disk, in 3D this node generate a solid spheres.

diff --git a/docs/docfx/manual/nodes/Mixture.ClampNode.md b/docs/docfx/manual/nodes/Mixture.ClampNode.md
@@ -10,7 +10,7 @@ Max |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Clamp the input texture values. Note that the clamp is executed for each channel of the texture following this forumla:

diff --git a/docs/docfx/manual/nodes/Mixture.ColorMatteNode.md b/docs/docfx/manual/nodes/Mixture.ColorMatteNode.md
@@ -8,7 +8,7 @@ Color |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Generate a texture from an HDR color.

diff --git a/docs/docfx/manual/nodes/Mixture.CombineNode.md b/docs/docfx/manual/nodes/Mixture.CombineNode.md
@@ -12,7 +12,7 @@ Custom |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Combine up to 4 textures into one, allowing you to choose which channel to write in the output texture.

diff --git a/docs/docfx/manual/nodes/Mixture.CrossSection.md b/docs/docfx/manual/nodes/Mixture.CrossSection.md
@@ -9,7 +9,7 @@ Slice |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 The cross section node allow you to generate 2D texture by taking either a slice of a texture 2D or 3D.

diff --git a/docs/docfx/manual/nodes/Mixture.CubeTo2DLatLonNode.md b/docs/docfx/manual/nodes/Mixture.CubeTo2DLatLonNode.md
@@ -8,7 +8,7 @@ Input |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Transform a cubemap into a 2D texture using the LatLong convertion function.

diff --git a/docs/docfx/manual/nodes/Mixture.DirectionalBlur.md b/docs/docfx/manual/nodes/Mixture.DirectionalBlur.md
@@ -10,7 +10,7 @@ Direction | Direction vector, note that it does not have to be normalized
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Blur the input texture using a Gaussian filter in the specified direction.

diff --git a/docs/docfx/manual/nodes/Mixture.Distance.md b/docs/docfx/manual/nodes/Mixture.Distance.md
@@ -3,12 +3,12 @@
 ## Inputs
 Port Name | Description
 --- | ---
-Input | 
+input | 
 
 ## Output
 Port Name | Description
 --- | ---
-Output | 
+output | 
 
 ## Description
 Execute a flood fill operation on all pixels above the specified threshold.

diff --git a/docs/docfx/manual/nodes/Mixture.DivNode.md b/docs/docfx/manual/nodes/Mixture.DivNode.md
@@ -10,7 +10,7 @@ Value |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Divide one texture by another plus a constant value. The result is computed like this:

diff --git a/docs/docfx/manual/nodes/Mixture.EdgeDetect.md b/docs/docfx/manual/nodes/Mixture.EdgeDetect.md
@@ -10,7 +10,7 @@ Mode | Output color mode, it can either be white and black or input texture coor
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Detect the edges in the input texture, this node uses a Sobel filter to do so.

diff --git a/docs/docfx/manual/nodes/Mixture.FractalBrownianMotionNoise.md b/docs/docfx/manual/nodes/Mixture.FractalBrownianMotionNoise.md
@@ -12,7 +12,7 @@ Seed |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Generate a noise using multiple octaves of perlin noise, combined using the Fractal Brownian motion algorithm.

diff --git a/docs/docfx/manual/nodes/Mixture.GenerateMipMaps.md b/docs/docfx/manual/nodes/Mixture.GenerateMipMaps.md
@@ -0,0 +1,15 @@
+# Generate MipMaps
+![Mixture.GenerateMipMaps](../../images/Mixture.GenerateMipMaps.png)
+## Inputs
+Port Name | Description
+--- | ---
+In | 
+
+## Output
+Port Name | Description
+--- | ---
+Out | 
+
+## Description
+Generate mipmaps for the input texture.
+
diff --git a/docs/docfx/manual/nodes/Mixture.GradienMattetNode.md b/docs/docfx/manual/nodes/Mixture.GradienMattetNode.md
@@ -3,15 +3,14 @@
 ## Inputs
 Port Name | Description
 --- | ---
-Direction | Direction of the gradient, only visible on the Linear and exponential gradients
-Falloff | Exponential falloff of the gradient
 Color 1 | Outer color
 Color 2 | Inner color
+Falloff | Exponential falloff of the gradient
 
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Generates a gradient texture, 4 Modes are available right now:

diff --git a/docs/docfx/manual/nodes/Mixture.HDRPDetailCombine.md b/docs/docfx/manual/nodes/Mixture.HDRPDetailCombine.md
@@ -10,7 +10,7 @@ Smoothness |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Generates an HDRP detail map by combining the desaturated albedo, normal and smoothness maps.

diff --git a/docs/docfx/manual/nodes/Mixture.HDRPMaskCombine.md b/docs/docfx/manual/nodes/Mixture.HDRPMaskCombine.md
@@ -11,7 +11,7 @@ Smoothness |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Generates an HDRP Mask map by combining metallic, occlusion, detail mask and smoothness textures.

diff --git a/docs/docfx/manual/nodes/Mixture.HSVNode.md b/docs/docfx/manual/nodes/Mixture.HSVNode.md
@@ -4,6 +4,7 @@
 Port Name | Description
 --- | ---
 Input | 
+HSV Offset | 
 Hue | 
 Saturation | 
 Value | 
@@ -12,7 +13,7 @@ Max Value | For HDR images, you need to specify the maximum value of your image
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Modify the image in the HSV color space.

diff --git a/docs/docfx/manual/nodes/Mixture.InvertNode.md b/docs/docfx/manual/nodes/Mixture.InvertNode.md
@@ -9,7 +9,7 @@ Alpha |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Allow you to invert an image in the HSV color space.

diff --git a/docs/docfx/manual/nodes/Mixture.Julia.md b/docs/docfx/manual/nodes/Mixture.Julia.md
@@ -0,0 +1,26 @@
+# Julia
+![Mixture.Julia](../../images/Mixture.Julia.png)
+## Inputs
+Port Name | Description
+--- | ---
+UV | 
+C 1 | 
+C 2 | 
+Zoom | 
+Position | 
+
+## Output
+Port Name | Description
+--- | ---
+Out | 
+
+## Description
+This node is the base node of all shader operations, it allows you to create a node with a custom behavior by putting a shader in the Shader field.
+Note that the shader must be compatible with Custom Render Textures, otherwise it won't work. If you have a doubt you can create a new shader by pressing the button "New Shader".
+
+The node will automatically reflect the shader properties as inputs that you'll be able to connect to other nodes.
+This can be especially useful to prototype a new node or just add something that wasn't in the node Library.
+
+For more information, you can check the [Shader Nodes](../ShaderNodes.md) documentation page.
+
+Please note that this node only support Texture2D dimension(s).
diff --git a/docs/docfx/manual/nodes/Mixture.Levels.md b/docs/docfx/manual/nodes/Mixture.Levels.md
@@ -0,0 +1,16 @@
+# Levels
+![Mixture.Levels](../../images/Mixture.Levels.png)
+## Inputs
+Port Name | Description
+--- | ---
+max | 
+min | 
+input | 
+
+## Output
+Port Name | Description
+--- | ---
+output | 
+
+## Description
+
diff --git a/docs/docfx/manual/nodes/Mixture.LinearToSRGB.md b/docs/docfx/manual/nodes/Mixture.LinearToSRGB.md
@@ -0,0 +1,21 @@
+# Linear To sRGB
+![Mixture.LinearToSRGB](../../images/Mixture.LinearToSRGB.png)
+## Inputs
+Port Name | Description
+--- | ---
+Source | 
+
+## Output
+Port Name | Description
+--- | ---
+Out | 
+
+## Description
+This node is the base node of all shader operations, it allows you to create a node with a custom behavior by putting a shader in the Shader field.
+Note that the shader must be compatible with Custom Render Textures, otherwise it won't work. If you have a doubt you can create a new shader by pressing the button "New Shader".
+
+The node will automatically reflect the shader properties as inputs that you'll be able to connect to other nodes.
+This can be especially useful to prototype a new node or just add something that wasn't in the node Library.
+
+For more information, you can check the [Shader Nodes](../ShaderNodes.md) documentation page.
+
diff --git a/docs/docfx/manual/nodes/Mixture.Lines.md b/docs/docfx/manual/nodes/Mixture.Lines.md
@@ -3,16 +3,16 @@
 ## Inputs
 Port Name | Description
 --- | ---
+UV | 
 InnerColor | 
 OuterColor | 
 Radius | 
-Scale | 
 Smooth | 
 
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Generates a line pattern. In 3D this node generate cylinders using a signed distance field function.

diff --git a/docs/docfx/manual/nodes/Mixture.Mandelbrot.md b/docs/docfx/manual/nodes/Mixture.Mandelbrot.md
@@ -0,0 +1,24 @@
+# Mandelbrot
+![Mixture.Mandelbrot](../../images/Mixture.Mandelbrot.png)
+## Inputs
+Port Name | Description
+--- | ---
+UV | 
+Zoom | 
+Position | 
+
+## Output
+Port Name | Description
+--- | ---
+Out | 
+
+## Description
+This node is the base node of all shader operations, it allows you to create a node with a custom behavior by putting a shader in the Shader field.
+Note that the shader must be compatible with Custom Render Textures, otherwise it won't work. If you have a doubt you can create a new shader by pressing the button "New Shader".
+
+The node will automatically reflect the shader properties as inputs that you'll be able to connect to other nodes.
+This can be especially useful to prototype a new node or just add something that wasn't in the node Library.
+
+For more information, you can check the [Shader Nodes](../ShaderNodes.md) documentation page.
+
+Please note that this node only support Texture2D dimension(s).
diff --git a/docs/docfx/manual/nodes/Mixture.MaskNode.md b/docs/docfx/manual/nodes/Mixture.MaskNode.md
@@ -9,7 +9,7 @@ Input |
 ## Output
 Port Name | Description
 --- | ---
-output | 
+Out | 
 
 ## Description
 Sample the target texture and mask it using input texture. Note that the mask is written in the alpha channel of the output.