Class ColorGrading

Configures color grading for a View.

Located at Effects.colorGrading, which lives at View.effects.
WebGLRenderer and WebGPURenderer run it as a standalone HDR post-process before the final tonemap/sRGB canvas composite.

Index

Properties

Accessors

applied brightness contrast enabled gamma saturation temperature tint

Methods

fromParams toParams

Properties

`Readonly`view

view: View

The View this ColorGrading belongs to.

Accessors

applied

get applied(): boolean
Gets if color grading is currently applied.

Returns boolean
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:60

brightness

get brightness(): number
Linear brightness offset. Default 0.

Returns number
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:65
set brightness(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:69

contrast

get contrast(): number
Contrast multiplier around mid gray. Default 1.

Returns number
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:77
set contrast(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:81

enabled

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

gamma

get gamma(): number
Display-space gamma. Default 1.

Returns number
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:101
set gamma(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:105

saturation

get saturation(): number
Saturation multiplier. Default 1.

Returns number
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:89
set saturation(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:93

temperature

get temperature(): number
Warm/cool balance. Default 0.

Returns number
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:113
set temperature(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:117

tint

get tint(): number
Green/magenta tint balance. Default 0.

Returns number
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:125
set tint(value: number): void
Parameters
- value: number
Returns void
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:129

Methods

fromParams

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

toParams

toParams(): SDKResult<ColorGradingParams>
Gets this ColorGrading as JSON.

Returns SDKResult<ColorGradingParams>
- Defined in packages/sdk/src/viewing/viewer/ColorGrading.ts:137