1. Epic GamesDeveloper
  3. UOpenColorIOConfiguration

UOpenColorIOConfiguration

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

API > API/Plugins > API/Plugins/OpenColorIO

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

   
Name UOpenColorIOConfiguration
Type class
Header File /Engine/Plugins/Compositing/OpenColorIO/Source/OpenColorIO/Public/OpenColorIOConfiguration.h
Include Path #include "OpenColorIOConfiguration.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Meta=(DisplayName="OpenColorIO Configuration"))  
class UOpenColorIOConfiguration : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UOpenColorIOConfiguration ( const FObjectInitializer& ObjectInitializer
)

   OpenColorIOConfiguration.h  

Structs

Name Remarks
FOCIOConfigWatchedDirInfo  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ConfigurationFile FFilePath   OpenColorIOConfiguration.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Config"
  • Meta=(FilePathFilter="Config Files (.ocio, .ocioz)|.ocio;.ocioz", RelativeToGameDir)
Context TMap< FString, FString > OCIO context of key-value string pairs, typically used to apply shot-specific looks (such as a CDL color correction, or a 1D grade LUT). OpenColorIOConfiguration.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Transform"
DesiredColorSpaces TArray< FOpenColorIOColorSpace >   OpenColorIOConfiguration.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Transform"
DesiredDisplayViews TArray< FOpenColorIODisplayView >   OpenColorIOConfiguration.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Transform"
  • DisplayName="Desired Display-Views"

Protected

Name Type Remarks Include Path Unreal Specifiers
ColorTransforms TArray< TObjectPtr< UOpenColorIOColorTransform > >   OpenColorIOConfiguration.h  
Config TPimplPtr< FOpenColorIOWrapperConfig > Private implementation of the OpenColorIO config object. OpenColorIOConfiguration.h  
ConfigHash FString Hash of all of the config content, including relevant external file information. OpenColorIOConfiguration.h  
WatchedDirectoryInfo FOCIOConfigWatchedDirInfo Information about the currently watched directory. Helps us manage the directory change events. OpenColorIOConfiguration.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ConfigPathChangedEvent ( const TArray< FFileChangeData >& InFileChanges,
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. OpenColorIOConfiguration.h  

TObjectPtr< const UOpenColorIOColorTransform > FindTransform ( const FOpenColorIOColorConversionSettings& InSettings
) const

 Find the color transform object that corresponds to the specified settings, nullptr if not found. OpenColorIOConfiguration.h  

FOpenColorIOWrapperConfig * GetConfigWrapper()

 Get the private wrapper implementation of the OCIO config. OpenColorIOConfiguration.h  

FOpenColorIOWrapperConfig * GetOrCreateConfigWrapper ()

 Get or create the private wrapper implementation of the OCIO config. OpenColorIOConfiguration.h  

bool GetRenderResources ( ERHIFeatureLevel::Type InFeatureLevel,
const FOpenColorIOColorConversionSettings& InSettings,
FOpenColorIOTransformResource*& OutShaderResource,
TSortedMap< int32, TWeakObjectPtr< UTexture > >& OutTextureResources
)

   OpenColorIOConfiguration.h  

bool GetRenderResources ( ERHIFeatureLevel::Type InFeatureLevel,
const FOpenColorIOColorConversionSettings& InSettings,
FOpenColorIOTransformResource*& OutShaderResource,
TArray< TWeakObjectPtr< UTexture > >& OutTextureResources
)

 Get the shader and optionally lookup texture resources to be used by the color transform render pass specified by the settings parameter. OpenColorIOConfiguration.h  

bool HasDesiredColorSpace ( const FOpenColorIOColorSpace& ColorSpace
) const

 Check if this configuration contains a color space. OpenColorIOConfiguration.h  

bool HasDesiredDisplayView ( const FOpenColorIODisplayView& DisplayView
) const

 Check if this configuration contains a display-view. OpenColorIOConfiguration.h  

bool HasTransform ( const FString& InSourceColorSpace,
const FString& InDisplay,
const FString& InView,
EOpenColorIOViewTransformDirection InDirection
)

 Check if this configuration contains a transform from the specified source color space & view destination. OpenColorIOConfiguration.h  

bool HasTransform ( const FString& InSourceColorSpace,
const FString& InDestinationColorSpace
)

 Check if this configuration contains a transform from the specified source & destination color spaces. OpenColorIOConfiguration.h  

bool IsTransformReady ( const FOpenColorIOColorConversionSettings& InSettings
)

 Check if the transform resources (shader & optionally lookup textures) are ready for use. OpenColorIOConfiguration.h  

void ReloadExistingColorspaces ( bool bForce
)

 This forces to reload colorspaces and corresponding shaders if those are not loaded already. OpenColorIOConfiguration.h
  • BlueprintCallable
  • Category="OpenColorIO"

bool TransformColor ( const FOpenColorIOColorConversionSettings& InSettings,
FLinearColor& InOutColor
) const

 Apply the color transform in-place to the specified image. OpenColorIOConfiguration.h  

bool TransformImage ( const FOpenColorIOColorConversionSettings& InSettings,
const FImageView& InOutImage
) const

 Apply the color transform in-place to the specified image. OpenColorIOConfiguration.h  

bool TransformImage ( const FOpenColorIOColorConversionSettings& InSettings,
const FImageView& SrcImage,
const FImageView& DestImage
) const

 Apply the color transform from the source image to the destination image. OpenColorIOConfiguration.h  

bool Validate ()

 Check if this configuration is valid. OpenColorIOConfiguration.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   OpenColorIOConfiguration.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext RegistryTagsContext
) const

   OpenColorIOConfiguration.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   OpenColorIOConfiguration.h  

virtual void PostInitProperties()

   OpenColorIOConfiguration.h  

virtual void PostLoad()

   OpenColorIOConfiguration.h  

virtual void PreSave ( FObjectPreSaveContext SaveContext
)

   OpenColorIOConfiguration.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CleanupTransforms()

   OpenColorIOConfiguration.h  

void CreateColorTransform ( const FString& InSourceColorSpace,
const FString& InDisplay,
const FString& InView,
EOpenColorIOViewTransformDirection InDirection
)

   OpenColorIOConfiguration.h  

void CreateColorTransform ( const FString& InSourceColorSpace,
const FString& InDestinationColorSpace
)

   OpenColorIOConfiguration.h  

void StartDirectoryWatch ( const FString& FilePath
)

 Same as above except user can specify the path manually. OpenColorIOConfiguration.h  

void StopDirectoryWatch()

 Stop watching the current directory. OpenColorIOConfiguration.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

   OpenColorIOConfiguration.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page