Class LayerPixiRenderer

The renderer for a gdjs.Layer using Pixi.js.

Constructors

constructor

new LayerPixiRenderer(layer, runtimeInstanceContainerRenderer, runtimeGameRenderer): LayerPixiRenderer
Parameters
- layer: RuntimeLayer
  The layer
- runtimeInstanceContainerRenderer: RuntimeInstanceContainerPixiRenderer
  The scene renderer
- runtimeGameRenderer: RuntimeGamePixiRenderer
Returns LayerPixiRenderer
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:62

Properties

`Static` `Private` vectorForProjections

vectorForProjections: null | Vector3 = null

`Static` `Private` `Readonly` zeroZOrderForPixi

zeroZOrderForPixi: number = ...

Pixi doesn't sort children with zIndex == 0.

Methods

add3DRendererObject

add3DRendererObject(object): void
Parameters
- object: Object3D<Object3DEventMap>
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:637

addPostProcessingPass

addPostProcessingPass(pass): void
Parameters
- pass: Pass
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:148

addRendererObject

addRendererObject(pixiChild, zOrder): void
Add a child to the pixi container associated to the layer. All objects which are on this layer must be children of this container.
Parameters
- pixiChild: any
  The child (PIXI object) to be added.
- zOrder: number
  The z order of the associated object.
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:602

changeRendererObjectZOrder

changeRendererObjectZOrder(pixiChild, newZOrder): void
Change the z order of a child associated to an object.
Parameters
- pixiChild: any
  The child (PIXI object) to be modified.
- newZOrder: number
  The z order of the associated object.
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:614

getLightingSprite

getLightingSprite(): null | Sprite
The sprite, displaying the "render texture" of the layer, to display for a lighting layer.

Returns null | Sprite
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:189

getRendererObject

getRendererObject(): Container<DisplayObject>
Returns Container<DisplayObject>
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:129

getThreeCamera

getThreeCamera(): null | PerspectiveCamera | OrthographicCamera
Returns null | PerspectiveCamera | OrthographicCamera
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:137

getThreeEffectComposer

getThreeEffectComposer(): null | EffectComposer
Returns null | EffectComposer
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:144

getThreeScene

getThreeScene(): null | Scene
Returns null | Scene
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:133

has2DObjects

has2DObjects(): boolean
Returns boolean
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:633

has3DObjects

has3DObjects(): boolean
Returns boolean
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:629

hasPostProcessingPass

hasPostProcessingPass(): boolean
Returns boolean
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:175

isCameraRotatedIn3D

isCameraRotatedIn3D(): null | boolean
Returns null | boolean
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:510

onCreated

onCreated(): void
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:98

onGameResolutionResized

onGameResolutionResized(): void
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:104

remove3DRendererObject

remove3DRendererObject(object): void
Parameters
- object: Object3D<Object3DEventMap>
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:643

removePostProcessingPass

removePostProcessingPass(pass): void
Parameters
- pass: Pass
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:168

removeRendererObject

removeRendererObject(child): void
Remove a child from the internal pixi container. Should be called when an object is deleted or removed from the layer.
Parameters
- child: any
  The child (PIXI object) to be removed.
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:625

renderOnPixiRenderTexture

renderOnPixiRenderTexture(pixiRenderer): void
Render the layer of the PixiJS RenderTexture, so that it can be then displayed with a blend mode (for a lighting layer) or consumed by Three.js (for 2D+3D layers).
Parameters
- pixiRenderer: Renderer
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:689

setThreeCameraDirty

setThreeCameraDirty(enable): void
Parameters
- enable: boolean
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:380

show2DRenderingPlane

show2DRenderingPlane(enable): void
Parameters
- enable: boolean
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:384

transformTo3DWorld

transformTo3DWorld(screenX, screenY, worldZ, cameraId, result): FloatPoint
Parameters
- screenX: number
- screenY: number
- worldZ: number
- cameraId: number
- result: FloatPoint
Returns FloatPoint
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:518

updateClearColor

updateClearColor(): void
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:649

updatePosition

updatePosition(): void
Update the position of the PIXI container. To be called after each change made to position, zoom or rotation of the camera.

Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:394

updatePreRender

updatePreRender(): void
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:585

updateResolution

updateResolution(): void
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:500

updateThreePlaneTextureFromPixiRenderTexture

updateThreePlaneTextureFromPixiRenderTexture(threeRenderer, pixiRenderer): void
Set the texture of the 2D plane in the 3D world to be the same WebGL texture as the PixiJS RenderTexture - so that the 2D rendering can be shown in the 3D world.
Parameters
- threeRenderer: WebGLRenderer
- pixiRenderer: Renderer
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:729

updateVisibility

updateVisibility(visible): void
Parameters
- visible: boolean
Returns void
- Defined in GDJS/Runtime/pixi-renderers/layer-pixi-renderer.ts:580