UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FDefaultDynamicResolutionState Class Reference
+ Inheritance diagram for FDefaultDynamicResolutionState:

Public Member Functions

 FDefaultDynamicResolutionState ()
 
 ~FDefaultDynamicResolutionState () override
 
virtual bool IsSupported () const override
 
virtual void ResetHistory () override
 
virtual void SetEnabled (bool bEnable) override
 
virtual bool IsEnabled () const override
 
virtual DynamicRenderScaling::TMap< floatGetResolutionFractionsApproximation () const override
 
virtual DynamicRenderScaling::TMap< floatGetResolutionFractionsUpperBound () const override
 
virtual DynamicRenderScaling::TMap< floatGetResolutionFractionsUpperBoundBudgetValue () const override
 
virtual void ProcessEvent (EDynamicResolutionStateEvent Event) override
 
virtual void SetupMainViewFamily (class FSceneViewFamily &ViewFamily) override
 
virtual void SetTemporalUpscaler (const UE::Renderer::Private::ITemporalUpscaler *InTemporalUpscaler)
 
- Public Member Functions inherited from IDynamicResolutionState
virtual ~IDynamicResolutionState ()
 

Additional Inherited Members

Detailed Description

Engine's default dynamic resolution state.

Constructor & Destructor Documentation

◆ FDefaultDynamicResolutionState()

FDefaultDynamicResolutionState::FDefaultDynamicResolutionState ( )
inline

◆ ~FDefaultDynamicResolutionState()

FDefaultDynamicResolutionState::~FDefaultDynamicResolutionState ( )
inlineoverride

Member Function Documentation

◆ GetResolutionFractionsApproximation()

virtual DynamicRenderScaling::TMap< float > FDefaultDynamicResolutionState::GetResolutionFractionsApproximation ( ) const
inlineoverridevirtual

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

Implements IDynamicResolutionState.

◆ GetResolutionFractionsUpperBound()

virtual DynamicRenderScaling::TMap< float > FDefaultDynamicResolutionState::GetResolutionFractionsUpperBound ( ) const
inlineoverridevirtual

Returns the max resolution resolution fraction.

Implements IDynamicResolutionState.

◆ GetResolutionFractionsUpperBoundBudgetValue()

virtual DynamicRenderScaling::TMap< float > FDefaultDynamicResolutionState::GetResolutionFractionsUpperBoundBudgetValue ( ) const
inlineoverridevirtual

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 from IDynamicResolutionState.

◆ IsEnabled()

virtual bool FDefaultDynamicResolutionState::IsEnabled ( ) const
inlineoverridevirtual

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

Implements IDynamicResolutionState.

◆ IsSupported()

virtual bool FDefaultDynamicResolutionState::IsSupported ( ) const
inlineoverridevirtual

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.

Implements IDynamicResolutionState.

◆ ProcessEvent()

virtual void FDefaultDynamicResolutionState::ProcessEvent ( EDynamicResolutionStateEvent  Event)
inlineoverridevirtual

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

Implements IDynamicResolutionState.

◆ ResetHistory()

virtual void FDefaultDynamicResolutionState::ResetHistory ( )
inlineoverridevirtual

Reset dynamic resolution's history.

Implements IDynamicResolutionState.

◆ SetEnabled()

virtual void FDefaultDynamicResolutionState::SetEnabled ( bool  bEnable)
inlineoverridevirtual

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

Implements IDynamicResolutionState.

◆ SetTemporalUpscaler()

virtual void FDefaultDynamicResolutionState::SetTemporalUpscaler ( const UE::Renderer::Private::ITemporalUpscaler InTemporalUpscaler)
inlinevirtual

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

Implements IDynamicResolutionState.

◆ SetupMainViewFamily()

virtual void FDefaultDynamicResolutionState::SetupMainViewFamily ( class FSceneViewFamily ViewFamily)
inlineoverridevirtual

Setup a screen percentage driver for a given view family.

Implements IDynamicResolutionState.


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