Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > ColorManagement > FColorSpace

Light Theme

Dark Theme

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
	FColorSpace()	Constructor
	FColorSpace ( UE::Color::EColorSpace ColorSpaceTy... )	Constructor
	FColorSpace ( FColorSpace&& )
	FColorSpace ( const FColorSpace& )
	FColorSpace ( const FVector2D& InRed, const FVector2D& InGreen, const FVector2D& InBlue, const FVector2D& InWhite )	Constructor

Functions

		Name	Description
	bool	Equals ( const FColorSpace& CS, double Tolerance )	Check against another colorspace for equality, within specified error limits.
	FVector2D	GetBlueChromaticity()	Gets the color space's blue chromaticity coordinates.
	FCoordinate2...	GetBlueChromaticityCoordinate()	Gets the color space's blue chromaticity coordinates.
	void	GetChromaticities ( FVector2D& OutRed, FVector2D& OutGreen, FVector2D& OutBlue, FVector2D& OutWhite )	Getter for the color space chromaticity coordinates as FVector2D.
	FVector2D	GetGreenChromaticity()	Gets the color space's green chromaticity coordinates.
	FCoordinate2...	GetGreenChromaticityCoordinate()	Gets the color space's green chromaticity coordinates.
	FVector2D	GetRedChromaticity()	Gets the color space's red chromaticity coordinates.
	FCoordinate2...	GetRedChromaticityCoordinate()	Gets the color space's red chromaticity coordinates.
	const FMatri...	GetRgbToXYZ()	Gets the RGB-to-XYZ conversion matrix.
	FVector2D	GetWhiteChromaticity()	Gets the color space's white point chromaticity coordinates.
	FCoordinate2...	GetWhiteChromaticityCoordinate()	Gets the color space's white point chromaticity coordinates.
	const FColor...	GetWorking()	Get the global engine working color space (as a singleton).
	const FMatri...	GetXYZToRgb()	Gets the XYZ-to-RGB conversion matrix.
	bool	IsSRGB()	Convenience function to verify if the color space matches the engine's default sRGB chromaticities.
	bool	Serialize ( FArchive& Ar )
	void	SetWorking ( FColorSpace ColorSpace )	Set the global engine working color space (as a singleton).

Operators

		Name	Description
	bool	operator!= ( const FColorSpace& CS )	Check against another colorspace for inequality.
	FColorSpace ...	operator= ( FColorSpace&& )
	FColorSpace ...	operator= ( const FColorSpace& )
	bool	operator== ( const FColorSpace& CS )	Check against another vector for equality.