UOpenColorIOConfiguration

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

API > API/Plugins > API/Plugins/OpenColorIO

Inheritance Hierarchy

  • UObject
  • UOpenColorIOConfiguration

References

   
Module OpenColorIO
Header /Engine/Plugins/Compositing/OpenColorIO/Source/OpenColorIO/Public/OpenColorIOConfiguration.h
Include #include "OpenColorIOConfiguration.h"

Syntax

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

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite FFilePath ConfigurationFile  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TMap< FString, FString > Context 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).
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FOpenColorIOColorSpace > DesiredColorSpaces  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite displayname TArray< FOpenColorIODisplayView > DesiredDisplayViews  

Constructors

  Type Name Description
Public function  

UOpenColorIOConfiguration ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void  
Protected function void  
Public function 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.
Protected function void

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

  
Protected function void

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

  
Public function Static void

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

  
Public function Const TObjectPtr< const UOpenColorIOColorTransform > Find the color transform object that corresponds to the specified settings, nullptr if not found.
Public function Virtual Const void

GetAssetRegistryTags ( FAssetRegistryTagsContext RegistryTagsContext
)

  
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Const FOpenColorIOWrapperConfig * Get the private wrapper implementation of the OCIO config.
Public function FOpenColorIOWrapperConfig * Get or create the private wrapper implementation of the OCIO config.
Public function bool

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

  
Public function bool

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

  
Public function Const bool  
Public function Const bool  
Public function bool

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

  
Public function bool

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

  
Public function bool  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

  
Public function UFunction BlueprintCallable, Category void

ReloadExistingColorspaces ( bool bForce
)

 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 Stop watching the current directory.
Public function Const bool

TransformColor ( const FOpenColorIOColorConversionSettings& InSettings,
FLinearColor& InOutColor
)

 Apply the color transform in-place to the specified image.
Public function Const bool

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

 Apply the color transform in-place to the specified image.
Public function Const bool

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

 Apply the color transform from the source image to the destination image.
Public function Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page