Navigation
API > API/Runtime > API/Runtime/Engine
Interface between the engine and state of dynamic resolution that can be overriden to implement a custom heurstic.
| Name | IDynamicResolutionState |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/DynamicResolutionState.h |
| Include Path | #include "DynamicResolutionState.h" |
Syntax
class IDynamicResolutionState
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IDynamicResolutionState() |
DynamicResolutionState.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsSupported () |
Returns whether dynamic resolution is supported on this platform. | DynamicResolutionState.h | |
void ResetHistory() |
Reset dynamic resolution's history. | DynamicResolutionState.h | |
void SetTemporalUpscaler
(
const UE::Renderer::Private::ITemporalUpscaler* InTemporalUpscaler |
Apply the minimum/maximum resolution fraction for a third-party temporal upscaler. | DynamicResolutionState.h | |
void SetupMainViewFamily
(
FSceneViewFamily& ViewFamily |
Setup a screen percentage driver for a given view family. | DynamicResolutionState.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
DynamicRenderScaling::TMap< float > GetResolutionFractionsApproximation() |
Returns a non thread safe aproximation of the current resolution fraction applied on render thread, mostly used for stats and analytic. | DynamicResolutionState.h | |
DynamicRenderScaling::TMap< float > GetResolutionFractionsUpperBound() |
Returns the max resolution resolution fraction. | DynamicResolutionState.h | |
virtual DynamicRenderScaling::TMap< float > GetResolutionFractionsUpperBoundBudgetValue() |
Returns the max resolution resolution fraction as specified in the budget (this can differ from the upper bound if the upper bound is dynamic) | DynamicResolutionState.h | |
bool IsEnabled() |
Returns whether dynamic resolution is enabled for GEngine to know the EDynamicResolutionStatus. | DynamicResolutionState.h | |
void ProcessEvent
(
EDynamicResolutionStateEvent Event |
Process dynamic resolution events. | DynamicResolutionState.h | |
void SetEnabled
(
bool bEnable |
Enables/Disables dynamic resolution. This is only called by GEngine automatically. | DynamicResolutionState.h |