ISceneViewExtension

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/SceneViewExtension.h

Include

#include "SceneViewExtension.h"

Syntax

class ISceneViewExtension

Destructors

Name Description

Public function Virtual

~ISceneViewExtension()

Functions

Name Description

Public function

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

(
    FViewport* InViewport
)

Returning false disables the extension for the current frame.

Public function Virtual

void

 

PostRenderBasePass_RenderThread

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

Called right after Base Pass rendering finished

Public function Virtual

void

 

PostRenderView_RenderThread

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

Allows to render content after the 3D content scene, useful for debugging

Public function Virtual

void

 

PostRenderViewFamily_RenderThread

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

Allows to render content after the 3D content scene, useful for debugging

Public function

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

void

 

PreRenderViewFamily_RenderThread

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

Called on render thread at the start of rendering.

Public function

void

 

SetupView

(
    FSceneViewFamily& InViewFamily,
    FSceneView& InView
)

Called on game thread when creating the view.

Public function

void

 

SetupViewFamily

(
    FSceneViewFamily& InViewFamily
)

Called on game thread when creating the view family.

Public function Virtual

void

 

SetupViewPoint

(
    APlayerController* Player,
    FMinimalViewInfo& InViewInfo
)

Called when creating the viewpoint, before culling, in case an external tracking device needs to modify the base location of the view

Public function Virtual

void

 

SetupViewProjectionMatrix

(
    FSceneViewProjectionData& InOutPro...
)

Called when creating the view, in case non-stereo devices need to update projection matrix.

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