Navigation
API > API/Plugins > API/Plugins/VirtualCamera > API/Plugins/VirtualCamera/FunctionLibraries
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UBlueprintFunctionLibrary
- UGameViewFunctionLibrary
References
| Module | VirtualCamera |
| Header | /Engine/Plugins/VirtualProduction/VirtualCamera/Source/VirtualCamera/Public/FunctionLibraries/GameViewFunctionLibrary.h |
| Include | #include "FunctionLibraries/GameViewFunctionLibrary.h" |
Syntax
UCLASS ()
class UGameViewFunctionLibrary : public UBlueprintFunctionLibrary
Remarks
Library for changing the viewport into game view. Game view shows the scene as it appears in game.
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | CanToggleGameView
(
EVCamTargetViewportID ViewportID |
Only works in editor builds. | |
| bool | IsInGameView
(
EVCamTargetViewportID ViewportID |
Only works in editor builds. | |
| void | RestoreGameViewStates
(
const TMap< EVCamTargetViewportID, bool >& Snapshot |
Sets the game view of the viewports as specified in the map. | |
| void | SetGameViewEnabled
(
EVCamTargetViewportID ViewportID, |
Sets whether the specified viewport should have the game view enabled. | |
| void | SetGameViewEnabledForAllViewports
(
bool bIsEnabled |
Sets the game view mode for all open viewports. Only works in editor builds. | |
| TMap< EVCamTargetViewportID, bool > | Only works in editor builds. | ||
| void | ToggleGameView
(
EVCamTargetViewportID ViewportID |
Toggles the game view. |