Class MotionBlurSettings

Class that notifies its parent ManagedSettigns or ManagedSubSettings object when one of its members changes.

Hierarchy

FrameworkObject
- MotionBlurSettings

Index

Constructors

Accessors

cameraScale deconstructionQuality domain filter globalScale isEnabled jitter maxAllowedAliasing objectScale quality radius

Methods

markAsDirty modify

Constructors

`Protected`constructor

new MotionBlurSettings(isInternalConstructor?): MotionBlurSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns MotionBlurSettings
Overrides FrameworkObject.constructor

Accessors

cameraScale

get cameraScale(): number
Determines the scale of the motion blur effect in camera space, exaggerate or attenuating the amount of it.

Returns number
set cameraScale(value): void
Parameters
- value: number
Returns void

deconstructionQuality

get deconstructionQuality(): EnumValue<MotionBlurDeconstructionQuality, number>
Determines the deconstruction quality. The lower the more trail & aliased effect. Reconstruction only.

Returns EnumValue<MotionBlurDeconstructionQuality, number>
set deconstructionQuality(value): void
Parameters
- value: EnumValue<MotionBlurDeconstructionQuality, number>
Returns void

domain

get domain(): EnumValue<MotionBlurDomain, number>
Determines which parts of the scene will trigger motion blur.

Returns EnumValue<MotionBlurDomain, number>
set domain(value): void
Parameters
- value: EnumValue<MotionBlurDomain, number>
Returns void

filter

get filter(): EnumValue<MotionBlurFilter, number>
Type of filter to use when filtering samples contributing to a blurred pixel.

Returns EnumValue<MotionBlurFilter, number>
set filter(value): void
Parameters
- value: EnumValue<MotionBlurFilter, number>
Returns void

globalScale

get globalScale(): number
Determines the scale of the motion blur effect globally, exaggerate or attenuating the amount of it.

Returns number
set globalScale(value): void
Parameters
- value: number
Returns void

isEnabled

get isEnabled(): boolean
Enables or disables the motion blur effect.

Returns boolean
set isEnabled(value): void
Parameters
- value: boolean
Returns void

jitter

get jitter(): Immutable<Vector4>
Determines the jitter factor for each stage starting from the seed to the d-blur sampling use wisely or it can Create ugly sampling artifacts.

Returns Immutable<Vector4>
set jitter(value): void
Parameters
- value: Immutable<Vector4>
Returns void

maxAllowedAliasing

get maxAllowedAliasing(): number
Controls the maximum amount of d-blur over a maximum amount of aliasing cost (ie: 1.0f no aliasing). Only for Simple type.

Returns number
set maxAllowedAliasing(value): void
Parameters
- value: number
Returns void

objectScale

get objectScale(): number
Determines the scale of the motion blur effect in object space, exaggerate or attenuating the amount of it.

Returns number
set objectScale(value): void
Parameters
- value: number
Returns void

quality

get quality(): EnumValue<MotionBlurQuality, number>
Determines the number of samples to take during motion blur filtering. Increasing this value will yield higher quality blur at the cost of the performance.

Returns EnumValue<MotionBlurQuality, number>
set quality(value): void
Parameters
- value: EnumValue<MotionBlurQuality, number>
Returns void

radius

get radius(): number
Determines the maximum radius applied for the d-blur.

Returns number
set radius(value): void
Parameters
- value: number
Returns void

Methods

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