FStereoLayerAdditionalFlagsManager | Unreal Engine 5.7 Documentation

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.


Name	FStereoLayerAdditionalFlagsManager
Type	class
Header File	/Engine/Source/Runtime/Engine/Public/StereoLayerAdditionalFlagsManager.h
Include Path	#include "StereoLayerAdditionalFlagsManager.h"

Syntax

class FStereoLayerAdditionalFlagsManager

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FStereoLayerAdditionalFlagsManager()		StereoLayerAdditionalFlagsManager.h

Constants

Name	Type	Remarks	Include Path
Instance	TSharedPtr< FStereoLayerAdditionalFlagsManager >		StereoLayerAdditionalFlagsManager.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
RuntimeFlags	TMap< FName, uint32 >	Maps flags with their runtime values.	StereoLayerAdditionalFlagsManager.h
UniqueFlags	TSet< FName >	All the unique flags provided by suppliers.	StereoLayerAdditionalFlagsManager.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
uint32 GetFlagValue ( const FName Flag ) const	Returns the value of the flag if it has been found, 0 otherwise.	StereoLayerAdditionalFlagsManager.h

Static

Name	Remarks	Include Path
static void CollectFlags ( TSet< FName >& OutFlags )	Collect all flags to use in StereoLayerComponents.	StereoLayerAdditionalFlagsManager.h
static void Destroy()	Destroys manager when a game or PIE session is ending.	StereoLayerAdditionalFlagsManager.h
static TSharedPtr< FStereoLayerAdditionalFlagsManager > Get()	Returns instance of this class. If it doesn't exist yet, it creates one and collects all the flags.	StereoLayerAdditionalFlagsManager.h

Navigation