Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/nodes/core/NodeBuilder.js
Original file line number Diff line number Diff line change
Expand Up @@ -1674,6 +1674,11 @@ class NodeBuilder {
/**
* 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 {('vertex'|'fragment'|'compute'|'any')} [shaderStage='any'] - The shader stage.
* @return {Object} The node properties.
Expand Down Expand Up @@ -2284,6 +2289,12 @@ class NodeBuilder {
/**
* 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 {string} buildStage - The build stage to execute the node in.
* @param {?(Node|string)} [output=null] - Expected output type. For example 'vec3'.
Expand Down