Pixi’VNClass: InstructionSet
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:14
A set of instructions that can be executed by the renderer. Basically wraps an array, but with some extra properties that help the renderer to keep things nice and optimised.
Note: InstructionSet.instructions contains all the instructions, but does not resize (for performance). So for the true length of the instructions you need to use InstructionSet.instructionSize
Advanced
Constructors
Constructor
> new InstructionSet(): InstructionSet
Returns
InstructionSet
Properties
gcTick
> gcTick: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:25
used by the garbage collector to track when the instruction set was last used
instructions
> readonly instructions: Instruction[]
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:18
the array of instructions
instructionSize
> instructionSize: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:20
the actual size of the array (any instructions passed this should be ignored)
renderables
> renderables: Renderable[]
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:23
renderPipes
> renderPipes: any
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:22
allows for access to the render pipes of the renderer
uid
> readonly uid: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:16
a unique id for this instruction set used through the renderer
Methods
add()
> add(instruction): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:37
Add an instruction to the set
Parameters
instruction
add an instruction to the set
Returns
void
destroy()
> destroy(): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:32
Internal
Destroy the instruction set, clearing the instructions and renderables.
Returns
void
log()
> log(): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:42
Internal
Log the instructions to the console (for debugging)
Returns
void
reset()
> reset(): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/instructions/InstructionSet.d.ts:27
reset the instruction set so it can be reused set size back to 0
Returns
void