RSX Code Reference
    Preparing search index...
    • rsx
    • AnalyticalSkyParameters

    Class AnalyticalSkyParameters

    Class that triggers an onDirty event when one of its members changes.

    Index
    • get isEnabled(): boolean

      Enables or disables Analytical Sky.

      Returns boolean

    • set isEnabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isMoonCastingShadows(): boolean

      Moon light will casts shadows if true.

      Returns boolean

    • set isMoonCastingShadows(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isMoonEnabled(): boolean

      Enables/disables rendering of the moon.

      Returns boolean

    • set isMoonEnabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isMoonRenderToSkyboxEnabled(): boolean

      Determines if moon is added to the skybox. Only works when not using a unique skybox texture.

      Returns boolean

    • set isMoonRenderToSkyboxEnabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isRenderingStarsAllWhite(): boolean

      Determines if stars are all white colored.

      Returns boolean

    • set isRenderingStarsAllWhite(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isRenderingStarsAsOnePixel(): boolean

      Determines if stars are drawn as pixels.

      Returns boolean

    • set isRenderingStarsAsOnePixel(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isRenderingStarsWithSameBrightness(): boolean

      Determines if stars are all same brightness.

      Returns boolean

    • set isRenderingStarsWithSameBrightness(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isRenderingTexturedStars(): boolean

      Determines if stars are textured or not.

      Returns boolean

    • set isRenderingTexturedStars(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isStarsEnabled(): boolean

      Enables/disables rendering of the stars.

      Returns boolean

    • set isStarsEnabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isStarsRenderToSkyboxEnabled(): boolean

      Determines if stars are added to the skybox. Only works when not using a unique skybox texture.

      Returns boolean

    • set isStarsRenderToSkyboxEnabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isSunCastingShadows(): boolean

      Sun light will casts shadows if true.

      Returns boolean

    • set isSunCastingShadows(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get moonAltitude(): rsx.Degree

      Moon altitude, [-90;90], 0 locates in the horizon, 90 is Moon at zenith. In degrees.

      Returns rsx.Degree

    • set moonAltitude(value: rsx.Degree): void

      Parameters

      Returns void

    • get moonBrightness(): number

      Moon radiance multiplier.

      Returns number

    • set moonBrightness(value: number): void

      Parameters

      • value: number

      Returns void

    • get moonSize(): number

      The size scale of the Moon.

      Returns number

    • set moonSize(value: number): void

      Parameters

      • value: number

      Returns void

    • get starsBrightness(): number

      Stars radiance multiplier.

      Returns number

    • set starsBrightness(value: number): void

      Parameters

      • value: number

      Returns void

    • get starsSize(): number

      The size scale of the stars. Just pure draw value.

      Returns number

    • set starsSize(value: number): void

      Parameters

      • value: number

      Returns void

    • get sunAltitude(): rsx.Degree

      Sun altitude, [-90;90], 0 is dusk/dawn, 90 is sun at zenith. In degrees.

      Returns rsx.Degree

    • set sunAltitude(value: rsx.Degree): void

      Parameters

      Returns void

    • get sunCoronaSize(): number

      The Sun corona's size. Just pure draw value, it doesn't affect on atmosphere intensities.

      Returns number

    • set sunCoronaSize(value: number): void

      Parameters

      • value: number

      Returns void

    • get sunIntensity(): number

      Sun radiance multiplier. By default sky is as bright as Earth's Sun.

      Returns number

    • set sunIntensity(value: number): void

      Parameters

      • value: number

      Returns void

    • get sunSize(): number

      The size scale of the Sun. Just pure draw value, it affects on atmosphere intensities proportionally.

      Returns number

    • set sunSize(value: number): void

      Parameters

      • value: number

      Returns void

    • Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.

      Parameters

      • action: () => void

        The scope where the object is modified.

      Returns void

    onDirty: Event<[dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>]>

    Event that is triggered when a member changes.