• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2024-2024 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @file Defines 3D post process related interfaces
18 * @kit ArkGraphics3D
19 */
20
21/**
22 * The enum of tone mapping type.
23 *
24 * @enum { number }
25 * @syscap SystemCapability.ArkUi.Graphics3D
26 * @since 12
27 */
28export enum ToneMappingType {
29  /**
30   * The tone mapping type is ACES.
31   *
32   * @syscap SystemCapability.ArkUi.Graphics3D
33   * @since 12
34   */
35  ACES = 0,
36
37  /**
38   * The tone mapping type is ACES_2020.
39   *
40   * @syscap SystemCapability.ArkUi.Graphics3D
41   * @since 12
42   */
43  ACES_2020 = 1,
44
45  /**
46   * The tone mapping type is FILMIC.
47   *
48   * @syscap SystemCapability.ArkUi.Graphics3D
49   * @since 12
50   */
51  FILMIC = 2,
52}
53
54/**
55 * Defines tone mapping parameters.
56 *
57 * @typedef ToneMappingSettings
58 * @syscap SystemCapability.ArkUi.Graphics3D
59 * @since 12
60 */
61export interface ToneMappingSettings {
62  /**
63   * Type of the tone mapping.
64   *
65   * @type { ?ToneMappingType }
66   * @syscap SystemCapability.ArkUi.Graphics3D
67   * @since 12
68   */
69  type?: ToneMappingType;
70
71  /**
72   * Exposure of the tone mapping.
73   *
74   * @type { ?number }
75   * @syscap SystemCapability.ArkUi.Graphics3D
76   * @since 12
77   */
78  exposure?: number;
79}
80
81/**
82 * Defines post processing settings.
83 *
84 * @typedef PostProcessSettings
85 * @syscap SystemCapability.ArkUi.Graphics3D
86 * @since 12
87 */
88export interface PostProcessSettings {
89  /**
90   * Tone mapping settings of the post processing settings.
91   *
92   * @type { ?ToneMappingSettings }
93   * @syscap SystemCapability.ArkUi.Graphics3D
94   * @since 12
95   */
96  toneMapping?: ToneMappingSettings;
97}
98