update generated docs

t3kt · Jun 22, 2023 · d2a19bc · d2a19bc
1 parent fcd71a6
commit d2a19bc
Show file tree

Hide file tree

Showing 25 changed files with 430 additions and 31 deletions.
diff --git a/docs/_data/toolkit.yaml b/docs/_data/toolkit.yaml
@@ -1 +1 @@
-toolkitVersion: '0.34'
+toolkitVersion: '0.35'
diff --git a/docs/_reference/operators/combine/index.md b/docs/_reference/operators/combine/index.md
@@ -65,6 +65,7 @@ cat:
       allowing for fast switching.
   - name: triPlanarCombine
     status: beta
+    summary: Combines three 2D fields based on vectors like surface normals.
   summary: 'Operators that take two or more inputs and combine them into a single
 
     output.'

diff --git a/docs/_reference/operators/combine/triPlanarCombine.md b/docs/_reference/operators/combine/triPlanarCombine.md
@@ -23,6 +23,9 @@ op:
     required: true
     returnTypes:
     - vec4
+    summary: Alternative way to provide the coordinates used by the fields rather
+      than just using the position in space. Each input field gets two of the axes
+      of the coordinates provided (e.g. the XY field gets the x and y).
   - contextTypes:
     - Context
     - MaterialContext
@@ -37,6 +40,9 @@ op:
     required: true
     returnTypes:
     - vec4
+    summary: Field that provides the surface normals used to adjust the influence
+      of each plane. Typically this should be a `normalField` or a `variableReference`
+      that accesses a surface normal within a material.
   - contextTypes:
     - Context
     - MaterialContext
@@ -88,6 +94,9 @@ op:
     name: Scale
   - label: Use Normals
     name: Usenormals
+    summary: Modifies the amount of each field that's used based on how directly the
+      surface normals are facing that plane. For example, the XY field is used most
+      on parts that are facing forwards or backwards.
   - label: Blend Mode
     menuOptions:
     - label: Add Axes
@@ -97,6 +106,7 @@ op:
     - label: Average Axes
       name: avg
     name: Blendmode
+    summary: How the values from each field are combined.
   - label: Return Type
     menuOptions:
     - label: Auto
@@ -107,5 +117,9 @@ op:
       name: vec4
     name: Returntype
   status: beta
+  summary: Combines three 2D fields based on vectors like surface normals.
 
 ---
+
+
+Combines three 2D fields based on vectors like surface normals.
diff --git a/docs/_reference/operators/convert/vectorToFloat.md b/docs/_reference/operators/convert/vectorToFloat.md
@@ -75,6 +75,12 @@ op:
       name: val
     - label: Luminance
       name: luma
+    - label: Sum(XY)
+      name: sumxy
+    - label: Sum(XYZ)
+      name: sumxyz
+    - label: Sum(XYZW)
+      name: sumxyzw
     name: Usepart
     summary: Which part of the vector to use for the float field.
   summary: Converts a vector value field to a float field using one part of the vector.

diff --git a/docs/_reference/operators/field/colorRampField.md b/docs/_reference/operators/field/colorRampField.md
@@ -26,6 +26,53 @@ op:
     returnTypes:
     - float
     - vec4
+  - contextTypes:
+    - Context
+    - MaterialContext
+    - CameraContext
+    - LightContext
+    - RayContext
+    - ParticleContext
+    coordTypes:
+    - float
+    - vec2
+    - vec3
+    - vec4
+    label: Point 1 Field
+    name: point1Field
+    returnTypes:
+    - float
+    - vec4
+  - contextTypes:
+    - Context
+    - MaterialContext
+    - CameraContext
+    - LightContext
+    - RayContext
+    - ParticleContext
+    coordTypes:
+    - float
+    - vec2
+    - vec3
+    - vec4
+    label: Point 2 Field
+    name: point2Field
+    returnTypes:
+    - float
+    - vec4
+  - contextTypes:
+    - Context
+    - MaterialContext
+    - CameraContext
+    - LightContext
+    - RayContext
+    - ParticleContext
+    coordTypes:
+    - float
+    label: Easing Function
+    name: easingFunc
+    returnTypes:
+    - float
   keywords:
   - color
   - gradient
