Просмотр исходного кода

NodeBuilder - Add Hints in Comments (#32004)

* init branch

* flowStageNode improvements

* modify NodeBuilder comments

* adjust flow build stage comment per sunag suggestion
Christian Helgeson 3 месяцев назад
Родитель
Сommit
da275a4e00
1 измененных файлов с 11 добавлено и 0 удалено
  1. 11 0
      src/nodes/core/NodeBuilder.js

+ 11 - 0
src/nodes/core/NodeBuilder.js

@@ -1674,6 +1674,11 @@ class NodeBuilder {
 	/**
 	/**
 	 * Returns the properties for the given node and shader stage.
 	 * Returns the properties for the given node and shader stage.
 	 *
 	 *
+	 * Properties are typically used within a build stage to reference a node's
+	 * child node or nodes manually assigned to the properties in a separate build stage.
+	 * A typical usage pattern for defining nodes manually would be assigning dependency nodes
+	 * to the current node's properties in the setup stage and building those properties in the generate stage.
+	 *
 	 * @param {Node} node - The node to get the properties for.
 	 * @param {Node} node - The node to get the properties for.
 	 * @param {('vertex'|'fragment'|'compute'|'any')} [shaderStage='any'] - The shader stage.
 	 * @param {('vertex'|'fragment'|'compute'|'any')} [shaderStage='any'] - The shader stage.
 	 * @return {Object} The node properties.
 	 * @return {Object} The node properties.
@@ -2284,6 +2289,12 @@ class NodeBuilder {
 	/**
 	/**
 	 * Executes the node in a specific build stage.
 	 * Executes the node in a specific build stage.
 	 *
 	 *
+	 * This function can be used to arbitrarily execute the specified build stage
+	 * outside of the standard build process. For instance, if a node's type depends
+	 * on properties created by the 'setup' stage, then flowBuildStage(node, 'setup')
+	 * can be used to execute the setup build stage and access its generated nodes
+	 * before the standard build process begins.
+	 *
 	 * @param {Node} node - The node to execute.
 	 * @param {Node} node - The node to execute.
 	 * @param {string} buildStage - The build stage to execute the node in.
 	 * @param {string} buildStage - The build stage to execute the node in.
 	 * @param {?(Node|string)} [output=null] - Expected output type. For example 'vec3'.
 	 * @param {?(Node|string)} [output=null] - Expected output type. For example 'vec3'.

粤ICP备19079148号