Navigation
API > API/Plugins > API/Plugins/OpenColorIO
Structure to identify a ColorSpace as described in an OCIO configuration file. Members are populated by data coming from a config file.
| Name | FOpenColorIOColorSpace |
| Type | struct |
| Header File | /Engine/Plugins/Compositing/OpenColorIO/Source/OpenColorIO/Public/OpenColorIOColorSpace.h |
| Include Path | #include "OpenColorIOColorSpace.h" |
Syntax
USTRUCT (BlueprintType , Meta=(DisplayName="OpenColorIO Color Space"))
struct FOpenColorIOColorSpace
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
PRAGMA_DISABLE_DEPRECATION_WARNINGS FOpenColorIOColorSpace () |
Default constructor. | OpenColorIOColorSpace.h | |
FOpenColorIOColorSpace
(
const FOpenColorIOColorSpace& |
OpenColorIOColorSpace.h | ||
| OpenColorIOColorSpace.h | |||
PRAGMA_ENABLE_DEPRECATION_WARNINGS FOpenColorIOColorSpace
(
const FString& InColorSpaceName, |
Create and initialize a new instance. | OpenColorIOColorSpace.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FOpenColorIOColorSpace() |
OpenColorIOColorSpace.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FamilyDelimiter | const TCHAR * | Delimiter used in the OpenColorIO library to make family hierarchies | OpenColorIOColorSpace.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ColorSpaceName | FString | The ColorSpace name. | OpenColorIOColorSpace.h |
|
| Description | FString | Colorspace description. | OpenColorIOColorSpace.h | |
| FamilyName | FString | The family of this ColorSpace as specified in the configuration file. | OpenColorIOColorSpace.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetFamilyNameAtDepth
(
int32 InDepth |
Return the family name at the desired depth level | OpenColorIOColorSpace.h | |
bool IsValid() |
Return true if the index and name have been set properly | OpenColorIOColorSpace.h | |
void Reset() |
Reset members to default/empty values. | OpenColorIOColorSpace.h | |
FString ToString() |
Get the string representation of this color space. | OpenColorIOColorSpace.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FOpenColorIOColorSpace& Other |
OpenColorIOColorSpace.h | ||
FOpenColorIOColorSpace & operator=
(
const FOpenColorIOColorSpace& |
OpenColorIOColorSpace.h | ||
| OpenColorIOColorSpace.h | |||
bool operator==
(
const FOpenColorIOColorSpace& Other |
OpenColorIOColorSpace.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ColorSpaceIndex_DEPRECATED | int32 | The index of the ColorSpace in the config | OpenColorIOColorSpace.h |
|