Class ResolutionScale

Readonlyview

applied

• get applied(): boolean

  Gets if resolution scaling is currently applied.

  This is true when View.renderMode is in ResolutionScale.renderModes.

  Returns boolean

renderModes

• get renderModes(): number[]

  Gets which rendering modes in which to apply ResolutionScale.

  Default value is [FastRender].

  Returns number[]
• set renderModes(value: number[]): void

  Sets which rendering modes in which to apply ResolutionScale.

  Default value is [FastRender].

  Parameters

  • value: number[]

  Returns void

resolutionScale

• get resolutionScale(): number

  Gets the scale when ResolutionScale is applied.

  Default is 1.0.

  Returns number
• set resolutionScale(value: number): void

  Sets the scale when ResolutionScale is applied.

  Default is 1.0.

  Parameters

  • value: number

  Returns void

fromParams

• fromParams(resolutionScaleParams: ResolutionScaleParams): SDKResult<void>

  Configures this ResolutionScale.

  Parameters

  • resolutionScaleParams: ResolutionScaleParams

  Returns SDKResult<void>

toParams

• toParams(): SDKResult<ResolutionScaleParams>

  Gets the current configuration of this ResolutionScale.

  Returns SDKResult<ResolutionScaleParams>