phaser - v4.0.0-rc.4
    Preparing search index...

    The SubmitterQuad RenderNode submits data for rendering a single Image-like GameObject. It uses a BatchHandler to render the image as part of a batch.

    This node receives the drawing context, game object, and parent matrix. It also receives the texturer, tinter, and transformer nodes from the node that invoked it. This allows the behavior to be configured by setting the appropriate nodes on the GameObject for individual tweaks, or on the invoking Renderer node for global changes.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    batchHandler: string

    The key of the RenderNode used to render data.

    defaultConfig: SubmitterQuadConfig

    The default configuration for this RenderNode.

    The manager that owns this RenderNode.

    name: string

    The name of the RenderNode.

    Methods

    • 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

      Returns 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

      Returns 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 TexturerImage node or an object containing equivalent data without a run method.

      • transformerNode: Object | RenderNode

        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, Image-style 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

    • 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