@@ -35,17 +82,13 @@ op:
   parameters:
   - label: Enable
     name: Enable
-  - label: Coord Type
+  - label: Coordinate Mode
     menuOptions:
-    - label: Auto
-      name: auto
-    - label: 1D
-      name: float
-    - label: 2D
-      name: vec2
-    - label: 3D
-      name: vec3
-    name: Coordtype
+    - label: Axis
+      name: axis
+    - label: Endpoints
+      name: points
+    name: Coordmode
   - label: Axis
     menuOptions:
     - label: X
@@ -57,16 +100,12 @@ op:
     - label: Distance From Origin
       name: dist
     name: Axis
-  - label: Color 1
-    name: Color1
-  - label: Alpha 1
-    name: Alpha1
-  - label: Color 2
-    name: Color2
-  - label: Alpha 2
-    name: Alpha2
   - label: Coordinate Range
     name: Range
+  - label: Point 1
+    name: Point1
+  - label: Point 2
+    name: Point2
   - label: Extend Mode
     menuOptions:
     - label: Hold
@@ -78,6 +117,25 @@ op:
     - label: Mirror
       name: mirror
     name: Extendmode
+  - label: Color 1
+    name: Color1
+  - label: Alpha 1
+    name: Alpha1
+  - label: Color 2
+    name: Color2
+  - label: Alpha 2
+    name: Alpha2
+  - label: Coord Type
+    menuOptions:
+    - label: Auto
+      name: auto
+    - label: 1D
+      name: float
+    - label: 2D
+      name: vec2
+    - label: 3D
+      name: vec3
+    name: Coordtype
   summary: A vector field that maps an input field to values from a range of colors.
   thumb: assets/images/reference/operators/field/colorRampField_thumb.png
 

diff --git a/docs/_reference/operators/field/rampField.md b/docs/_reference/operators/field/rampField.md
@@ -41,7 +41,6 @@ op:
     - vec4
     label: Point 1 Field
     name: point1Field
-    required: true
     returnTypes:
     - float
     - vec4
@@ -59,10 +58,22 @@ op:
     - vec4
     label: Point 2 Field
     name: point2Field
-    required: true
     returnTypes:
     - float
     - vec4
+  - contextTypes:
+    - Context
+    - MaterialContext
+    - CameraContext
+    - LightContext
+    - RayContext
+    - ParticleContext
+    coordTypes:
+    - float
+    label: Easing Function
+    name: easingFunc
+    returnTypes:
+    - float
   name: rampField
   opType: raytk.operators.field.rampField
   parameters:

diff --git a/docs/_reference/operators/field/stepField.md b/docs/_reference/operators/field/stepField.md
@@ -82,6 +82,19 @@ op:
     returnTypes:
     - float
     - vec4
+  - contextTypes:
+    - Context
+    - MaterialContext
+    - CameraContext
+    - LightContext
+    - RayContext
+    - ParticleContext
+    coordTypes:
+    - float
+    label: Blend Function
+    name: blendFunction
+    returnTypes:
+    - float
   name: stepField
   opType: raytk.operators.field.stepField
   parameters:

diff --git a/docs/_reference/operators/filter/adjustColor.md b/docs/_reference/operators/filter/adjustColor.md
@@ -27,6 +27,7 @@ op:
     required: true
     returnTypes:
     - vec4
+    - Sdf
   - contextTypes:
     - Context
     - MaterialContext
@@ -114,12 +115,13 @@ op:
     name: Hueoffset
   - label: Gamma
     name: Gamma
