Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OpenColorIO > FOpenColorIOTransformResource

Light Theme

Dark Theme

FOpenColorIOTransformResource

[FOpenColorIOTransformResource](API\Plugins\OpenColorIO\FOpenColorIOTransformResource) represents a OpenColorIO color transform to the shader compilation process

Windows

MacOS

Linux

References

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

Syntax

class FOpenColorIOTransformResource

Remarks

FOpenColorIOTransformResource represents a OpenColorIO color transform to the shader compilation process

Variables

		Name	Description
	FString	ShaderCode

Constructors

	Name	Description
	FOpenColorIOTransformResource()	Minimal initialization constructor.

Destructors

	Name	Description
	~FOpenColorIOTransformResource()	Destructor

Functions

	Name	Description
void	AddCompileId ( uint32 InIdentifier )
bool	CacheShaders ( const FOpenColorIOShaderMapId& InS..., EShaderPlatform InPlatform, bool bApplyCompletedShaderMapForRen..., bool bSynchronous )	Caches the shaders for this color transform with no static parameters on the given platform.
bool	CacheShaders ( EShaderPlatform InPlatform, bool bApplyCompletedShaderMapForRen..., bool bSynchronous )	Caches the shaders for this color transform with no static parameters on the given platform.
void	CancelCompilation()	Cancels all outstanding compilation jobs
void	DiscardShaderMap()	Discards loaded shader maps if the application can't render
void	FinishCompilation()	Blocks until compilation has completed. Returns immediately if a compilation is not outstanding.
bool	GetColorTransformHLSLSource ( FString& OutSource )	Get OCIO generated source code for the shader
const TArray...	GetCompileErrors()	Accessors.
void	GetDependentShaderTypes ( EShaderPlatform InPlatform, TArray< FShaderType* >& OutSh... )
ERHIFeatureL...	GetFeatureLevel()
const FStrin...	GetFriendlyName()
FOpenColorIO...	GetGameThreadShaderMap()
TShaderRef< ...	GetShader()
TShaderRef< ...	GetShaderGameThread()
void	GetShaderMapId ( EShaderPlatform InPlatform, FOpenColorIOShaderMapId& OutId )
void	GetShaderMapIDsWithUnfinishedCompilation ( TArray< int32 >& OutShaderMapIds )	Fills the passed array with IDs of shader maps unfinished compilation jobs.
void	Invalidate()
bool	IsCompilationFinished()	Checks if the compilation for this shader is finished
bool	IsPersistent()	Should shaders compiled for this color transform be saved to disk?
bool	IsSame ( const FOpenColorIOShaderMapId& InI... )
void	NotifyCompilationFinished()	Called when compilation finishes, after the GameThreadShaderMap is set and the render command to set the RenderThreadShaderMap is queued
void	ReleaseShaderMap()	Releases this color transform's shader map.
void	RemoveOutstandingCompileId ( const int32 InOldOutstandingCompile... )
void	SerializeShaderMap ( FArchive& Ar )
void	SetCompileErrors ( const TArray< FString >& InCompile... )
void	SetCompileErrors ( TArray< FString >& InErrors )
void	SetFeatureLevel ( ERHIFeatureLevel::Type InFeatureLev... )
void	SetGameThreadShaderMap ( FOpenColorIOShaderMap* InShade... )	Note: SetRenderingThreadShaderMap must also be called with the same value, but from the rendering thread.
void	SetInlineShaderMap ( FOpenColorIOShaderMap* InShade... )
void	SetRenderingThreadShaderMap ( FOpenColorIOShaderMap* InShade... )	Note: SetGameThreadShaderMap must also be called with the same value, but from the game thread.
void	SetupResource ( ERHIFeatureLevel::Type InFeatureLev..., const FString& InShaderCodeHash, const FString& InShadercode, const FString& InFriendlyName )
bool	ShouldCache ( EShaderPlatform InPlatform, const FShaderType* InShaderTyp... )	Should the shader for this color transform with the given platform, shader type and vertex factory type combination be compiled

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss