@ohos.graphics.colorSpaceManager (Color Space Management)

The colorSpaceManager module provides APIs for creating and managing color space objects and obtaining basic color space attributes.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import colorSpaceManager from '@ohos.graphics.colorSpaceManager';

ColorSpace

Enumerates the color space types.

System capability: SystemCapability.Graphic.Graphic2D.ColorManager.Core

ColorSpacePrimaries

Defines the color space primaries. A color space is defined by chromaticity coordinates of the red, green, and blue additive primaries, the white point, and the gamma.

System capability: SystemCapability.Graphic.Graphic2D.ColorManager.Core

colorSpaceManager.create

create(colorSpaceName: ColorSpace): ColorSpaceManager

Creates a standard color space object.

System capability: SystemCapability.Graphic.Graphic2D.ColorManager.Core

Parameters

Return value

Error codes

For details about the error codes, see colorSpaceManager Error Codes.

Example

let colorSpace: colorSpaceManager.ColorSpaceManager;
try {
    colorSpace = colorSpaceManager.create(colorSpaceManager.ColorSpace.SRGB);
} catch (err) {
    console.log(`Failed to create SRGB colorSpace. Cause: ` + JSON.stringify(err));
}

colorSpaceManager.create

create(primaries: ColorSpacePrimaries, gamma: number): ColorSpaceManager

Creates a custom color space object.

System capability: SystemCapability.Graphic.Graphic2D.ColorManager.Core

Parameters

Return value

Error codes

For details about the error codes, see colorSpaceManager Error Codes.

Example

let colorSpace: colorSpaceManager.ColorSpaceManager;
try {
    let primaries: colorSpaceManager.ColorSpacePrimaries = {
        redX: 0.1,
        redY: 0.1,
        greenX: 0.2,
        greenY: 0.2,
        blueX: 0.3,
        blueY: 0.3,
        whitePointX: 0.4,
        whitePointY: 0.4
    };
    let gamma = 2.2;
    colorSpace = colorSpaceManager.create(primaries, gamma);
} catch (err) {
    console.log(`Failed to create colorSpace with customized primaries and gamma. Cause: ` + JSON.stringify(err));
}

ColorSpaceManager

Implements management of color space objects.

Before calling any of the following APIs, you must use create() to create a color space object.

getColorSpaceName

getColorSpaceName(): ColorSpace

Obtains the color space type.

System capability: SystemCapability.Graphic.Graphic2D.ColorManager.Core

Return value

Error codes

For details about the error codes, see colorSpaceManager Error Codes.

Example

try {
    colorSpace.getColorSpaceName();
} catch (err) {
    console.log(`Fail to get colorSpace's name. Cause: ` + JSON.stringify(err));
}

getWhitePoint

getWhitePoint(): Array<number>

Obtains the coordinates of the white point of the color space.

System capability: SystemCapability.Graphic.Graphic2D.ColorManager.Core

Return value

Error codes

For details about the error codes, see colorSpaceManager Error Codes.

Example

try {
    colorSpace.getWhitePoint();
} catch (err) {
    console.log(`Failed to get white point. Cause: ` + JSON.stringify(err));
}

getGamma

getGamma(): number

Obtains the gamma of the color space.

System capability: SystemCapability.Graphic.Graphic2D.ColorManager.Core

Return value

Error codes

For details about the error codes, see colorSpaceManager Error Codes.

Example

try {
    colorSpace.getGamma();
} catch (err) {
    console.log(`Failed to get gamma. Cause: ` + JSON.stringify(err));
}