UOpenColorIOConfiguration

Asset to manage allowed OpenColorIO color spaces. This will create required transform objects.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UOpenColorIOConfiguration

References

Module

OpenColorIO

Header

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

Include

#include "OpenColorIOConfiguration.h"

Syntax

UCLASS(BlueprintType)
class UOpenColorIOConfiguration : public UObject

Remarks

Asset to manage allowed OpenColorIO color spaces. This will create required transform objects.

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

FFilePath

 

ConfigurationFile

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite

TArray< FOpenCo...

 

DesiredColorSpaces

Constructors

Name Description

Public function

UOpenColorIOConfiguration

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

CleanupTransforms()

Public function

void

 

ConfigPathChangedEvent

(
    const TArray< FFileChangeData >& I...,
    const FString InFileMountPath
)

This method is called by directory watcher when any file or folder is changed in the directory where raw ocio config is located.

Protected function

void

 

CreateColorTransform

(
    const FString& InSourceColorSpace,
    const FString& InDestinationColorS...
)

Public function

bool

 

GetShaderAndLUTResources

(
    ERHIFeatureLevel::Type InFeatureLev...,
    const FString& InSourceColorSpace,
    const FString& InDestinationColorS...,
    FOpenColorIOTransformResource*...,
    FTextureResource*& OutLUT3dRes...
)

Public function Const

bool

 

HasDesiredColorSpace

(
    const FOpenColorIOColorSpace& Colo...
)

Public function

bool

 

HasTransform

(
    const FString& InSourceColorSpace,
    const FString& InDestinationColorS...
)

Public function

void

 

ReloadExistingColorspaces()

This forces to reload colorspaces and corresponding shaders if those are not loaded already.

Protected function

void

 

StartDirectoryWatch

(
    const FString& FilePath
)

Same as above except user can specify the path manually.

Protected function

void

 

StopDirectoryWatch()

Stop watching the current directory.

Public function Const

bool

 

Validate()

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PreSave

(
    FObjectPreSaveContext SaveContext
)

Presave function.