1. Epic GamesDeveloper
  3. FOpenColorIOTransformResource

FOpenColorIOTransformResource

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

API > API/Plugins > API/Plugins/OpenColorIO

FOpenColorIOTransformResource represents a OpenColorIO color transform to the shader compilation process

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

Syntax

class FOpenColorIOTransformResource

Constructors

Name Remarks Include Path Unreal Specifiers

FOpenColorIOTransformResource()

 Minimal initialization constructor. OpenColorIOShared.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FOpenColorIOTransformResource()

 Destructor OpenColorIOShared.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ShaderCode FString   OpenColorIOShared.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AssetPath FName Asset using this resource OpenColorIOShared.h  
bContainsInlineShaders uint32 Whether this ColorTransform was loaded with shaders inlined. OpenColorIOShared.h  
bLoadedCookedShaderMapId uint32   OpenColorIOShared.h  
CompileErrors TArray< FString >   OpenColorIOShared.h  
CookedShaderMapId FOpenColorIOShaderMapId   OpenColorIOShared.h  
FeatureLevel ERHIFeatureLevel::Type Feature level that this color transform is representing. OpenColorIOShared.h  
FriendlyName FString   OpenColorIOShared.h  
GameThreadShaderMap TRefCountPtr< FOpenColorIOShaderMap > Game thread tracked shader map, which is ref counted and manages shader map lifetime. OpenColorIOShared.h  
OutstandingCompileShaderMapIds TArray< int32, TInlineAllocator< 1 > > Contains the compiling id of this shader map when it is being compiled asynchronously. OpenColorIOShared.h  
RenderingThreadShaderMap FOpenColorIOShaderMap * Shader map for this FOpenColorIOTransformResource which is accessible by the rendering thread. OpenColorIOShared.h  
ShaderCodeAndConfigHash FString Hash computed from shader code and raw config hashes. OpenColorIOShared.h  
ShaderParametersMetadata TSharedPtr< const FShaderParametersMetadata, ESPMode::ThreadSafe > The shader parameter metadata for the generated shader (built-in FOpenColorIOPixelShaderParameters, followed by dynamic textures & samplers). OpenColorIOShared.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCompileId ( uint32 InIdentifier
)

   OpenColorIOShared.h  

bool CacheShaders ( const FOpenColorIOShaderMapId& InShaderMapId,
EShaderPlatform InPlatform,
bool bApplyCompletedShaderMapForRendering,
bool bSynchronous
)

   OpenColorIOShared.h  

bool CacheShaders ( EShaderPlatform InPlatform,
const ITargetPlatform* TargetPlatform,
bool bApplyCompletedShaderMapForRendering,
bool bSynchronous
)

 Caches the shaders for this color transform with no static parameters on the given platform. OpenColorIOShared.h  

void CancelCompilation()

 Cancels all outstanding compilation jobs OpenColorIOShared.h  

void DiscardShaderMap()

 Discards loaded shader maps if the application can't render OpenColorIOShared.h  

void FinishCompilation()

 Blocks until compilation has completed. Returns immediately if a compilation is not outstanding. OpenColorIOShared.h  

bool GetColorTransformHLSLSource ( FString& OutSource
)

 Get OCIO generated source code for the shader OpenColorIOShared.h  

const TArray< FString > & GetCompileErrors()

 Accessors. OpenColorIOShared.h  

void GetDependentShaderTypes ( EShaderPlatform InPlatform,
TArray< FShaderType* >& OutShaderTypes
) const

   OpenColorIOShared.h  

ERHIFeatureLevel::Type GetFeatureLevel()

   OpenColorIOShared.h  

const FString & GetFriendlyName()

   OpenColorIOShared.h  

FOpenColorIOShaderMap * GetGameThreadShaderMap()

   OpenColorIOShared.h  

FName GetOwnerFName()

 Returns owner name for tracking OpenColorIOShared.h  

TShaderRef< ShaderType > GetShader()

   OpenColorIOShared.h  

TShaderRef< ShaderType > GetShaderGameThread()

   OpenColorIOShared.h  

virtual void GetShaderMapId ( EShaderPlatform InPlatform,
const ITargetPlatform* TargetPlatform,
FOpenColorIOShaderMapId& OutId
) const

   OpenColorIOShared.h  

TSharedPtr< const FShaderParametersMetadata, ESPMode::ThreadSafe > GetShaderParamMetadata()

 Returns the shader parameter metadata for the generated shader (built-in FOpenColorIOPixelShaderParameters, followed by dynamic textures & samplers). OpenColorIOShared.h  

void Invalidate()

   OpenColorIOShared.h  

bool IsCompilationFinished()

 Checks if the compilation for this shader is finished OpenColorIOShared.h  

virtual bool IsPersistent()

 Should shaders compiled for this color transform be saved to disk? OpenColorIOShared.h  

bool IsSame ( const FOpenColorIOShaderMapId& InId
) const

   OpenColorIOShared.h  
Releases this color transform's shader map. OpenColorIOShared.h  

void RemoveOutstandingCompileId ( const int32 InOldOutstandingCompileShaderMapId
)

   OpenColorIOShared.h  

void SerializeShaderMap ( FArchive& Ar
)

   OpenColorIOShared.h  

void SetCompileErrors ( TArray< FString >& InErrors
)

   OpenColorIOShared.h  

void SetCompileErrors ( const TArray< FString >& InCompileErrors
)

   OpenColorIOShared.h  

void SetGameThreadShaderMap ( FOpenColorIOShaderMap* InShaderMap
)

 Note: SetRenderingThreadShaderMap must also be called with the same value, but from the rendering thread. OpenColorIOShared.h  

void SetInlineShaderMap ( FOpenColorIOShaderMap* InShaderMap
)

   OpenColorIOShared.h  

void SetRenderingThreadShaderMap ( FOpenColorIOShaderMap* InShaderMap
)

 Note: SetGameThreadShaderMap must also be called with the same value, but from the game thread. OpenColorIOShared.h  

void SetupResource ( ERHIFeatureLevel::Type InFeatureLevel,
const FString& InShaderCodeHash,
const FString& InShadercode,
const FString& InRawConfigHash,
const FString& InFriendlyName,
const FName& InAssetPath
)

   OpenColorIOShared.h  

void SetupResource ( ERHIFeatureLevel::Type InFeatureLevel,
const FString& InShaderCodeHash,
const FString& InShadercode,
const FString& InRawConfigHash,
const FString& InFriendlyName,
const FName& InAssetPath,
FShaderParametersMetadata* InShaderParameterMetadata
)

 Note: Takes ownership of the shader parameter metadata. OpenColorIOShared.h  

virtual bool ShouldCache ( EShaderPlatform InPlatform,
const FShaderType* InShaderType
) const

 Should the shader for this color transform with the given platform, shader type and vertex factory type combination be compiled OpenColorIOShared.h  

Protected

Name Remarks Include Path Unreal Specifiers

void GetShaderMapIDsWithUnfinishedCompilation ( TArray< int32 >& OutShaderMapIds
)

 Fills the passed array with IDs of shader maps unfinished compilation jobs. OpenColorIOShared.h  

void SetFeatureLevel ( ERHIFeatureLevel::Type InFeatureLevel
)

   OpenColorIOShared.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page