FOpenColorIOTransformResource

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

Windows
MacOS
Linux

References

Module

OpenColorIO

Header

/Engine/Plugins/Compositing/OpenColorIO/Source/OpenColorIO/Public/OpenColorIOShared.h

Include

#include "OpenColorIOShared.h"

Syntax

class FOpenColorIOTransformResource

Remarks

FOpenColorIOTransformResource represents a OpenColorIO color transform to the shader compilation process

Variables

Name Description

Public variable

FString

 

ShaderCode

Constructors

Name Description

Public function

FOpenColorIOTransformResource()

Minimal initialization constructor.

Destructors

Name Description

Public function Virtual

~FOpenColorIOTransformResource()

Destructor

Functions

Name Description

Public function

void

 

AddCompileId

(
    uint32 InIdentifier
)

Public function

bool

 

CacheShaders

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

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

Public function

bool

 

CacheShaders

(
    EShaderPlatform InPlatform,
    bool bApplyCompletedShaderMapForRendering,
    bool bSynchronous
)

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

Public function

void

 

CancelCompilation()

Cancels all outstanding compilation jobs

Public function

void

 

DiscardShaderMap()

Discards loaded shader maps if the application can't render

Public function

void

 

FinishCompilation()

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

Public function

bool

 

GetColorTransformHLSLSource

(
    FString& OutSource
)

Get OCIO generated source code for the shader

Public function Const

const TArray< FString > &

 

GetCompileErrors()

Accessors.

Public function Const

void

 

GetDependentShaderTypes

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

Public function Const

ERHIFeatureLevel::Type

 

GetFeatureLevel()

Public function Const

const FString &

 

GetFriendlyName()

Public function Const

FOpenColorIOShaderMap *

 

GetGameThreadShaderMap()

Public function Const

FOpenColorIOPixelShader *

 

GetShader()

Public function Const

FOpenColorIOPixelShader *

 

GetShaderGameThread()

Public function Virtual Const

void

 

GetShaderMapId

(
    EShaderPlatform InPlatform,
    FOpenColorIOShaderMapId& OutId
)

Protected function

void

 

GetShaderMapIDsWithUnfinishedCompilation

(
    TArray< int32 >& OutShaderMapIds
)

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

Public function

void

 

Invalidate()

Public function Const

bool

 

IsCompilationFinished()

Checks if the compilation for this shader is finished

Public function Virtual Const

bool

 

IsPersistent()

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

Public function Const

bool

 

IsSame

(
    const FOpenColorIOShaderMapId& InId
)

Public function Virtual

void

 

NotifyCompilationFinished()

Called when compilation finishes, after the GameThreadShaderMap is set and the render command to set the RenderThreadShaderMap is queued

Public function

void

 

RegisterShaderMap()

Public function

void

 

ReleaseShaderMap()

Releases this color transform's shader map.

Public function

void

 

RemoveOutstandingCompileId

(
    const int32 InOldOutstandingCompileShaderMapId
)

Public function

void

 

SerializeShaderMap

(
    FArchive& Ar
)

Public function

void

 

SetCompileErrors

(
    const TArray< FString >& InCompileErrors
)

Public function

void

 

SetCompileErrors

(
    TArray< FString >& InErrors
)

Protected function

void

 

SetFeatureLevel

(
    ERHIFeatureLevel::Type InFeatureLevel
)

Public function

void

 

SetGameThreadShaderMap

(
    FOpenColorIOShaderMap* InShaderMap
)

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

Public function

void

 

SetInlineShaderMap

(
    FOpenColorIOShaderMap* InShaderMap
)

Public function

void

 

SetRenderingThreadShaderMap

(
    FOpenColorIOShaderMap* InShaderMap
)

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

Public function

void

 

SetupResource

(
    ERHIFeatureLevel::Type InFeatureLevel,
    const FString& InShaderCodeHash,
    const FString& InShadercode,
    const FString& InFriendlyName
)

Public function Virtual Const

bool

 

ShouldCache

(
    EShaderPlatform InPlatform,
    const FShaderType* InShaderType
)

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback