Engine API Reference - v2.8.0
    Preparing search index...

    Class Sky

    Implementation of the sky.

    Index

    Properties

    Accessors

    Properties

    node: GraphNode = ...

    A graph node with a transform used to render the sky mesh. Adjust the position, rotation and scale of this node to orient the sky mesh. Ignored for SKYTYPE_INFINITE.

    Accessors

    • get depthWrite(): boolean

      Returns whether depth writing is enabled for the sky.

      Returns boolean

    • set depthWrite(value: boolean): void

      Whether depth writing is enabled for the sky. Defaults to false.

      Writing a depth value for the skydome is supported when its type is not SKYTYPE_INFINITE. When enabled, the depth is written during a prepass render pass and can be utilized by subsequent passes to apply depth-based effects, such as Depth of Field.

      Note: For the skydome to be rendered during the prepass, the Sky Layer must be ordered before the Depth layer, which is the final layer used in the prepass.

      Parameters

      • value: boolean

      Returns void