Class: RenderGroup

RenderGroup

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.

new RenderGroup ()

Implements

Members

cacheToLocalTransform

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.

inverseParentTextureTransform

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

inverseWorldTransform

Returns the inverse of the world transform matrix.

isCachedAsTexture boolean

Indicates if the container should be cached as a texture.

Default Value:
  • false

texture Texture | unknown

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

Indicates if the cached texture needs to be updated.

Default Value:
  • true

textureOffsetInverseTransform

Returns the inverse of the texture offset transform matrix.

textureOptions CacheAsTextureOptions

The options for caching the container as a texture.

Methods

addOnRender (container)

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

Name Type Description
container Container

the container to add to the onRender list