UOpenColorIOConfiguration

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

API > API/Plugins > API/Plugins/OpenColorIO

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, Meta&61;&40;DisplayName&61;"OpenColorIO Configuration"&41;&41;  
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 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
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& InDisplay,
const FString& InView,
EOpenColorIOViewTransformDirection InDirection
)

  
Protected function void

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

  
Public function Static void

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

  
Protected function Const const TObjectPtr< UOpenColorIOColorTransform > *  
Public function Const FOpenColorIOWrapperConfig * Internal only: Replacement for previous GetNativeConfig_Internal()_, GetLoadedConfiguration() and `GetLoadedConfigurationFile() functions, returning the private implementation of the native OCIO config.
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 UFunction BlueprintCallable, Category void 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

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  

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page