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 > FOpenColorIOShaderMap

Light Theme

Dark Theme

FOpenColorIOShaderMap

The shaders required to apply an OCIO color transform.

Windows

MacOS

Linux

Inheritance Hierarchy

TShaderMap

FDeferredCleanupInterface

FOpenColorIOShaderMap

References

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

Syntax

class FOpenColorIOShaderMap :
public TShaderMap< FOpenColorIOShaderMapContent, FShaderMapPointerTable >,
public FDeferredCleanupInterface

Remarks

The shaders required to apply an OCIO color transform.

Constructors

	Name	Description
	FOpenColorIOShaderMap()

Destructors

	Name	Description
	~FOpenColorIOShaderMap()	Destructor.

Functions

	Name	Description
void	AddRef()	Reference counting.
void	Compile ( FOpenColorIOTransformResource*..., const FOpenColorIOShaderMapId& InS..., TRefCountPtr< FShaderCompilerEnviro..., const FOpenColorIOCompilationOutput..., EShaderPlatform InPlatform, bool bSynchronousCompile, bool bApplyCompletedShaderMapForRen... )	Compiles the shaders for a color transform and caches them in this shader map.
bool	CompiledSuccessfully()
FOpenColorIO...	FindId ( const FOpenColorIOShaderMapId& InS..., EShaderPlatform InPlatform )	Finds the shader map for a color transform. Finds the shader map for a color transform.
void	FlushShadersByShaderType ( const FShaderType* ShaderType )	Removes all entries in the cache with exceptions based on a shader type
uint32	GetCompilingId()
uint32	GetCompilingId()
const FMemor...	GetFriendlyName()
TMap< TRefCo...	GetInFlightShaderMaps()
int32	GetNumRefs()
TShaderRef< ...	GetShader()
TShaderRef< ...	GetShader ( FShaderType* ShaderType )
void	GetShaderList ( TMap< FShaderId, TShaderRef< FShade... )	Builds a list of the shaders in a shader map.
const FOpenC...	GetShaderMapBeingCompiled ( const FOpenColorIOTransformResource... )	Finds a shader map currently being compiled that was enqueued for the given color transform.
const FOpenC...	GetShaderMapId()	Accessors.
EShaderPlatf...	GetShaderPlatform()
bool	IsCompilationFinalized()
bool	IsComplete ( const FOpenColorIOTransformResource..., bool bSilent )	Checks whether the shader map is missing any shader types necessary for the given color transform.
bool	IsValid()
void	LoadFromDerivedDataCache ( const FOpenColorIOTransformResource..., const FOpenColorIOShaderMapId& InS..., EShaderPlatform InPlatform, TRefCountPtr< FOpenColorIOShaderMap... )	Attempts to load the shader map for the given color transform from the Derived Data Cache.
void	LoadMissingShadersFromMemory ( const FOpenColorIOTransformResource... )	Attempts to load missing shaders from memory.
bool	ProcessCompilationResults ( const TArray< TSharedRef< FShaderCo..., int32& InOutResultIndex, float& InOutTimeBudget )	Sorts the incoming compiled jobs into the appropriate OCIO shader maps, and finalizes this shader map so that it can be used for rendering.
void	Register ( EShaderPlatform InShaderPlatform )	Registers a OpenColorIO shader map in the global map so it can be used by OpenColorIO ColorTransform.
void	Release()
void	RemovePendingColorTransform ( FOpenColorIOTransformResource*... )	Removes a ColorTransform from OpenColorIOShaderMapsBeingCompiled.
void	SaveToDerivedDataCache()	Saves this shader map to the derived data cache.
bool	Serialize ( FArchive& Ar, bool bInlineShaderResources )	Serializes the shader map.
void	SetCompiledSuccessfully ( bool bSuccess )
bool	TryToAddToExistingCompilationTask ( FOpenColorIOTransformResource*... )	Checks to see if the shader map is already being compiled for another color transform, and if so adds the specified color transform to the list to be applied to once the compile finishes.

Typedefs

Name	Description
Super

Constants

Name	Description
AllOpenColorIOShaderMaps	All color transform shader maps in memory.
GIdToOpenColorIOShaderMap	A global map from a ColorTransform's ID and static switch set to any shader map cached for that color transform.
NextCompilingId	Next value for CompilingId.
OpenColorIOShaderMapsBeingCompiled	Tracks resources and their shader maps that need to be compiled but whose compilation is being deferred.

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

Take our survey

Dismiss