UOpenColorIOColorTransform

Object used to generate shader and LUTs from OCIO configuration file and contain required resource to make a color space transform.

API > API/Plugins > API/Plugins/OpenColorIO

Object used to generate shader and LUTs from OCIO configuration file and contain required resource to make a color space transform.

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

Syntax

UCLASS (MinimalAPI)  
class UOpenColorIOColorTransform : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UOpenColorIOColorTransform ( const FObjectInitializer& ObjectInitializer
)

   OpenColorIOColorTransform.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS ~UOpenColorIOColorTransform()

   OpenColorIOColorTransform.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsDisplayViewType bool   OpenColorIOColorTransform.h
  • VisibleAnywhere
  • Category="ColorSpace"
DestinationColorSpace FString   OpenColorIOColorTransform.h
  • VisibleAnywhere
  • Category="ColorSpace"
Display FString   OpenColorIOColorTransform.h
  • VisibleAnywhere
  • Category="ColorSpace"
DisplayViewDirection EOpenColorIOViewTransformDirection   OpenColorIOColorTransform.h
  • VisibleAnywhere
  • Category="ColorSpace"
SourceColorSpace FString   OpenColorIOColorTransform.h
  • VisibleAnywhere
  • Category="ColorSpace"
View FString   OpenColorIOColorTransform.h
  • VisibleAnywhere
  • Category="ColorSpace"

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedColorTransformResourcesForCooking TMap< const class ITargetPlatform *, TArray< FOpenColorIOTransformResource * > > ColorTransform resources being cached for cooking. OpenColorIOColorTransform.h  
ColorTransformResources FOpenColorIOTransformResource *   OpenColorIOColorTransform.h  
FeatureLevelChangedDelegateHandle FDelegateHandle Handle so we can unregister the delegate OpenColorIOColorTransform.h  
GeneratedShader FString Generated transform shader function. OpenColorIOColorTransform.h  
GeneratedShaderHash FString Generated transform shader hash. OpenColorIOColorTransform.h  
LoadedTransformResources TArray< FOpenColorIOTransformResource > Inline ColorTransform resources serialized from disk. To be processed on game thread in PostLoad. OpenColorIOColorTransform.h  
LookupTextures TArray< TObjectPtr< UTexture > > If the color space transform requires LUTs, this will contains the texture data to do the transform OpenColorIOColorTransform.h  
ReleaseFence FRenderCommandFence   OpenColorIOColorTransform.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AreRenderResourcesReady()

 Returns true if shader/texture resources have finished compiling and are ready for use (to be called on the game thread). OpenColorIOColorTransform.h  

void CacheResourceShadersForCooking ( EShaderPlatform InShaderPlatform,
const ITargetPlatform* TargetPlatform,
const FString& InShaderHash,
const FString& InShaderCode,
const FString& InRawConfigHash,
TArray< FOpenColorIOTransformResource* >& OutCachedResources
)

 Cache resource shaders for cooking on the given shader platform. OpenColorIOColorTransform.h  

TMap< FString, FString > GetContextKeyValues()

 Get the owner config's context key-values. OpenColorIOColorTransform.h  

bool GetDisplayViewDirection ( EOpenColorIOViewTransformDirection& OutDirection
) const

 Get the display view direction type, when applicable. OpenColorIOColorTransform.h  

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

   OpenColorIOColorTransform.h  

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

 Returns the desired resources required to apply this transform during rendering. OpenColorIOColorTransform.h  

bool GetTransformProcessor ( FOpenColorIOWrapperProcessor& OutProcessor,
const TMap< FString, FString >& InContextOverride
) const

 Get the transform processor. OpenColorIOColorTransform.h  

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

 Initialize resources for color space transform. OpenColorIOColorTransform.h  

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

 Initialize resources for display-view transform. OpenColorIOColorTransform.h  

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

 Returns true if the current transform corresponds to the specified color space and display/view & direction. OpenColorIOColorTransform.h  

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

 Returns true if the current transform corresponds to the specified color spaces. OpenColorIOColorTransform.h  
Releases rendering resources used by this color transform. OpenColorIOColorTransform.h  

bool TransformColor ( FLinearColor& InOutColor
) const

 Apply the color transform in-place to the specified color. OpenColorIOColorTransform.h  

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

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

bool TransformImage ( const FImageView& InOutImage
) const

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   OpenColorIOColorTransform.h  

virtual void BeginDestroy()

   OpenColorIOColorTransform.h  

virtual void ClearAllCachedCookedPlatformData()

   OpenColorIOColorTransform.h  

virtual void ClearCachedCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   OpenColorIOColorTransform.h  

virtual void FinishDestroy()

   OpenColorIOColorTransform.h  

virtual bool IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetPlatform
)

   OpenColorIOColorTransform.h  

virtual bool IsReadyForFinishDestroy()

   OpenColorIOColorTransform.h  

virtual void PostLoad()

   OpenColorIOColorTransform.h  

virtual void Serialize ( FArchive& Ar
)

   OpenColorIOColorTransform.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AllColorTransformsCacheResourceShadersForRendering()

 For all ColorTransforms, UOpenColorIOColorTransform::CacheResourceShadersForRendering. OpenColorIOColorTransform.h  

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

   OpenColorIOColorTransform.h  

static void GetOpenColorIOLUTKeyGuid ( const FString& InProcessorIdentifier,
const FName& InName,
FGuid& OutLutGuid
)

 Returns a Guid for the LUT based on its unique identifier, name and the OCIO DDC key. OpenColorIOColorTransform.h  

static void ProcessSerializedShaderMaps ( UOpenColorIOColorTransform* Owner,
TArray< FOpenColorIOTransformResource >& LoadedResources,
FOpenColorIOTransformResource*(&) OutColorTransformResourcesLoaded
)

 Helper function to register serialized shader maps for the given color transform resources OpenColorIOColorTransform.h  

static void SerializeOpenColorIOShaderMaps ( const TMap< const ITargetPlatform*, TArray< FOpenColorIOTransformResource* > >* Platf...,
FArchive& Ar,
TArray< FOpenColorIOTransformResource >& OutLoadedResources
)

 Helper function to serialize shader maps for the given color transform resources. OpenColorIOColorTransform.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page