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

    Camera

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    batchHandlerQuadSingleNode: BatchHandlerQuad

    The RenderNode that handles batching quads. This is used when a camera is rendering to a framebuffer, and the framebuffer needs to be drawn to the parent context.

    fillCameraNode: FillCamera

    The RenderNode that handles filling the camera with a flat color. This is used to render the camera background, flash effects, and fade effects.

    listCompositorNode: ListCompositor

    The RenderNode that handles rendering lists of children.

    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

    • Renders the children through this camera.

      Parameters

      • drawingContext: DrawingContext

        The context currently in use.

      • children: GameObject[]

        The list of children to render.

      • camera: Cameras.Scene2D.Camera

        Current Camera.

      • OptionalparentTransformMatrix: TransformMatrix

        This transform matrix is defined if the camera is focused on a filtered object.

      • OptionalforceFramebuffer: boolean

        Should the camera always draw to a new framebuffer? This will also be activated if the camera has filters enabled. Default false.

      • OptionalrenderStep: number

        Which step of the rendering process is this? This is the index of the currently running function in a list of functions. Default 0.

      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