interface_sdk-js/api/graphics3d/ScenePostProcessSettings.d.ts
huxiaoming5@huawei.com 525dfcab58 define ark graphics 3d kit
Signed-off-by: huxiaoming5@huawei.com <huxiaoming5@huawei.com>
Change-Id: I463c953ddaf96a75c98c2b15f976a372a3361253
2024-05-05 10:21:11 +08:00

98 lines
2.1 KiB
TypeScript

/*
* Copyright (c) 2024-2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file Defines 3D post process related interfaces
* @kit ArkGraphics3D
*/
/**
* The enum of tone mapping type.
*
* @enum { number }
* @syscap SystemCapability.ArkUi.Graphics3D
* @since 12
*/
export enum ToneMappingType {
/**
* The tone mapping type is ACES.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @since 12
*/
ACES = 0,
/**
* The tone mapping type is ACES_2020.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @since 12
*/
ACES_2020 = 1,
/**
* The tone mapping type is FILMIC.
*
* @syscap SystemCapability.ArkUi.Graphics3D
* @since 12
*/
FILMIC = 2,
}
/**
* Defines tone mapping parameters.
*
* @typedef ToneMappingSettings
* @syscap SystemCapability.ArkUi.Graphics3D
* @since 12
*/
export interface ToneMappingSettings {
/**
* Type of the tone mapping.
*
* @type { ?ToneMappingType }
* @syscap SystemCapability.ArkUi.Graphics3D
* @since 12
*/
type?: ToneMappingType;
/**
* Exposure of the tone mapping.
*
* @type { ?number }
* @syscap SystemCapability.ArkUi.Graphics3D
* @since 12
*/
exposure?: number;
}
/**
* Defines post processing settings.
*
* @typedef PostProcessSettings
* @syscap SystemCapability.ArkUi.Graphics3D
* @since 12
*/
export interface PostProcessSettings {
/**
* Tone mapping settings of the post processing settings.
*
* @type { ?ToneMappingSettings }
* @syscap SystemCapability.ArkUi.Graphics3D
* @since 12
*/
toneMapping?: ToneMappingSettings;
}