bitbybit.dev v1.0.0-rc.1
    Preparing search index...
    Index

    Constructors

    • Parameters

      • Optionaldirection: Vector3
      • Optionalintensity: number
      • Optionaldiffuse: string
      • Optionalspecular: string
      • OptionalshadowGeneratorMapSize: number
      • OptionalenableShadows: boolean
      • OptionalshadowDarkness: number
      • OptionalshadowUsePercentageCloserFiltering: boolean
      • OptionalshadowContactHardeningLightSizeUVRatio: number
      • OptionalshadowBias: number
      • OptionalshadowNormalBias: number
      • OptionalshadowMaxZ: number
      • OptionalshadowMinZ: number
      • OptionalshadowRefreshRate: number

      Returns DirectionalLightDto

    Properties

    direction: Vector3

    Direction of the directional light

    [-100, -100, -100]
    
    intensity: number

    Intensity of the point light, value between 0 and 1

    0.5
    

    0

    Infinity

    0.1

    diffuse: string

    Diffuse colour of the point light

    #ffffff
    
    specular: string

    Specular colour of the point light

    #ffffff
    
    shadowGeneratorMapSize?: number

    The map size for shadow generator texture if shadows are enabled

    1024
    

    0

    Infinity

    1

    enableShadows?: boolean

    Enables shadows

    true
    
    shadowDarkness?: number

    Shadow darkness

    0
    

    0

    1

    0.1

    shadowUsePercentageCloserFiltering: boolean

    Use percentage closer filtering

    true
    
    transparencyShadow: boolean

    Sets the ability to have transparent shadow (useful for Gaussian Splatting Meshes)

    false
    
    shadowContactHardeningLightSizeUVRatio: number

    Shadow contact hardening light size UV ratio - only applies if usePercentageCloserFiltering is true

    0.2
    

    0

    Infinity

    0.1

    shadowBias: number

    Shadow bias

    0.0001
    

    0

    Infinity

    0.00001

    shadowNormalBias: number

    Shadow normal bias

    0.002
    

    0

    Infinity

    0.0001

    shadowMaxZ: number

    Shadow max Z

    1000
    

    0

    Infinity

    50

    shadowMinZ: number

    Shadow min Z

    0
    

    0

    Infinity

    50

    shadowRefreshRate: number

    Shadow refresh rate

    1
    

    0

    Infinity

    1