PIXI.extensions

namespace extensions

Global registration of all PixiJS extensions. One-stop-shop for extensibility.

Summary

PIXI.extensions	add(extensions: Array<PIXI.ExtensionFormatLoose \| any>)
PIXI.extensions	handle(type: PIXI.ExtensionType, onAdd: ExtensionHandler, onRemove: ExtensionHandler)
PIXI.extensions	handleByList(type: PIXI.ExtensionType, list: any[])
PIXI.extensions	handleByMap(type: PIXI.ExtensionType, map: Record<string, any>)
PIXI.extensions	remove(extensions: Array<PIXI.ExtensionFormatLoose \| any>)

add index.ts:130

add(extensions: Array<PIXI.ExtensionFormatLoose | any>) → {PIXI.extensions}

Parameters:
Name	Type	Description
extensions	Array<PIXI.ExtensionFormatLoose \| any>	The spread of extensions to add to PixiJS.

Returns:
Type	Description
PIXI.extensions	For chaining.

handle index.ts:160

handle(type: PIXI.ExtensionType, onAdd: ExtensionHandler, onRemove: ExtensionHandler) → {PIXI.extensions}

Internal method to handle extensions by name.

Parameters:
Name	Type	Description
type	PIXI.ExtensionType	The extension type.
onAdd	ExtensionHandler	Function for handling when extensions are added/registered passes PIXI.ExtensionFormat.
onRemove	ExtensionHandler	Function for handling when extensions are removed/unregistered passes PIXI.ExtensionFormat.

Returns:
Type	Description
PIXI.extensions	For chaining.

handleByList index.ts:215

handleByList(type: PIXI.ExtensionType, list: any[]) → {PIXI.extensions}

Handle a type, but using a list of extensions.

Parameters:
Name	Type	Description
type	PIXI.ExtensionType	Type of extension to handle.
list	any[]	The list of extensions.

Returns:
Type	Description
PIXI.extensions	For chaining.

handleByMap index.ts:195

handleByMap(type: PIXI.ExtensionType, map: Record<string, any>) → {PIXI.extensions}

Handle a type, but using a map by name property.

Parameters:
Name	Type	Description
type	PIXI.ExtensionType	Type of extension to handle.
map	Record<string, any>	The object map of named extensions.

Returns:
Type	Description
PIXI.extensions	For chaining.

remove index.ts:115

remove(extensions: Array<PIXI.ExtensionFormatLoose | any>) → {PIXI.extensions}

Remove extensions from PixiJS.

Parameters:
Name	Type	Description
extensions	Array<PIXI.ExtensionFormatLoose \| any>	Extensions to be removed.

Returns:
Type	Description
PIXI.extensions	For chaining.