FOpenColorIOColorSpace

Structure to identify a ColorSpace as described in an OCIO configuration file.

Choose your operating system:

Windows

macOS

Linux

References

Module

OpenColorIO

Header

/Engine/Plugins/Compositing/OpenColorIO/Source/OpenColorIO/Public/OpenColorIOColorSpace.h

Include

#include "OpenColorIOColorSpace.h"

Syntax

USTRUCT(BlueprintType)
struct FOpenColorIOColorSpace

Remarks

Structure to identify a ColorSpace as described in an OCIO configuration file. Members are populated by data coming from a config file.

Variables

Name Description

Public variable UProperty Category visibleanywhere

int32

 

ColorSpaceIndex

The index of the ColorSpace in the config

Public variable UProperty Category visibleanywhere

FString

 

ColorSpaceName

The ColorSpace name.

Public variable UProperty Category visibleanywhere

FString

 

FamilyName

The family of this ColorSpace as specified in the configuration file.

Constructors

Name Description

Public function

FOpenColorIOColorSpace()

Default constructor.

Public function

FOpenColorIOColorSpace

(
    const FString& InColorSpaceName,
    int32 InColorSpaceIndex,
    const FString& InFamilyName
)

Create and initialize a new instance.

Functions

Name Description

Public function Const

FString

 

GetFamilyNameAtDepth

(
    int32 InDepth
)

Return the family name at the desired depth level

Public function Const

bool

 

IsValid()

Return true if the index and name have been set properly

Public function

void

 

Reset()

Reset members to default/empty values.

Public function Const

FString

 

ToString()

Get the string representation of this color space.

Operators

Name Description

Public function Const

bool

 

operator!=

(
    const FOpenColorIOColorSpace& Othe...
)

Public function Const

bool

 

operator==

(
    const FOpenColorIOColorSpace& Othe...
)

Constants

Name

Description

FamilyDelimiter

Delimiter used in the OpenColorIO library to make family hierarchies