pixi.js
    Preparing search index...

    Class RenderGroupAdvanced

    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.

    Implements

    Index

    Constructors

    Properties

    canBundle: boolean = false

    true if this instruction can be compiled into a WebGPU bundle

    childrenRenderablesToUpdate: {
        index: number;
        list: Container<ContainerChild>[];
    } = ...
    childrenToUpdate: Record<number, { index: number; list: Container[] }> = ...
    gcTick: number = 0
    instructionSet: InstructionSet = ...
    isCachedAsTexture: boolean = false

    Indicates if the container should be cached as a texture.

    false
    
    renderGroupChildren: RenderGroup[] = []
    renderGroupParent: RenderGroup = null
    renderPipeId: string = 'renderGroup'

    a the id of the render pipe that can run this instruction

    root: Container = null
    structureDidChange: boolean = true
    texture?: Texture

    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: boolean = true

    Indicates if the cached texture needs to be updated.

    true
    
    textureOptions: CacheAsTextureOptions

    The options for caching the container as a texture.

    updateTick: number = 0
    worldAlpha: number = 1
    worldColor: number = 0xffffff
    worldColorAlpha: number = 0xffffffff
    worldTransform: Matrix = ...

    Accessors

    • get cacheToLocalTransform(): Matrix

      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 Matrix

      The transform matrix for the cached texture coordinate space, or null if no parent is cached as texture.

    • get inverseParentTextureTransform(): Matrix

      Returns the inverse of the parent texture transform matrix. This is used to properly transform coordinates when rendering into cached textures.

      Returns Matrix

      The inverse of the parent texture transform matrix.

    • get inverseWorldTransform(): Matrix

      Returns the inverse of the world transform matrix.

      Returns Matrix

      The inverse of the world transform matrix.

    • get isRenderable(): boolean

      Returns boolean

    • get textureOffsetInverseTransform(): Matrix

      Returns the inverse of the texture offset transform matrix.

      Returns Matrix

      The inverse of the texture offset transform matrix.

    Methods

    • adding a container to the onRender list will make sure the user function passed in to the user defined 'onRender` callBack

      Parameters

      • container: Container

        the container to add to the onRender list

      Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void