Interface: InstructionPipe

InstructionPipe

An interface for a pipe that can be used to build instructions for the renderer. InstructionPipes are specifically used to manage the state of the renderer. For example, the BlendModePipe is used to set the blend mode of the renderer.

Properties:
Name Type Description
execute (instruction: INSTRUCTION) => void

this is where the actual instruction is executed - eg make the draw call activate a filter. Any instructions that have the same renderPipeId have their execute method called

pop (effect: Effect, targetContainer: Container, instructionSet: InstructionSet) => void

Used by effect pipes to pop effects from the renderer.

push (effect: Effect, targetContainer: Container, instructionSet: InstructionSet) => void

Used by the effect pipes push and pop effects to the renderer. A push effect allows the renderer to change its state to support the effect. A pop effect allows the renderer to return to its previous state. An example of this would be the filter effect.

renderEnd () => void

Called just after the render ends giving the RenderPipes a chance to do any cleanup

renderStart () => void

Called just before the render starts giving the RenderPipes a chance to do any setup

upload (instructionSet: InstructionSet) => void

called just before we execute the draw calls , this is where the pipes have an opportunity to upload data to the GPU. This is only called if data changes.

Members

execute (instruction: INSTRUCTION) => void

this is where the actual instruction is executed - eg make the draw call activate a filter. Any instructions that have the same renderPipeId have their execute method called

pop (effect: Effect, targetContainer: Container, instructionSet: InstructionSet) => void

Used by effect pipes to pop effects from the renderer.

push (effect: Effect, targetContainer: Container, instructionSet: InstructionSet) => void

Used by the effect pipes push and pop effects to the renderer. A push effect allows the renderer to change its state to support the effect. A pop effect allows the renderer to return to its previous state. An example of this would be the filter effect.

renderEnd () => void

Called just after the render ends giving the RenderPipes a chance to do any cleanup

renderStart () => void

Called just before the render starts giving the RenderPipes a chance to do any setup

upload (instructionSet: InstructionSet) => void

called just before we execute the draw calls , this is where the pipes have an opportunity to upload data to the GPU. This is only called if data changes.