UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Color::FColorSpaceTransform Struct Reference

#include <ColorSpace.h>

+ Inheritance diagram for UE::Color::FColorSpaceTransform:

Public Member Functions

CORE_API FColorSpaceTransform (const FColorSpace &Src, const FColorSpace &Dst, EChromaticAdaptationMethod Method=DEFAULT_CHROMATIC_ADAPTATION_METHOD)
 
CORE_API FColorSpaceTransform (FMatrix44d Matrix)
 
CORE_API FLinearColor Apply (const FLinearColor &Color) const
 
- Public Member Functions inherited from UE::Math::TMatrix< double >
void DiagnosticCheckNaN () const
 
 TMatrix ()=default
 
 TMatrix (EForceInit)
 
 TMatrix (const TPlane< double > &InX, const TPlane< double > &InY, const TPlane< double > &InZ, const TPlane< double > &InW)
 
 TMatrix (const TVector< double > &InX, const TVector< double > &InY, const TVector< double > &InZ, const TVector< double > &InW)
 
 TMatrix (const TMatrix< FArg > &From)
 
void SetIdentity ()
 
TMatrix< doubleoperator* (const TMatrix< double > &Other) const
 
TMatrix< doubleoperator* (double Other) const
 
void operator*= (const TMatrix< double > &Other)
 
void operator*= (double Other)
 
TMatrix< doubleoperator+ (const TMatrix< double > &Other) const
 
void operator+= (const TMatrix< double > &Other)
 
bool operator== (const TMatrix< double > &Other) const
 
bool Equals (const TMatrix< double > &Other, double Tolerance=UE_KINDA_SMALL_NUMBER) const
 
bool operator!= (const TMatrix< double > &Other) const
 
TVector4< doubleTransformFVector4 (const TVector4< double > &V) const
 
TVector4< doubleTransformPosition (const TVector< double > &V) const
 
TVector< doubleInverseTransformPosition (const TVector< double > &V) const
 
TVector4< doubleTransformVector (const TVector< double > &V) const
 
TVector< doubleInverseTransformVector (const TVector< double > &V) const
 
TMatrix< doubleGetTransposed () const
 
double Determinant () const
 
double RotDeterminant () const
 
TMatrix< doubleInverseFast () const
 
TMatrix< doubleInverse () const
 
TMatrix< doubleTransposeAdjoint () const
 
void RemoveScaling (double Tolerance=UE_SMALL_NUMBER)
 
TMatrix< doubleGetMatrixWithoutScale (double Tolerance=UE_SMALL_NUMBER) const
 
TVector< doubleExtractScaling (double Tolerance=UE_SMALL_NUMBER)
 
TVector< doubleGetScaleVector (double Tolerance=UE_SMALL_NUMBER) const
 
TMatrix< doubleRemoveTranslation () const
 
TMatrix< doubleConcatTranslation (const TVector< double > &Translation) const
 
bool ContainsNaN () const
 
void ScaleTranslation (const TVector< double > &Scale3D)
 
double GetMinimumAxisScale () const
 
double GetMaximumAxisScale () const
 
TMatrix< doubleApplyScale (double Scale) const
 
TVector< doubleGetOrigin () const
 
TVector< doubleGetScaledAxis (EAxis::Type Axis) const
 
void GetScaledAxes (TVector< double > &X, TVector< double > &Y, TVector< double > &Z) const
 
TVector< doubleGetUnitAxis (EAxis::Type Axis) const
 
void GetUnitAxes (TVector< double > &X, TVector< double > &Y, TVector< double > &Z) const
 
void SetAxis (int32 i, const TVector< double > &Axis)
 
void SetOrigin (const TVector< double > &NewOrigin)
 
void SetAxes (const TVector< double > *Axis0=NULL, const TVector< double > *Axis1=NULL, const TVector< double > *Axis2=NULL, const TVector< double > *Origin=NULL)
 
TVector< doubleGetColumn (int32 i) const
 
void SetColumn (int32 i, TVector< double > Value)
 
CORE_API UE::Math::TRotator< doubleRotator () const
 