-  summary: Adjust properties of color values.
+  summary: Adjust properties of color values, either directly on a field, or on the
+    assigned surface color of an Sdf result.
   thumb: assets/images/reference/operators/filter/adjustColor_thumb.png
 
 ---
 
 
-Adjust properties of color values.
+Adjust properties of color values, either directly on a field, or on the assigned surface color of an Sdf result.
 
 This is similar to Level TOP and HSV Adjust TOP.
diff --git a/docs/_reference/operators/filter/index.md b/docs/_reference/operators/filter/index.md
@@ -25,7 +25,8 @@ cat:
     - hue
     - saturation
     name: adjustColor
-    summary: Adjust properties of color values.
+    summary: Adjust properties of color values, either directly on a field, or on
+      the assigned surface color of an Sdf result.
   - keywords:
     - color
     - material

diff --git a/docs/_reference/operators/filter/spiralZoom.md b/docs/_reference/operators/filter/spiralZoom.md
@@ -125,6 +125,11 @@ op:
       that if this is not a whole integer, there will be a break in the spiral.
   summary: Transforms space using a logarithmic spiral.
   thumb: assets/images/reference/operators/filter/spiralZoom_thumb.png
+  variables:
+  - label: logdist
+    name: logdist
+  - label: dist
+    name: dist
 
 ---
 

diff --git a/docs/_reference/operators/light/axisLight.md b/docs/_reference/operators/light/axisLight.md
@@ -9,6 +9,14 @@ redirect_from:
 op:
   category: light
   inputs:
+  - contextTypes:
+    - LightContext
+    coordTypes:
+    - vec3
+    label: Position Field
+    name: positionField
+    returnTypes:
+    - vec4
   - contextTypes:
     - LightContext
     coordTypes:

diff --git a/docs/_reference/operators/light/pointLight.md b/docs/_reference/operators/light/pointLight.md
@@ -13,26 +13,34 @@ op:
     - LightContext
     coordTypes:
     - vec3
-    label: Color Field
-    name: colorField
+    label: Position Field
+    name: positionField
     returnTypes:
-    - float
     - vec4
     summary: Optional field that can control the color of the light based on the position
       of surface hits where it is being applied. The resulting color is multiplied
       by the `Color` parameter and `Intensity`.
   - contextTypes:
     - LightContext
     coordTypes:
-    - float
-    label: Attenuation Field
-    name: attenuationField
+    - vec3
+    label: Color Field
+    name: colorField
     returnTypes:
     - float
     - vec4
     summary: Optional field/function that controls the slope and coloration of the
       attentuation rolloff is shaped. It can be used to make the light shift from
       one color to another, or to control the sharpness of the rolloff.
+  - contextTypes:
+    - LightContext
+    coordTypes:
+    - float
+    label: Attenuation Field
+    name: attenuationField
+    returnTypes:
+    - float
+    - vec4
   name: pointLight
   opType: raytk.operators.light.pointLight
   parameters:

diff --git a/docs/_reference/operators/material/hologramContrib.md b/docs/_reference/operators/material/hologramContrib.md
@@ -0,0 +1,41 @@
+---
+layout: operator
+title: hologramContrib
+parent: Material Operators
+grand_parent: Operators
+permalink: /reference/operators/material/hologramContrib
+redirect_from:
+  - /reference/opType/raytk.operators.material.hologramContrib/
+op:
+  category: material
+  inputs:
+  - contextTypes:
+    - MaterialContext
+    coordTypes:
+    - vec3
+    label: Color Field
+    name: colorField
+    returnTypes:
+    - float
+    - vec4
+  name: hologramContrib
+  opType: raytk.operators.material.hologramContrib
+  parameters:
+  - label: Enable
+    name: Enable
+  - label: Iterations
+    name: Iterations
+  - label: Step Distance
+    name: Step
+  - label: Period
+    name: Period
+  - label: Phase
+    name: Phase
+  status: beta
+  variables:
+  - label: step
+    name: step
+  - label: normstep
+    name: normstep
+
+---