Bitbybit Docs
    Preparing search index...

    Class SkyMaterialDto (Inputs.BabylonMaterial)

    Feeds babylon.material.skyMaterial.create: the atmosphere settings of a procedural sky and where its sun stands. Values left out keep the engine's defaults.

    Index

    Constructors

    • Parameters

      • Optionalluminance: number
      • Optionalturbidity: number
      • Optionalrayleigh: number
      • OptionalmieCoefficient: number
      • OptionalmieDirectionalG: number
      • Optionaldistance: number
      • Optionalinclination: number
      • Optionalazimuth: number
      • OptionalsunPosition: Vector3
      • OptionaluseSunPosition: boolean
      • OptionalcameraOffset: Vector3
      • Optionalup: Vector3
      • Optionaldithering: boolean

      Returns SkyMaterialDto

    Properties

    luminance: number

    Overall brightness of the sky, between 0 and 1

    1
    

    0

    1

    0.01

    turbidity: number

    How hazy the air is; more haze whitens the sky and spreads the glow of the sun

    10
    

    0

    Infinity

    1

    rayleigh: number

    How strongly light scatters the way that makes a clear sky blue; higher is a deeper blue

    2
    

    0

    Infinity

    1

    mieCoefficient: number

    How much haze gathers around the sun, between 0 and 0.1; more makes a wider, whiter glow

    0.005
    

    0

    Infinity

    0.001

    mieDirectionalG: number

    How tightly the haze glow gathers around the sun; near 1 gives a small bright halo, lower spreads it

    0.8
    

    0

    Infinity

    0.1

    distance: number

    How far the sky dome sits from the camera, which changes how the horizon reads

    500
    

    0

    Infinity

    10

    inclination: number

    How high the sun stands, from -0.5 below the horizon through 0 at the horizon to 0.5 overhead

    0.49
    

    -0.5

    0.5

    0.01

    azimuth: number

    Where around the horizon the sun stands, from 0 to 1 for a full turn

    0.25
    

    0

    1

    0.01

    sunPosition?: Vector3

    An explicit direction to the sun, used only while useSunPosition is true; otherwise it is derived from the inclination and azimuth

    undefined
    

    true

    useSunPosition: boolean

    When true, the sun is placed from sunPosition; when false, from inclination and azimuth

    false
    
    cameraOffset?: Vector3

    An offset vector that shifts the horizon relative to the camera

    undefined
    

    true

    up: number[]

    The direction the sky treats as up; [0, 1, 0] for the usual Y-up scene

    [0, 1, 0]
    
    dithering: boolean

    When true, fine noise hides color banding in the smooth gradients of the sky

    false