UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSceneViewStateReference Class Reference

#include <SceneTypes.h>

Public Member Functions

 FSceneViewStateReference ()
 
virtual ENGINE_API ~FSceneViewStateReference ()
 
ENGINE_API void Allocate (ERHIFeatureLevel::Type FeatureLevel)
 
ENGINE_API void ShareOrigin (FSceneViewStateReference *Target)
 
ENGINE_API void Destroy ()
 
FSceneViewStateInterfaceGetReference ()
 

Detailed Description

Class used to reference an FSceneViewStateInterface that allows destruction and recreation of all FSceneViewStateInterface's when needed. This is used to support reloading the renderer module on the fly.

Constructor & Destructor Documentation

◆ FSceneViewStateReference()

FSceneViewStateReference::FSceneViewStateReference ( )
inline

◆ ~FSceneViewStateReference()

FSceneViewStateReference::~FSceneViewStateReference ( )
virtual

Member Function Documentation

◆ Allocate()

void FSceneViewStateReference::Allocate ( ERHIFeatureLevel::Type  FeatureLevel)

Allocates the Scene view state.

◆ Destroy()

void FSceneViewStateReference::Destroy ( )

Destorys the Scene view state.

◆ GetReference()

FSceneViewStateInterface * FSceneViewStateReference::GetReference ( )
inline

◆ ShareOrigin()

ENGINE_API void FSceneViewStateReference::ShareOrigin ( FSceneViewStateReference Target)

Mark that a view state shares an origin with another view state, allowing sharing of some internal state, saving memory and performance. Typically used for cube map faces. Must be called before "Allocate" is called on the source view state (best practice is to call immediately after creating the view state). Multiple view states can point to the same shared origin (for example, the first face of a cube map), but sharing can't be nested. Sharing view states must be destroyed before the Target is destroyed.


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