Pixi’VNClass: RenderGroup
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:47
A RenderGroup is a class that is responsible for I generating a set of instructions that are used to render the root container and its children. It also watches for any changes in that container or its children, these changes are analysed and either the instruction set is rebuild or the instructions data is updated.
Advanced
Implements
Constructors
Constructor
> new RenderGroup(): RenderGroup
Returns
RenderGroup
Properties
canBundle
> canBundle: boolean
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:50
true if this instruction can be compiled into a WebGPU bundle
Implementation of
childrenRenderablesToUpdate
> readonly childrenRenderablesToUpdate: object
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:63
index
> index: number
list
> list: Container<ContainerChild>[]
childrenToUpdate
> readonly childrenToUpdate: Record<number, { index: number; list: Container[]; }>
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:57
gcTick
> gcTick: number
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:62
instructionSet
> instructionSet: InstructionSet
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:68
isCachedAsTexture
> isCachedAsTexture: boolean
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:79
Indicates if the container should be cached as a texture.
Default
false
renderGroupChildren
> renderGroupChildren: RenderGroup[]
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:52
renderGroupParent
> renderGroupParent: RenderGroup
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:51
renderPipeId
> renderPipeId: string
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:48
a the id of the render pipe that can run this instruction
Implementation of
root
> root: Container
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:49
structureDidChange
> structureDidChange: boolean
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:67
texture?
> optional texture?: Texture<TextureSource<any>>
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:85
The texture used for caching the container. this is only set if isCachedAsTexture is true. It can only be accessed after a render pass.
textureNeedsUpdate
> textureNeedsUpdate: boolean
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:74
Indicates if the cached texture needs to be updated.
Default
true
textureOptions
> textureOptions: CacheAsTextureOptions
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:96
The options for caching the container as a texture.
updateTick
> updateTick: number
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:61
worldAlpha
> worldAlpha: number
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:56
worldColor
> worldColor: number
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:55
worldColorAlpha
> worldColorAlpha: number
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:54
worldTransform
> worldTransform: Matrix
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:53
Accessors
cacheToLocalTransform
Get Signature
> get cacheToLocalTransform(): Matrix
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:162
Returns a matrix that transforms coordinates to the correct coordinate space of the texture being rendered to. This is the texture offset inverse transform of the closest parent RenderGroup that is cached as a texture.
Returns
The transform matrix for the cached texture coordinate space, or null if no parent is cached as texture.
inverseParentTextureTransform
Get Signature
> get inverseParentTextureTransform(): Matrix
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:155
Returns the inverse of the parent texture transform matrix. This is used to properly transform coordinates when rendering into cached textures.
Returns
The inverse of the parent texture transform matrix.
inverseWorldTransform
Get Signature
> get inverseWorldTransform(): Matrix
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:144
Returns the inverse of the world transform matrix.
Returns
The inverse of the world transform matrix.
isRenderable
Get Signature
> get isRenderable(): boolean
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:127
Returns
boolean
localTransform
Get Signature
> get localTransform(): Matrix
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:118
Returns
textureOffsetInverseTransform
Get Signature
> get textureOffsetInverseTransform(): Matrix
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:149
Returns the inverse of the texture offset transform matrix.
Returns
The inverse of the texture offset transform matrix.
Methods
addChild()
> addChild(child): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:121
Parameters
child
Returns
void
addOnRender()
> addOnRender(container): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:133
adding a container to the onRender list will make sure the user function passed in to the user defined 'onRender` callBack
Parameters
container
the container to add to the onRender list
Returns
void
addRenderGroupChild()
> addRenderGroupChild(renderGroupChild): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:119
Parameters
renderGroupChild
RenderGroup
Returns
void
destroy()
> destroy(): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:136
Returns
void
disableCacheAsTexture()
> disableCacheAsTexture(): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:115
Returns
void
enableCacheAsTexture()
> enableCacheAsTexture(options?): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:114
Parameters
options?
Returns
void
getChildren()
> getChildren(out?): Container<ContainerChild>[]
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:137
Parameters
out?
Returns
init()
> init(root): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:113
Parameters
root
Returns
void
invalidateMatrices()
> invalidateMatrices(): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:139
Returns
void
onChildUpdate()
> onChildUpdate(child): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:124
Parameters
child
Returns
void
onChildViewUpdate()
> onChildViewUpdate(child): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:126
Parameters
child
Returns
void
removeChild()
> removeChild(child): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:122
Parameters
child
Returns
void
removeChildren()
> removeChildren(children): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:123
Parameters
children
Returns
void
removeOnRender()
> removeOnRender(container): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:134
Parameters
container
Returns
void
reset()
> reset(): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:117
Returns
void
runOnRender()
> runOnRender(renderer): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:135
Parameters
renderer
Returns
void
updateCacheTexture()
> updateCacheTexture(): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:116
Returns
void
updateRenderable()
> updateRenderable(renderable): void
Defined in: node_modules/pixi.js/lib/scene/container/RenderGroup.d.ts:125
Parameters
renderable
Returns
void