Navigation
Unreal Engine C++ API Reference > Plugins > OpenColorIO
Inheritance Hierarchy
- TShaderMap< FOpenColorIOShaderMapContent, FShaderMapPointerTable >
- 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
Type | Name | Description | |
---|---|---|---|
![]() |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() |
Destructor. |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | AddRef () |
Reference counting. |
![]() |
void | Compile
(
FOpenColorIOTransformResource* InColorTransform, |
Compiles the shaders for a color transform and caches them in this shader map. |
![]() ![]() |
bool | ||
![]() ![]() |
FOpenColorIOShaderMap * | FindId
(
const FOpenColorIOShaderMapId& InShaderMapId, |
Finds the shader map for a color transform. Finds the shader map for a color transform. |
![]() |
uint32 | ||
![]() ![]() |
uint32 | ||
![]() ![]() |
const FMemoryImageString & | ||
![]() ![]() |
TMap< TRefCountPtr< FOpenColorIOShaderMap >, TArray< FOpenColorIOTransformResource * > > & | ||
![]() ![]() |
int32 | GetNumRefs () |
|
![]() ![]() |
TShaderRef< FShader > | GetShader
(
FShaderType* ShaderType |
|
![]() ![]() |
TShaderRef< ShaderType > | GetShader () |
|
![]() ![]() |
void | GetShaderList
(
TMap< FShaderId, TShaderRef< FShader > >& OutShaders |
Builds a list of the shaders in a shader map. |
![]() ![]() ![]() |
void | GetShaderList
(
TMap< FHashedName, TShaderRef< FShader > >& OutShaders |
|
![]() ![]() |
const FOpenColorIOShaderMapId & | Accessors. | |
![]() ![]() ![]() |
void | GetShaderPipelineList
(
TArray< FShaderPipelineRef >& OutShaderPipelines |
|
![]() ![]() |
EShaderPlatform | ||
![]() ![]() |
bool | ||
![]() |
bool | IsComplete
(
const FOpenColorIOTransformResource* InColorTransform, |
Checks whether the shader map is missing any shader types necessary for the given color transform. |
![]() ![]() |
bool | IsValid () |
|
![]() ![]() |
void | LoadFromDerivedDataCache
(
const FOpenColorIOTransformResource* InColorTransform, |
Attempts to load the shader map for the given color transform from the Derived Data Cache. |
![]() |
bool | ProcessCompilationResults
(
const TArray< TRefCountPtr< class FShaderCommonCompileJob > >& InCompilationResults, |
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* InColorTransform |
Removes a ColorTransform from OpenColorIOShaderMapsBeingCompiled. |
![]() |
void | Saves this shader map to the derived data cache. | |
![]() |
bool | Serialize
(
FArchive& Ar |
Serializes the shader map. |
![]() |
void | SetCompiledSuccessfully
(
bool bSuccess |
|
![]() |
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. |
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. |