FStereoLayerAdditionalFlagsManager | Unreal Engine 5.4 Documentation

References


Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/StereoLayerAdditionalFlagsManager.h
Include	#include "StereoLayerAdditionalFlagsManager.h"

Syntax

class FStereoLayerAdditionalFlagsManager

Remarks

To add flags to StereoLayerComponents from plugins, please follow this procedure:

Implement the IStereoLayersFlagsSupplier interface.

Register the modular feature: IModularFeatures::Get().RegisterModularFeature(IStereoLayersFlagsSupplier::GetModularFeatureName(), this);

Unregister the modular feature when the plugin is torn down: IModularFeatures::Get().UnregisterModularFeature(IStereoLayersFlagsSupplier::GetModularFeatureName(), this);

Implement the EnumerateFlags(TSet& OutFlags) function, where you can add your flags. A simple implementation might be: void MyFlagSupplier::EnumerateFlags(TSet& OutFlags) { OutFlags.Add(FName("MY_FLAG_1")); OutFlags.Add(FName("MY_FLAG_2")); }

It's up to the developers to make sure the flag values are not overflowing.

At runtime, use TSharedPtr FlagsManager = FStereoLayerAdditionalFlagsManager::Get(); FlagsManager->GetFlagValue(Flag); to get flags value to check against the flags in your StereoLayerComponents.

Constructors

No constructors are accessible with public or protected access.

Functions

Type	Name	Description
void	CollectFlags ( TSet< FName >& OutFlags )	Collect all flags to use in StereoLayerComponents.
void	Destroy ()	Destroys manager when a game or PIE session is ending.
TSharedPtr< FStereoLayerAdditionalFlagsManager >	Get ()	Returns instance of this class. If it doesn't exist yet, it creates one and collects all the flags.
uint32	GetFlagValue ( const FName Flag )	Returns the value of the flag if it has been found, 0 otherwise.

Constants

Name	Description
Instance