RenderPassBuilder

RenderPassBuilder

Allows you to declare resources for the pass, reading/writing/creating resources that will be used by the pass.

Kind: global class

• RenderPassBuilder
  • new exports.RenderPassBuilder()
  • .init(graph, node)
  • .create(name, descriptor) ⇒ number
  • .read(resource) ⇒ number
  • .write(resource) ⇒ number
  • .make_side_effect()

new exports.RenderPassBuilder()

Example

const pass_data = {};
     const pass_builder = graph.add("pass", pass_data, (data, resources, context) => { ... });
     pass_data.resource_a = pass_builder.create("A", {});

renderPassBuilder.init(graph, node)

Kind: instance method of RenderPassBuilder

Param	Type
graph	RenderGraph
node	RenderPassNode

renderPassBuilder.create(name, descriptor) ⇒ number

Create a new resource. Creation implies writing as well.

Kind: instance method of RenderPassBuilder
Returns: number - resource ID

Param	Type
name	string
descriptor	ResourceDescriptor

renderPassBuilder.read(resource) ⇒ number

Read an existing resource

Kind: instance method of RenderPassBuilder
Returns: number - resource ID same as the input

Param	Type
resource	number

renderPassBuilder.write(resource) ⇒ number

Write a resource

Kind: instance method of RenderPassBuilder
Returns: number - resource ID

Param	Type
resource	number

renderPassBuilder.make_side_effect()

Indicate that this pass has side effects. Will force the node to always be executed, regardless if it contributes to the final outputs of the graph or not. Useful for debug purposes or cases where some of the resources written are not part of the graph.

Kind: instance method of RenderPassBuilder