IDynamicResolutionState Class Reference

#include <DynamicResolutionState.h>

Inheritance diagram for IDynamicResolutionState:

Public Member Functions
virtual	~IDynamicResolutionState ()
virtual void	ResetHistory ()=0
virtual bool	IsSupported () const =0
virtual void	SetupMainViewFamily (class FSceneViewFamily &ViewFamily)=0
virtual void	SetTemporalUpscaler (const UE::Renderer::Private::ITemporalUpscaler *InTemporalUpscaler)=0

Protected Member Functions
virtual DynamicRenderScaling::TMap< float >	GetResolutionFractionsApproximation () const =0
virtual DynamicRenderScaling::TMap< float >	GetResolutionFractionsUpperBound () const =0
virtual DynamicRenderScaling::TMap< float >	GetResolutionFractionsUpperBoundBudgetValue () const
virtual void	SetEnabled (bool bEnable)=0
virtual bool	IsEnabled () const =0
virtual void	ProcessEvent (EDynamicResolutionStateEvent Event)=0

Friends
class	UEngine

Detailed Description

Interface between the engine and state of dynamic resolution that can be overriden to implement a custom heurstic.

Constructor & Destructor Documentation

~IDynamicResolutionState()

virtual IDynamicResolutionState::~IDynamicResolutionState ( )

inlinevirtual

Member Function Documentation

GetResolutionFractionsApproximation()

virtual DynamicRenderScaling::TMap< float > IDynamicResolutionState::GetResolutionFractionsApproximation ( ) const

protectedpure virtual

Returns a non thread safe aproximation of the current resolution fraction applied on render thread, mostly used for stats and analytic.

Implemented in FDefaultDynamicResolutionState.

GetResolutionFractionsUpperBound()

virtual DynamicRenderScaling::TMap< float > IDynamicResolutionState::GetResolutionFractionsUpperBound ( ) const

protectedpure virtual

Returns the max resolution resolution fraction.

Implemented in FDefaultDynamicResolutionState.

GetResolutionFractionsUpperBoundBudgetValue()

virtual DynamicRenderScaling::TMap< float > IDynamicResolutionState::GetResolutionFractionsUpperBoundBudgetValue ( ) const

inlineprotectedvirtual

Returns the max resolution resolution fraction as specified in the budget (this can differ from the upper bound if the upper bound is dynamic)

Reimplemented in FDefaultDynamicResolutionState.

IsEnabled()

virtual bool IDynamicResolutionState::IsEnabled ( ) const

protectedpure virtual

Returns whether dynamic resolution is enabled for GEngine to know the EDynamicResolutionStatus.

Implemented in FDefaultDynamicResolutionState.

IsSupported()

virtual bool IDynamicResolutionState::IsSupported ( ) const

pure virtual

Returns whether dynamic resolution is supported on this platform.

Using dynamic resolution on unsupported platforms is extremely dangerous for gameplay experience, since it may have a bug dropping resolution or frame rate more than it should.

Implemented in FDefaultDynamicResolutionState.

ProcessEvent()

virtual void IDynamicResolutionState::ProcessEvent ( EDynamicResolutionStateEvent  Event )

protectedpure virtual

Process dynamic resolution events. UEngine::EmitDynamicResolutionEvent() guareentee to have all events being ordered.

Implemented in FDefaultDynamicResolutionState.

ResetHistory()

virtual void IDynamicResolutionState::ResetHistory ( )

pure virtual

Reset dynamic resolution's history.

Implemented in FDefaultDynamicResolutionState.

SetEnabled()

virtual void IDynamicResolutionState::SetEnabled ( bool  bEnable )

protectedpure virtual

Enables/Disables dynamic resolution. This is only called by GEngine automatically.

Implemented in FDefaultDynamicResolutionState.

SetTemporalUpscaler()

virtual void IDynamicResolutionState::SetTemporalUpscaler ( const UE::Renderer::Private::ITemporalUpscaler *  InTemporalUpscaler )

pure virtual

Apply the minimum/maximum resolution fraction for a third-party temporal upscaler.

Implemented in FDefaultDynamicResolutionState.

SetupMainViewFamily()

virtual void IDynamicResolutionState::SetupMainViewFamily ( class FSceneViewFamily &  ViewFamily )

pure virtual

Setup a screen percentage driver for a given view family.

Implemented in FDefaultDynamicResolutionState.

Friends And Related Symbol Documentation

UEngine

friend class UEngine

friend

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Engine/Public/DynamicResolutionState.h