Class CloudParameters

constructor

• new CloudParameters(isInternalConstructor?): CloudParameters

• Parameters

  • OptionalisInternalConstructor: boolean

  Returns CloudParameters

baseNoiseFrequency

• get baseNoiseFrequency(): number

• Frequency of base noise texture sampling. Allows control over how general shape is generated, but selecting too high value will make repetitiveness more visible.

  Returns number
• set baseNoiseFrequency(value): void

• Parameters

  • value: number

  Returns void

brightness

• get brightness(): number

• Allows modifications of clouds overall brightness. Value of 0 will effectively make them black. There is no upper limit, but values above of 1 may cause them to look excessively bright.

  Returns number
• set brightness(value): void

• Parameters

  • value: number

  Returns void

cloudBottom

• get cloudBottom(): number

• Height (in meters) of cloud layer bottom plane. Entire clouds layer will be contained between CloudBottom and CloudTop The smaller difference between bottom and top is - the better result.

  Returns number
• set cloudBottom(value): void

• Parameters

  • value: number

  Returns void

cloudCoverage

• get cloudCoverage(): number

• Coverage multiplier that allows to expand clouds without change in coverage texture. Setting it to 1 will create almost fully clouded sky, while value of 0 will keep clouds strictly in limits defined by coverage texture.

  Returns number
• set cloudCoverage(value): void

• Parameters

  • value: number

  Returns void

cloudSize

• get cloudSize(): Immutable<Vector2>

• World space extent of space corresponding to set coverage/type texture. Texture will be centered on XZ (0, 0). Values are in meters.

  Returns Immutable<Vector2>
• set cloudSize(value): void

• Parameters

  • value: Immutable<Vector2>

  Returns void

cloudTop

• get cloudTop(): number

• Height (in meters) of cloud layer top plane. Entire clouds layer will be contained between CloudBottom and CloudTop The smaller difference between bottom and top is - the better result.

  Returns number
• set cloudTop(value): void

• Parameters

  • value: number

  Returns void

densityMultiplier

• get densityMultiplier(): number

• Multiplier used on sampled cloud density. Can be used to create "lighter" or more "heavy, dark" looks.

  Returns number
• set densityMultiplier(value): void

• Parameters

  • value: number

  Returns void

detailNoiseFrequency

• get detailNoiseFrequency(): number

• Frequency of details noise texture sampling. Allows control over how details are eroded, but selecting too high value will make repetitiveness very visible.

  Returns number
• set detailNoiseFrequency(value): void

• Parameters

  • value: number

  Returns void

detailNoiseStrength

• get detailNoiseStrength(): number

• Strength of details erosion that shapes clouds. Values close to zero will make clouds more blocky while higher values will make them more fragile

  Returns number
• set detailNoiseStrength(value): void

• Parameters

  • value: number

  Returns void

isEnabled

• get isEnabled(): boolean

• Returns boolean

• set isEnabled(value): void

• Parameters

  • value: boolean

  Returns void

isShadowsEnabled

• get isShadowsEnabled(): boolean

• Enables cloud shadows for sun light.

  Returns boolean
• set isShadowsEnabled(value): void

• Parameters

  • value: boolean

  Returns void

isTemporalFilterEnabled

• get isTemporalFilterEnabled(): boolean

• Performs a temporal filtering step between current frame cloud rendering and previous frame cloud rendering. Ignored if temporal AA is enabled.

  Returns boolean
• set isTemporalFilterEnabled(value): void

• Parameters

  • value: boolean

  Returns void

reprojectionBlendFactor

• get reprojectionBlendFactor(): number

• Base blend factor for reprojection blending. Values reprojected from previous frame are blended with new results according to this factor (modified in some special cases). Smaller values (less impact of new frame) is more suitable for scenes with slow or no wind to enhance visual quality. Higher values are preferable in scenes with fast wind.

  Returns number
• set reprojectionBlendFactor(value): void

• Parameters

  • value: number

  Returns void

scatteringEccentricity

• get scatteringEccentricity(): number

• Base Henyey-Greenstein function eccentricity parameter g.

  Returns number
• set scatteringEccentricity(value): void

• Parameters

  • value: number

  Returns void

scatteringSilverIntensity

• get scatteringSilverIntensity(): number

• Intensity of secondary Henyey-Greenstein function used to enhance light scattering. Useful in dusk/dawn scenarios to apply additional scattered light.

  Returns number
• set scatteringSilverIntensity(value): void

• Parameters

  • value: number

  Returns void

scatteringSilverSpread

• get scatteringSilverSpread(): number

• Equivalent of scattering eccentricity for secondary HG function.

  Returns number
• set scatteringSilverSpread(value): void

• Parameters

  • value: number

  Returns void

typeTexture

• get typeTexture(): Texture

• Texture that will be used by cloud system to generate clouds. Values in range [0;1] will be interpreted as: Cumulus: 1.0 Stratocumulus: 0.5 Stratus: 0.0 Any value in between these will cause interpolation of type characteristics: - bottom height - upper height

  • haziness of bottom and top edges

  Returns Texture
• set typeTexture(value): void

• Texture that will be used by cloud system to generate clouds. Values in range [0;1] will be interpreted as: Cumulus: 1.0 Stratocumulus: 0.5 Stratus: 0.0 Any value in between these will cause interpolation of type characteristics: - bottom height - upper height

  • haziness of bottom and top edges

  Parameters

  • value: Texture

  Returns void

typeTextureHandle

• get typeTextureHandle(): ResourceHandle<Texture>

• Texture that will be used by cloud system to generate clouds. Values in range [0;1] will be interpreted as: Cumulus: 1.0 Stratocumulus: 0.5 Stratus: 0.0 Any value in between these will cause interpolation of type characteristics: - bottom height - upper height

  • haziness of bottom and top edges

  Returns ResourceHandle<Texture>
• set typeTextureHandle(value): void

• Parameters

  • value: Texture | ResourceHandle<Texture>

  Returns void

windDirection

• get windDirection(): rsx.Degree

• Direction of wind in degrees from positive X.

  Returns rsx.Degree
• set windDirection(value): void

• Parameters

  • value: rsx.Degree

  Returns void

windSpeed

• get windSpeed(): number

• Speed (in m/s) of wind defined as noise sampling offset. Allows illusion of moving clouds - they shape changes over time but in reality general shape stays in place.

  Returns number
• set windSpeed(value): void

• Parameters

  • value: number

  Returns void

markAsDirty

• markAsDirty(dirtyFlags): void

• Marks the object as dirty.

  Parameters

  • dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>

    Flags specifying what kind of member was changed.

  Returns void

modify

• modify(action): 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.

    • • (): void

      • Returns void

  Returns void

ReadonlyonDirty