FOpenColorIODisplayExtension

View extension applying an OCIO Display Look to the viewport we're attached to

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSceneViewExtensionBase

FGCObject

FOpenColorIODisplayExtension

References

Module

OpenColorIO

Header

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

Include

#include "OpenColorIODisplayExtension.h"

Syntax

class FOpenColorIODisplayExtension :
    public FSceneViewExtensionBase,
    public FGCObject

Remarks

View extension applying an OCIO Display Look to the viewport we're attached to

Constructors

Name Description

Public function

FOpenColorIODisplayExtension

(
    const FAutoRegister& AutoRegister,
    FViewportClient* AssociatedVie...
)

Functions

Name Description

Public function

FViewportCli...

 

GetAssociatedViewportClient()

Returns the ViewportClient this extension is currently attached to

Public function Const

const FOpenC...

 

GetDisplayConfiguration()

Returns the current display configuration in a const manner

Public function

FOpenColorIO...

 

GetDisplayConfiguration()

Returns the current display configuration to be updated

Public function

FScreenPassT...

 

PostProcessPassAfterTonemap_RenderThread

(
    FRDGBuilder& GraphBuilder,
    const FSceneView& View,
    const FPostProcessMaterialInputs& ...
)

Public function

void

 

SetDisplayConfiguration

(
    const FOpenColorIODisplayConfigurat...
)

Overridden from ISceneViewExtension

Name Description

Public function Virtual

void

 

BeginRenderViewFamily

(
    FSceneViewFamily& InViewFamily
)

Called on game thread when view family is about to be rendered.

Public function Virtual Const

int32

 

GetPriority()

Called to determine view extensions priority in relation to other view extensions, higher comes first

Public function Virtual Const

bool

 

IsActiveThisFrame_Internal

(
    const FSceneViewExtensionContext& ...
)

Temporary override so that old behaviour still functions. Will be removed along with IsActiveThisFrame(FViewport*).

Public function Virtual

void

 

PreRenderView_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    FSceneView& InView
)

Called on render thread at the start of rendering, for each view, after PreRenderViewFamily_RenderThread call.

Public function Virtual

void

 

PreRenderViewFamily_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    FSceneViewFamily& InViewFamily
)

Called on render thread at the start of rendering.

Public function Virtual

void

 

SetupView

(
    FSceneViewFamily& InViewFamily,
    FSceneView& InView
)

Called on game thread when creating the view.

Public function Virtual

void

 

SetupViewFamily

(
    FSceneViewFamily& InViewFamily
)

Called on game thread when creating the view family.

Public function Virtual

void

 

SubscribeToPostProcessingPass

(
    EPostProcessingPass Pass,
    FAfterPassCallbackDelegateArray& I...,
    bool bIsPassEnabled
)

This will be called at the beginning of post processing to make sure that each view extension gets a chance to subscribe to an after pass event.

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Pure virtual that must be overloaded by the inheriting class.

Public function Virtual Const

FString

 

GetReferencerName()

Use this method to report a name for your referencer.

Constants

Name

Description

DefaultDisplayGamma