FOpenColorIOShaderType

A shader meta type for OpenColorIO-linked shaders.

Windows
MacOS
Linux

Inheritance Hierarchy

FShaderType

FOpenColorIOShaderType

References

Module

OpenColorIO

Header

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

Include

#include "OpenColorIOShaderType.h"

Syntax

class FOpenColorIOShaderType : public FShaderType

Remarks

A shader meta type for OpenColorIO-linked shaders.

Constructors

Name Description

Public function

FOpenColorIOShaderType

(
    FTypeLayoutDesc& InTypeLayout,
    const TCHAR* InName,
    const TCHAR* InSourceFilename,
    const TCHAR* InFunctionName,
    uint32 InFrequency,
    int32 InTotalPermutationCount,
    ConstructSerializedType InConstruct...,
    ConstructCompiledType InConstructCo...,
    ModifyCompilationEnvironmentType In...,
    ShouldCompilePermutationType InShou...,
    ValidateCompiledResultType InValida...,
    uint32 InTypeSize,
    const FShaderParametersMetadata...
)

Functions

Name Description

Public function

FShaderCompi...

 

BeginCompileShader

(
    uint32 ShaderMapId,
    const FOpenColorIOTransformResource...,
    FShaderCompilerEnvironment* Co...,
    EShaderPlatform Platform,
    TArray< TSharedRef< FShaderCommonCo...,
    FShaderTarget Target
)

Enqueues a compilation for a new shader of this type.

Public function

FShader *...

 

FinishCompileShader

(
    const FSHAHash& InOCIOShaderMapHas...,
    const FShaderCompileJob& CurrentJo...,
    const FString& InDebugDescription
)

Either creates a new instance of this type or returns an equivalent existing shader.

Protected function Const

void

 

SetupCompileEnvironment

(
    EShaderPlatform InPlatform,
    const FOpenColorIOTransformResource...,
    FShaderCompilerEnvironment& OutEnv...
)

Sets up the environment used to compile an instance of this shader type.

Public function Const

bool

 

ShouldCache

(
    EShaderPlatform InPlatform,
    const FOpenColorIOTransformResource...
)

Checks if the shader type should be cached for a particular platform and color transform.

Classes

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss