FOpenColorIOShaderMap

The shaders required to apply an OCIO color transform.

Choose your operating system:

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

Public function

FOpenColorIOShaderMap()

Destructors

Name Description

Public function

~FOpenColorIOShaderMap()

Destructor.

Functions

Name Description

Public function

void

 

AddRef()

Reference counting.

Public function

void

 

Compile

(
    FOpenColorIOTransformResource*...,
    const FOpenColorIOShaderMapId& InS...,
    TRefCountPtr< FSharedShaderCompiler...,
    const FOpenColorIOCompilationOutput...,
    EShaderPlatform InPlatform,
    bool bSynchronousCompile,
    bool bApplyCompletedShaderMapForRen...
)

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

Public function Const

bool

 

CompiledSuccessfully()

Public function Static

FOpenColorIO...

 

FindId

(
    const FOpenColorIOShaderMapId& InS...,
    EShaderPlatform InPlatform
)

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

Public function

void

 

FlushShadersByShaderType

(
    const FShaderType* ShaderType
)

Removes all entries in the cache with exceptions based on a shader type

Public function

uint32

 

GetCompilingId()

Public function Const

uint32

 

GetCompilingId()

Public function Const

const FMemor...

 

GetFriendlyName()

Public function Static

TMap< TRefCo...

 

GetInFlightShaderMaps()

Public function Const

int32

 

GetNumRefs()

Public function Const

TShaderRef< ...

 

GetShader()

Public function Const

TShaderRef< ...

 

GetShader

(
    FShaderType* ShaderType
)

Public function Const

void

 

GetShaderList

(
    TMap< FShaderId, TShaderRef< FShade...
)

Builds a list of the shaders in a shader map.

Public function Const

const FOpenC...

 

GetShaderMapId()

Accessors.

Public function Const

EShaderPlatf...

 

GetShaderPlatform()

Public function Const

bool

 

IsCompilationFinalized()

Public function

bool

 

IsComplete

(
    const FOpenColorIOTransformResource...,
    bool bSilent
)

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

Public function Const

bool

 

IsValid()

Public function Static

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.

Public function

bool

 

ProcessCompilationResults

(
    const TArray< FShaderCommonCompileJ...,
    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.

Public function

void

 

Register

(
    EShaderPlatform InShaderPlatform
)

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

Public function

void

 

Release()

Public function Static

void

 

RemovePendingColorTransform

Removes a ColorTransform from OpenColorIOShaderMapsBeingCompiled.

Public function

void

 

SaveToDerivedDataCache()

Saves this shader map to the derived data cache.

Public function

bool

 

Serialize

(
    FArchive& Ar,
    bool bInlineShaderResources
)

Serializes the shader map.

Public function

void

 

SetCompiledSuccessfully

(
    bool bSuccess
)

Public function

bool

 

TryToAddToExistingCompilationTask

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.