CORE_API UE::Math::TQuat< doubleToQuat () const
 
void To3x4MatrixTranspose (double *Out) const
 
void To3x4MatrixTranspose (float *Out) const
 
bool GetFrustumNearPlane (TPlane< double > &OuTPln) const
 
bool GetFrustumFarPlane (TPlane< double > &OuTPln) const
 
bool GetFrustumLeftPlane (TPlane< double > &OuTPln) const
 
bool GetFrustumRightPlane (TPlane< double > &OuTPln) const
 
bool GetFrustumTopPlane (TPlane< double > &OuTPln) const
 
bool GetFrustumBottomPlane (TPlane< double > &OuTPln) const
 
void Mirror (EAxis::Type MirrorAxis, EAxis::Type FlipAxis)
 
FString ToString () const
 
void DebugPrint () const
 
uint32 ComputeHash () const
 
bool Serialize (FArchive &Ar)
 
bool SerializeFromMismatchedTag (FName StructTag, FArchive &Ar)
 

Static Public Member Functions

static CORE_API FMatrix44d CalcChromaticAdaptionMatrix (FVector3d SourceXYZ, FVector3d TargetXYZ, EChromaticAdaptationMethod Method=DEFAULT_CHROMATIC_ADAPTATION_METHOD)
 
static CORE_API const FColorSpaceTransformGetSRGBToWorkingColorSpace ()
 
static CORE_API const FColorSpaceTransformGetWorkingColorSpaceToSRGB ()
 

Additional Inherited Members

- Public Types inherited from UE::Math::TMatrix< double >
using FReal = double
 
- Public Attributes inherited from UE::Math::TMatrix< double >
double M [4][4]
 
- Static Public Attributes inherited from UE::Math::TMatrix< double >
static CORE_API const TMatrix Identity
 

Constructor & Destructor Documentation

◆ FColorSpaceTransform() [1/2]

UE::Color::FColorSpaceTransform::FColorSpaceTransform ( const FColorSpace Src,
const FColorSpace Dst,
EChromaticAdaptationMethod  Method = DEFAULT_CHROMATIC_ADAPTATION_METHOD 
)
explicit

Constructor: create a color space transformation matrix from a source to a target color space using the RGB-XYZ-RGB conversions.

Parameters
SourceSource color space.
TargetTarget color space.
MethodChromatic adapation method.

◆ FColorSpaceTransform() [2/2]

UE::Color::FColorSpaceTransform::FColorSpaceTransform ( FMatrix44d  Matrix)
explicit

Constructor: create a color space transformation matrix from a raw matrix.

Parameters
MatrixColor space transformation matrix.

Member Function Documentation

◆ Apply()

FLinearColor UE::Color::FColorSpaceTransform::Apply ( const FLinearColor Color) const

Apply color space transform to FLinearColor.

Parameters
ColorColor to transform.

◆ CalcChromaticAdaptionMatrix()

FMatrix44d UE::Color::FColorSpaceTransform::CalcChromaticAdaptionMatrix ( FVector3d  SourceXYZ,
FVector3d  TargetXYZ,
EChromaticAdaptationMethod  Method = DEFAULT_CHROMATIC_ADAPTATION_METHOD 
)
static

Calculate the chromatic adaptation matrix using the specific method.

Parameters
SourceXYZSource color in XYZ space.
TargetXYZTarget color in XYZ space.
MethodAdaptation method (None, Bradford, CAT02).

◆ GetSRGBToWorkingColorSpace()

const FColorSpaceTransform & UE::Color::FColorSpaceTransform::GetSRGBToWorkingColorSpace ( )
static

Convenience function to get a (statically cached) conversion from sRGB/Rec709 to the working color space.

◆ GetWorkingColorSpaceToSRGB()

const FColorSpaceTransform & UE::Color::FColorSpaceTransform::GetWorkingColorSpaceToSRGB ( )
static

Convenience function to get a (statically cached) conversion from the working color space to sRGB/Rec709.


The documentation for this struct was generated from the following files: