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

    A RenderNode which renders a filled rectangle. This is useful for full-screen effects and rectangle geometry.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    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

    • Render the rectangle.

      Parameters

      • drawingContext: DrawingContext

        The context currently in use.

      • currentMatrix: TransformMatrix

        A transform matrix to apply to the vertices. If not defined, the identity matrix is used.

      • submitterNode: BatchHandlerTriFlat

        The Submitter node to use. If not defined, BatchHandlerTriFlat is used.

      • x: number

        The x-coordinate of the rectangle.

      • y: number

        The y-coordinate of the rectangle.

      • width: number

        The width of the rectangle.

      • height: number

        The height of the rectangle.

      • tintTL: number

        The top-left tint color.

      • tintTR: number

        The top-right tint color.

      • tintBL: number

        The bottom-left tint color.

      • tintBR: number

        The bottom-right tint color.

      • lighting: boolean

        Whether to apply lighting effects to the rectangle.

      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