1. Epic GamesDeveloper
  3. FVariableRateShadingImageManager

FVariableRateShadingImageManager

API > API/Runtime > API/Runtime/Renderer

   
Name FVariableRateShadingImageManager
Type class
Header File /Engine/Source/Runtime/Renderer/Public/VariableRateShadingImageManager.h
Include Path #include "VariableRateShadingImageManager.h"

Syntax

class FVariableRateShadingImageManager : public FRenderResource

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FVariableRateShadingImageManager()

 Public functions VariableRateShadingImageManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FVariableRateShadingImageManager()

   VariableRateShadingImageManager.h  

Enums

Public

Name Remarks
EVRSImageType Image type to request from generator.
EVRSPassType Pass type used to determine requested image type based on current CVar settings.
EVRSSourceType Explicit VRS source flags; each type of VRS image generated here will have it's own flag defined in this bitfield.

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveGenerators TArray< IVariableRateShadingImageGenerator * >   VariableRateShadingImageManager.h  
bHardwareVRSEnabledForFrame bool   VariableRateShadingImageManager.h  
bNeedStaticMeshUpdate bool   VariableRateShadingImageManager.h  
bSoftwareVRSEnabledForFrame bool   VariableRateShadingImageManager.h  
GeneratorsMutex FRWLock Guards ImageGenerators because most of the calls of the manager are on the render thread but the Register/UnregisterExternalImageGenerator could come from the game thread. VariableRateShadingImageManager.h  
ImageGenerators TArray< IVariableRateShadingImageGenerator * > Used to access the generators functionalities. VariableRateShadingImageManager.h  
InternalGenerators TArray< TUniquePtr< IVariableRateShadingImageGenerator > > This is used only to own the memory of generators created in the FVariableRateShadingImageManager constructor. VariableRateShadingImageManager.h  
MobileHMDFixedFoveationOverrideImage TRefCountPtr< IPooledRenderTarget >   VariableRateShadingImageManager.h  
VRSForceRateForFrame int32   VariableRateShadingImageManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DrawDebugPreview ( FRDGBuilder& GraphBuilder,
const FSceneViewFamily& ViewFamily,
FRDGTextureRef OutputSceneColor
)

   VariableRateShadingImageManager.h  

bool GetNeedStaticMeshUpdate()

   VariableRateShadingImageManager.h  

FRDGTextureRef GetVariableRateShadingImage ( FRDGBuilder& GraphBuilder,
const FViewInfo& ViewInfo,
EVRSPassType PassType,
bool bRequestSoftwareImage
)

 Get the combined VRS image for the specified view setup, target size/configuration, and application flags. VariableRateShadingImageManager.h  

bool IsAttachmentVRSEnabled()

   VariableRateShadingImageManager.h  

bool IsHardwareVRSEnabled()

   VariableRateShadingImageManager.h  

bool IsHardwareVRSEnabledForFrame()

   VariableRateShadingImageManager.h  

bool IsPipelineVRSEnabled()

   VariableRateShadingImageManager.h  

bool IsSoftwareVRSEnabled()

   VariableRateShadingImageManager.h  

bool IsSoftwareVRSEnabledForFrame()

   VariableRateShadingImageManager.h  

bool IsTypeEnabledForView ( const FSceneView& View,
EVRSSourceType Type
)

 Returns true if any generator among the given types is enabled, false otherwise. VariableRateShadingImageManager.h  

bool IsVRSEnabledForFrame()

   VariableRateShadingImageManager.h  

void PrepareImageBasedVRS ( FRDGBuilder& GraphBuilder,
const FSceneViewFamily& ViewFamily,
const FMinimalSceneTextures& SceneTextures
)

 Prepare VRS images and store them for later access. VariableRateShadingImageManager.h  

void RegisterExternalImageGenerator ( IVariableRateShadingImageGenerator* ExternalGenerator
)

   VariableRateShadingImageManager.h  

void SetNeedStaticMeshUpdate ( bool bInNeedStaticMeshUpdate
)

   VariableRateShadingImageManager.h  

void UnregisterExternalImageGenerator ( IVariableRateShadingImageGenerator* ExternalGenerator
)

   VariableRateShadingImageManager.h  

Overridden from FRenderResource

Name Remarks Include Path Unreal Specifiers

virtual void InitRHI ( FRHICommandListBase& RHICmdList
)

   VariableRateShadingImageManager.h  

virtual void ReleaseRHI()

   VariableRateShadingImageManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 GetNumberOfSupportedRates()

   VariableRateShadingImageManager.h  

static FRDGTextureDesc GetSRIDesc ( const FSceneViewFamily& ViewFamily,
bool bSoftwareSize
)

   VariableRateShadingImageManager.h  

static FIntPoint GetSRITileSize ( bool bSoftwareSize
)

   VariableRateShadingImageManager.h  

static bool IsHardwareVRSSupported()

   VariableRateShadingImageManager.h  

static bool IsSoftwareVRSSupported()

   VariableRateShadingImageManager.h  

static bool IsVRSCompatibleWithOutputType ( const EDisplayOutputFormat& DisplayOutputFormat
)

   VariableRateShadingImageManager.h  

static bool IsVRSCompatibleWithView ( const FViewInfo& View
)

   VariableRateShadingImageManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page