ClassRendering & Filters@public

FlxCameraRenderer

Pixi render-texture adapter for one logical world and any number of cameras.

export declare class FlxCameraRenderer implements FlxCameraHost

Constructors

constructor(renderer: Renderer, outputStage: Container, context: FlxContext)

Constructs a new instance of the FlxCameraRenderer class

Parameter	Type	Description
renderer	Renderer	-
outputStage	Container	-
context	FlxContext	-

Properties

Property	Modifiers	Type	Description
cameraCount	readonly	number	-
debugBounds	-	boolean	-
destroyed	readonly	boolean	-
registeredObjectCount	readonly	number	-
registeredObjects	readonly	IterableIterator<FlxSprite | FlxTilemap | FlxEmitter>	-
renderTargetBytes	readonly	number	-
selectedObject	-	FlxObject | null	-

Methods

add()

add(object: FlxSprite | FlxTilemap | FlxEmitter, emitterOptions?: FlxEmitterRenderOptions): FlxRenderHandle

Parameters:

Parameter	Type	Description
object	FlxSprite | FlxTilemap | FlxEmitter	-
emitterOptions	FlxEmitterRenderOptions	-

Returns: FlxRenderHandle

addCamera()

addCamera(camera: FlxCamera): void

Parameters:

Parameter	Type	Description
camera	FlxCamera	-

Returns: void

clearObjects()

clearObjects(): void

Returns: void

destroy()

destroy(): void

Returns: void

getCameraView()

getCameraView(camera: FlxCamera): FlxCameraView | null

Parameters:

Parameter	Type	Description
camera	FlxCamera	-

Returns: FlxCameraView | null

pickObject()

pickObject(point: Readonly<PointLike>): FlxCameraObjectPick | null

Picks the topmost registered object at a logical screen coordinate.

Parameters:

Parameter	Type	Description
point	Readonly<PointLike>	-

Returns: FlxCameraObjectPick | null

remove()

remove(object: FlxSprite | FlxTilemap | FlxEmitter, destroyHandle?: boolean): boolean

Parameters:

Parameter	Type	Description
object	FlxSprite | FlxTilemap | FlxEmitter	-
destroyHandle	boolean	-

Returns: boolean

removeCamera()

removeCamera(camera: FlxCamera): void

Parameters:

Parameter	Type	Description
camera	FlxCamera	-

Returns: void

render()

render(cameras?: readonly FlxCamera[], interpolationAlpha?: number): void

Render selected cameras, optionally between their previous and current fixed states.

Parameters:

Parameter	Type	Description
cameras	readonly FlxCamera[]	-
interpolationAlpha	number	-

Returns: void

resize()

resize(resolution?: number): void

Parameters:

Parameter	Type	Description
resolution	number	-

Returns: void

snapshotCamera()

snapshotCamera(camera: FlxCamera): Promise<{ height: number; pixels: Uint8ClampedArray; width: number; }>

Asynchronously extracts rendered RGBA pixel data for a camera.

Parameters:

Parameter	Type	Description
camera	FlxCamera	-

Returns: Promise<{ height: number; pixels: Uint8ClampedArray; width: number; }>