RendererPlugin
Defined in: renderer/src/RendererPlugin.ts:18
RendererPlugin wraps PixiJS v8 behind the YAGE plugin interface.
Implements
Section titled “Implements”Plugin
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RendererPlugin(
config):RendererPlugin
Defined in: renderer/src/RendererPlugin.ts:31
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”RendererPlugin
Properties
Section titled “Properties”
readonlyname:"renderer"="renderer"
Defined in: renderer/src/RendererPlugin.ts:19
Unique plugin name.
Implementation of
Section titled “Implementation of”Plugin.name
version
Section titled “version”
readonlyversion:"2.0.0"="2.0.0"
Defined in: renderer/src/RendererPlugin.ts:20
Semantic version string.
Implementation of
Section titled “Implementation of”Plugin.version
Accessors
Section titled “Accessors”application
Section titled “application”Get Signature
Section titled “Get Signature”get application():
Application
Defined in: renderer/src/RendererPlugin.ts:129
The PixiJS Application instance.
Returns
Section titled “Returns”Application
canvas
Section titled “canvas”Get Signature
Section titled “Get Signature”get canvas():
HTMLCanvasElement
Defined in: renderer/src/RendererPlugin.ts:134
The canvas element.
Returns
Section titled “Returns”HTMLCanvasElement
layers
Section titled “layers”Get Signature
Section titled “Get Signature”get layers():
RenderLayerManager
Defined in: renderer/src/RendererPlugin.ts:144
The layer manager.
Returns
Section titled “Returns”virtualSize
Section titled “virtualSize”Get Signature
Section titled “Get Signature”get virtualSize():
object
Defined in: renderer/src/RendererPlugin.ts:139
Virtual resolution size.
Returns
Section titled “Returns”object
height
Section titled “height”height:
number
width:
number
Methods
Section titled “Methods”createScreenContainer()
Section titled “createScreenContainer()”createScreenContainer(
name,opts?):RenderLayerManager
Defined in: renderer/src/RendererPlugin.ts:164
Create a screen-space container as a sibling of the world container. Not affected by the camera transform. Returns a RenderLayerManager for creating named layers within the container.
Parameters
Section titled “Parameters”string
eventMode?
Section titled “eventMode?”EventMode
Returns
Section titled “Returns”createTexture()
Section titled “createTexture()”createTexture(
draw):Texture
Defined in: renderer/src/RendererPlugin.ts:149
Create a texture by drawing into a temporary graphics context.
Parameters
Section titled “Parameters”(graphics) => void
Returns
Section titled “Returns”Texture
destroyScreenContainer()
Section titled “destroyScreenContainer()”destroyScreenContainer(
name):void
Defined in: renderer/src/RendererPlugin.ts:181
Destroy a screen-space container and all its children.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
install()
Section titled “install()”install(
context):Promise<void>
Defined in: renderer/src/RendererPlugin.ts:37
Install services into the engine context. Called in topological order.
Parameters
Section titled “Parameters”context
Section titled “context”EngineContext
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”Plugin.install
onDestroy()
Section titled “onDestroy()”onDestroy():
void
Defined in: renderer/src/RendererPlugin.ts:119
Called when the engine is destroyed.
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.onDestroy
registerSystems()
Section titled “registerSystems()”registerSystems(
scheduler):void
Defined in: renderer/src/RendererPlugin.ts:115
Register systems with the scheduler. Called after install.
Parameters
Section titled “Parameters”scheduler
Section titled “scheduler”SystemScheduler
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Plugin.registerSystems