FColorSpace

Color space definition as 4 chromaticity coordinates, in double precision internally.

Choose your operating system:

Windows

macOS

Linux

References

Module

ColorManagement

Header

/Engine/Source/Runtime/ColorManagement/Public/ColorSpace.h

Include

#include "ColorSpace.h"

Syntax

class FColorSpace

Remarks

Color space definition as 4 chromaticity coordinates, in double precision internally.

Constructors

Name Description

Public function

FColorSpace()

Constructor

Public function

FColorSpace

(
    UE::Color::EColorSpace ColorSpaceTy...
)

Constructor

Public function

FColorSpace

(
    FColorSpace&&
)

Public function

FColorSpace

(
    const FColorSpace&
)

Public function

FColorSpace

(
    const FVector2D& InRed,
    const FVector2D& InGreen,
    const FVector2D& InBlue,
    const FVector2D& InWhite
)

Constructor

Functions

Name Description

Public function Const

bool

 

Equals

(
    const FColorSpace& CS,
    double Tolerance
)

Check against another colorspace for equality, within specified error limits.

Public function Const

FVector2D

 

GetBlueChromaticity()

Gets the color space's blue chromaticity coordinates.

Public function Const

FCoordinate2...

 

GetBlueChromaticityCoordinate()

Gets the color space's blue chromaticity coordinates.

Public function Const

void

 

GetChromaticities

(
    FVector2D& OutRed,
    FVector2D& OutGreen,
    FVector2D& OutBlue,
    FVector2D& OutWhite
)

Getter for the color space chromaticity coordinates as FVector2D.

Public function Const

FVector2D

 

GetGreenChromaticity()

Gets the color space's green chromaticity coordinates.

Public function Const

FCoordinate2...

 

GetGreenChromaticityCoordinate()

Gets the color space's green chromaticity coordinates.

Public function Const

FVector2D

 

GetRedChromaticity()

Gets the color space's red chromaticity coordinates.

Public function Const

FCoordinate2...

 

GetRedChromaticityCoordinate()

Gets the color space's red chromaticity coordinates.

Public function Const

const FMatri...

 

GetRgbToXYZ()

Gets the RGB-to-XYZ conversion matrix.

Public function Const

FVector2D

 

GetWhiteChromaticity()

Gets the color space's white point chromaticity coordinates.

Public function Const

FCoordinate2...

 

GetWhiteChromaticityCoordinate()

Gets the color space's white point chromaticity coordinates.

Public function Static

const FColor...

 

GetWorking()

Get the global engine working color space (as a singleton).

Public function Const

const FMatri...

 

GetXYZToRgb()

Gets the XYZ-to-RGB conversion matrix.

Public function Const

bool

 

IsSRGB()

Convenience function to verify if the color space matches the engine's default sRGB chromaticities.

Public function

bool

 

Serialize

(
    FArchive& Ar
)

Public function Static

void

 

SetWorking

(
    FColorSpace ColorSpace
)

Set the global engine working color space (as a singleton).

Operators

Name Description

Public function Const

bool

 

operator!=

(
    const FColorSpace& CS
)

Check against another colorspace for inequality.

Public function

FColorSpace ...

 

operator=

(
    FColorSpace&&
)

Public function

FColorSpace ...

 

operator=

(
    const FColorSpace&
)

Public function Const

bool

 

operator==

(
    const FColorSpace& CS
)

Check against another vector for equality.