Class AntiAliasing

Configures the final antialiasing post-process pass for a View.

Located at Effects.antiAliasing, which lives at View.effects.
Disabled by default. Set enabled to true or pass effects: {antiAliasing: {enabled: true}} when creating a View.
FXAA/SMAA run after Tonemap so they see final LDR colours.
Has no effect when the renderer has fallen back to LDR mode (no HDR target), since there's no intermediate texture to filter from.

Index

Properties

Accessors

applied enabled mode

Methods

fromParams toParams

Properties

`Readonly`view

view: View

The View this AntiAliasing belongs to.

Accessors

applied

get applied(): boolean
Gets if AntiAliasing is currently applied.

This is true when the component enabled state is in the component enabled state.

Returns boolean
- Defined in packages/sdk/src/viewing/viewer/AntiAliasing.ts:57

enabled

get enabled(): boolean
Returns boolean
- Defined in packages/sdk/src/viewing/viewer/AntiAliasing.ts:37
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/sdk/src/viewing/viewer/AntiAliasing.ts:30

mode

get mode(): AntiAliasingMode
AA mode. Default "smaa".

Returns AntiAliasingMode
- Defined in packages/sdk/src/viewing/viewer/AntiAliasing.ts:62
set mode(value: AntiAliasingMode): void
Parameters
- value: AntiAliasingMode
Returns void
- Defined in packages/sdk/src/viewing/viewer/AntiAliasing.ts:66

Methods

fromParams

fromParams(params: AntiAliasingParams): SDKResult<any>
Configures this AntiAliasing.
Parameters
- params: AntiAliasingParams
Returns SDKResult<any>
- Defined in packages/sdk/src/viewing/viewer/AntiAliasing.ts:85

toParams

toParams(): SDKResult<AntiAliasingParams>
Gets this AntiAliasing as JSON.

Returns SDKResult<AntiAliasingParams>
- Defined in packages/sdk/src/viewing/viewer/AntiAliasing.ts:74