FColorSpace

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

API > API/Runtime > API/Runtime/Core

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

   
Name FColorSpace
Type class
Header File /Engine/Source/Runtime/Core/Public/ColorManagement/ColorSpace.h
Include Path #include "ColorManagement/ColorSpace.h"

Syntax

class FColorSpace

Constructors

Name Remarks Include Path Unreal Specifiers
Constructor ColorManagement/ColorSpace.h  

FColorSpace ( UE::Color::EColorSpace ColorSpaceType
)

 Constructor ColorManagement/ColorSpace.h  

FColorSpace ( const FVector2d& InRed,
const FVector2d& InGreen,
const FVector2d& InBlue,
const FVector2d& InWhite
)

 Constructor ColorManagement/ColorSpace.h  
  ColorManagement/ColorSpace.h  
  ColorManagement/ColorSpace.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsSRGB bool   ColorManagement/ColorSpace.h  
Chromaticities TStaticArray< FVector2d, 4 > Red, green, blue, white chromaticities, in order. ColorManagement/ColorSpace.h  
RgbToXYZ FMatrix44d   ColorManagement/ColorSpace.h  
XYZToRgb FMatrix44d   ColorManagement/ColorSpace.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool Equals ( const TStaticArray< FVector2d, 4 >& InChromaticities,
double Tolerance
) const

 Check against color space chromaticities for equality, within specified error limits. ColorManagement/ColorSpace.h  

bool Equals ( const FColorSpace& ColorSpace,
double Tolerance
) const

 Check against another color space for equality, within specified error limits. ColorManagement/ColorSpace.h  

const FVector2d & GetBlueChromaticity()

 Gets the color space's blue chromaticity coordinates. ColorManagement/ColorSpace.h  

void GetChromaticities ( UE::Math::TVector2< T >& OutRed,
UE::Math::TVector2< T >& OutGreen,
UE::Math::TVector2< T >& OutBlue,
UE::Math::TVector2< T >& OutWhite
) const

 Getter for the color space chromaticity coordinates. ColorManagement/ColorSpace.h  

const FVector2d & GetGreenChromaticity()

 Gets the color space's green chromaticity coordinates. ColorManagement/ColorSpace.h  

float GetLuminance ( const FLinearColor& Color
) const

 Calculate the color's luminance value in the current space. ColorManagement/ColorSpace.h  

FLinearColor GetLuminanceFactors()

 Get the luminance factors in the current space. ColorManagement/ColorSpace.h  

const FVector2d & GetRedChromaticity()

 Gets the color space's red chromaticity coordinates. ColorManagement/ColorSpace.h  

const FMatrix44d & GetRgbToXYZ()

 Gets the RGB-to-XYZ conversion matrix. ColorManagement/ColorSpace.h  

const FVector2d & GetWhiteChromaticity()

 Gets the color space's white point chromaticity coordinates. ColorManagement/ColorSpace.h  

const FMatrix44d & GetXYZToRgb()

 Gets the XYZ-to-RGB conversion matrix. ColorManagement/ColorSpace.h  

bool IsSRGB()

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

FLinearColor MakeFromColorTemperature ( float Temp
) const

 Converts temperature in Kelvins of a black body radiator to an RGB color in the current space. ColorManagement/ColorSpace.h  

bool Serialize ( FArchive& Ar
)

   ColorManagement/ColorSpace.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FColorSpace & GetSRGB()

 Get a (statically cached) sRGB color space. ColorManagement/ColorSpace.h  

static const FColorSpace & GetWorking()

 Get the global engine working color space (as a singleton). ColorManagement/ColorSpace.h  

static TStaticArray< FVector2d, 4 > MakeChromaticities ( UE::Color::EColorSpace ColorSpaceType
)

 Make the chromaticities of the color space type. ColorManagement/ColorSpace.h  

static void SetWorking ( FColorSpace ColorSpace
)

 Set the global engine working color space (as a singleton). ColorManagement/ColorSpace.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FColorSpace& ColorSpace
) const

 Check against another color space for inequality. ColorManagement/ColorSpace.h  
  ColorManagement/ColorSpace.h  
  ColorManagement/ColorSpace.h  

bool operator== ( const FColorSpace& ColorSpace
) const

 Check against another color space for equality. ColorManagement/ColorSpace.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page