Class SubmitterTile

The SubmitterTile RenderNode submits data for tiles.

Hierarchy (View Summary)

SubmitterQuad
- SubmitterTile

Index

Constructors

Properties

batchHandler defaultConfig manager name

Methods

onRunBegin onRunEnd run setDebug

Constructors

constructor

new SubmitterTile(
manager: WebGLRenderer,
config?: SubmitterQuadConfig,
): SubmitterTile
Parameters
- manager: WebGLRenderer
  The WebGLRenderer that owns this Submitter.
- Optionalconfig: SubmitterQuadConfig
  The configuration object for this Submitter. This is a SubmitterQuad configuration object with the name defaulting to SubmitterTile.
Returns SubmitterTile
Overrides SubmitterQuad.constructor
- Defined in types/phaser.d.ts:101410

Properties

batchHandler

batchHandler: string

The key of the RenderNode used to render data.

defaultConfig

defaultConfig: SubmitterQuadConfig

The default configuration for this RenderNode.

manager

manager: RenderNodeManager

The manager that owns this RenderNode.

name

name: string

The name of the RenderNode.

Methods

onRunBegin

onRunBegin(drawingContext: DrawingContext): void
By default this is an empty method hook that you can override and use in your own custom render nodes.

This method is called at the start of the run method. Don't forget to call it in your custom method.
Parameters
- drawingContext: DrawingContext
  The context currently in use.
Returns void
Inherited from SubmitterQuad.onRunBegin
- Defined in types/phaser.d.ts:100650

onRunEnd

onRunEnd(drawingContext: DrawingContext): void
By default this is an empty method hook that you can override and use in your own custom render nodes.

This method is called at the end of the run method. Don't forget to call it in your custom method.
Parameters
- drawingContext: DrawingContext
  The context currently in use.
Returns void
Inherited from SubmitterQuad.onRunEnd
- Defined in types/phaser.d.ts:100659

run

run(
    drawingContext: DrawingContext,
    gameObject: GameObject,
    parentMatrix: TransformMatrix,
    element: object,
    texturerNode: RenderNode,
    transformerNode: Object | TransformerTileSprite,
    tinterNode?: RenderNode | Omit<RenderNode, "run">,
    normalMap?: WebGLTextureWrapper,
    normalMapRotation?: number,
): void
Submit data for rendering.
Parameters
- drawingContext: DrawingContext
  The current drawing context.
- gameObject: GameObject
  The GameObject being rendered.
- parentMatrix: TransformMatrix
  The parent matrix of the GameObject.
- element: object
  The specific element within the game object. This is used for objects that consist of multiple quads.
- texturerNode: RenderNode
  The texturer node used to texture the GameObject. You may pass a TexturerTileSprite node or an object containing equivalent data without a run method.
- transformerNode: Object | TransformerTileSprite
  The transformer node used to transform the GameObject. You may pass a transformer node or an object with a quad property.
- OptionaltinterNode: RenderNode | Omit<RenderNode, "run">
  The tinter node used to tint the GameObject. You may pass a tinter node or an object containing equivalent data without a run method. If omitted, no tinting will be used.
- OptionalnormalMap: WebGLTextureWrapper
  The normal map texture to use for lighting. If omitted, the normal map texture of the GameObject will be used, or the default normal map texture of the renderer.
- OptionalnormalMapRotation: number
  The rotation of the normal map texture. If omitted, the rotation of the GameObject will be used.
Returns void
Overrides SubmitterQuad.run
- Defined in types/phaser.d.ts:101429

setDebug

setDebug(debug: boolean): void
Set whether the node should report debug information. It wraps the run method with additional debug information.
Parameters
- debug: boolean
  Whether to report debug information.
Returns void
Inherited from SubmitterQuad.setDebug
- Defined in types/phaser.d.ts:100666