• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ScenePostProcessSettings
2<!--Kit: ArkGraphics 3D-->
3<!--Subsystem: Graphics-->
4<!--Owner: @zzhao0-->
5<!--SE: @zdustc-->
6<!--TSE: @zhangyue283-->
7
8The module provides image post-processing methods (for example, tone mapping) in 3D graphics.
9
10> **NOTE**
11>
12> The initial APIs of this module are supported since API version 12. Newly added APIs will be marked with a superscript to indicate their earliest API version.
13
14## Modules to Import
15```ts
16import { ToneMappingType, ToneMappingSettings, BloomSettings, PostProcessSettings } from '@kit.ArkGraphics3D';
17```
18
19## ToneMappingType
20Enumerates the tone mapping types.
21
22**System capability**: SystemCapability.ArkUi.Graphics3D
23
24| Name| Value| Description|
25| ---- | ---- | ---- |
26| ACES | 0 | Academy Color Encoding System (ACES).|
27| ACES_2020 | 1 | ACES_2020.|
28| FILMIC | 2 | Filmic.|
29
30## ToneMappingSettings
31Describes the tone mapping settings.
32### Properties
33
34**System capability**: SystemCapability.ArkUi.Graphics3D
35
36| Name| Type| Read Only| Optional| Description|
37| ---- | ---- | ---- | ---- | ---- |
38| type | [ToneMappingType](#tonemappingtype) | No| Yes| Tone mapping type. The default value is undefined.|
39| exposure | number | No| Yes| Exposure. The value must be greater than 0. The default value is undefined.|
40
41## BloomSettings<sup>18+</sup>
42Describes the bloom settings.
43### Properties
44
45**System capability**: SystemCapability.ArkUi.Graphics3D
46
47| Name| Type| Read Only| Optional| Description|
48| ---- | ---- | ---- | ---- | ---- |
49| thresholdHard | number | No| Yes| Hard threshold. The value is a non-negative number. The default value is **1.0**.|
50| thresholdSoft | number | No| Yes| Soft threshold. The value is a non-negative number. The default value is **2.0**.|
51| scaleFactor | number | No| Yes| Scale factor. The value must be greater than 0. The default value is **1.0**.|
52| scatter | number | No| Yes| Scatter amount. The value must be greater than 0. The default value is **1.0**.|
53
54## PostProcessSettings
55Describes the post-processing settings.
56
57**System capability**: SystemCapability.ArkUi.Graphics3D
58
59| Name| Type| Read Only| Optional| Description|
60| ---- | ---- | ---- | ---- | ---- |
61| toneMapping | [ToneMappingSettings](#tonemappingsettings) | No| Yes| Tone mapping. The default value is undefined.|
62| bloom<sup>18+</sup> | [BloomSettings](#bloomsettings18) | No| Yes| Bloom. The default value is undefined.|
63