1. Epic GamesDeveloper
  3. FOpenColorIOShaderMap

FOpenColorIOShaderMap

The shaders required to apply an OCIO color transform.

API > API/Plugins > API/Plugins/OpenColorIO

The shaders required to apply an OCIO color transform.

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

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FOpenColorIOShaderMap()

   OpenColorIOShared.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FOpenColorIOShaderMap()

 Destructor. OpenColorIOShared.h  

Typedefs

Name Type Remarks Include Path
Super TShaderMap< FOpenColorIOShaderMapContent, FShaderMapPointerTable >   OpenColorIOShared.h

Constants

Name Type Remarks Include Path
AllOpenColorIOShaderMaps TArray< FOpenColorIOShaderMap * > All color transform shader maps in memory. OpenColorIOShared.h
GIdToOpenColorIOShaderMap TMap< FOpenColorIOShaderMapId, FOpenColorIOShaderMap * > A global map from a ColorTransform's ID and static switch set to any shader map cached for that color transform. OpenColorIOShared.h
NextCompilingId uint32 Next value for CompilingId. OpenColorIOShared.h
OpenColorIOShaderMapsBeingCompiled TMap< TRefCountPtr< FOpenColorIOShaderMap >, TArray< FOpenColorIOTransformResource * > > Tracks resources and their shader maps that need to be compiled but whose compilation is being deferred. OpenColorIOShared.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bCompilationFinalized uint32 Indicates whether this shader map has had ProcessCompilationResults called after Compile. OpenColorIOShared.h  
bCompiledSuccessfully uint32   OpenColorIOShared.h  
bDeletedThroughDeferredCleanup bool Used to catch errors where the shader map is deleted directly. OpenColorIOShared.h  
bHasFrozenContent uint32   OpenColorIOShared.h  
bIsPersistent uint32 Indicates whether the shader map should be stored in the shader cache. OpenColorIOShared.h  
bRegistered uint32 Indicates whether this shader map has been registered in GIdToOpenColorsIOShaderMap OpenColorIOShared.h  
CompilingId uint32 Uniquely identifies this shader map during compilation, needed for deferred compilation where shaders from multiple shader maps are compiled together. OpenColorIOShared.h  
NumRefs int32   OpenColorIOShared.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddRef()

 Reference counting. OpenColorIOShared.h  

void Compile ( FOpenColorIOTransformResource* InColorTransform,
const FOpenColorIOShaderMapId& InShaderMapId,
TRefCountPtr< FSharedShaderCompilerEnvironment > InCompilationEnvironment,
const FOpenColorIOCompilationOutput& InOpenColorIOCompilationOutput,
EShaderPlatform InPlatform,
bool bSynchronousCompile,
bool bApplyCompletedShaderMapForRendering
)

 Compiles the shaders for a color transform and caches them in this shader map. OpenColorIOShared.h  

bool CompiledSuccessfully()

   OpenColorIOShared.h  

uint32 GetCompilingId ()

   OpenColorIOShared.h  

uint32 GetCompilingId ()

   OpenColorIOShared.h  

const FMemoryImageString & GetFriendlyName()

   OpenColorIOShared.h  

int32 GetNumRefs()

   OpenColorIOShared.h  

TShaderRef< FShader > GetShader ( FShaderType* ShaderType
) const

   OpenColorIOShared.h  

TShaderRef< ShaderType > GetShader ()

   OpenColorIOShared.h  

void GetShaderList ( TMap< FShaderId, TShaderRef< FShader > >& OutShaders
) const

 Builds a list of the shaders in a shader map. OpenColorIOShared.h  

const FOpenColorIOShaderMapId & GetShaderMapId()

 Accessors. OpenColorIOShared.h  

EShaderPlatform GetShaderPlatform()

   OpenColorIOShared.h  

bool IsCompilationFinalized()

   OpenColorIOShared.h  

bool IsComplete ( const FOpenColorIOTransformResource* InColorTransform,
bool bSilent
)

 Checks whether the shader map is missing any shader types necessary for the given color transform. OpenColorIOShared.h  

bool IsValid()

   OpenColorIOShared.h  

bool ProcessCompilationResults ( const TArray< TRefCountPtr< class FShaderCommonCompileJob > >& InCompilationResults,
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. OpenColorIOShared.h  

void Register ( EShaderPlatform InShaderPlatform
)

 Registers a OpenColorIO shader map in the global map so it can be used by OpenColorIO ColorTransform. OpenColorIOShared.h  

void Release()

   OpenColorIOShared.h  

void SaveToDerivedDataCache()

 Saves this shader map to the derived data cache. OpenColorIOShared.h  

bool Serialize ( FArchive& Ar
)

 Serializes the shader map. OpenColorIOShared.h  

void SetCompiledSuccessfully ( bool bSuccess
)

   OpenColorIOShared.h  

bool TryToAddToExistingCompilationTask ( FOpenColorIOTransformResource* InColorTransform
)

 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. OpenColorIOShared.h  

Overridden from FShaderMapBase

Name Remarks Include Path Unreal Specifiers

virtual void GetShaderList ( TMap< FHashedName, TShaderRef< FShader > >& OutShaders
) const

   OpenColorIOShared.h  

virtual void GetShaderPipelineList ( TArray< FShaderPipelineRef >& OutShaderPipelines
) const

   OpenColorIOShared.h  

Static

Name Remarks Include Path Unreal Specifiers

static FOpenColorIOShaderMap * FindId ( const FOpenColorIOShaderMapId& InShaderMapId,
EShaderPlatform InPlatform
)

 Finds the shader map for a color transform. Finds the shader map for a color transform. OpenColorIOShared.h  

static TMap< TRefCountPtr< FOpenColorIOShaderMap >, TArray< FOpenColorIOTransformResource * > > & GetInFlightShaderMaps()

   OpenColorIOShared.h  

static void LoadFromDerivedDataCache ( const FOpenColorIOTransformResource* InColorTransform,
const FOpenColorIOShaderMapId& InShaderMapId,
EShaderPlatform InPlatform,
TRefCountPtr< FOpenColorIOShaderMap >& InOutShaderMap
)

 Attempts to load the shader map for the given color transform from the Derived Data Cache. OpenColorIOShared.h  

static void RemovePendingColorTransform ( FOpenColorIOTransformResource* InColorTransform
)

 Removes a ColorTransform from OpenColorIOShaderMapsBeingCompiled. OpenColorIOShared.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page