Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > DisplayCluster > Blueprints > IDisplayClusterBlueprintAPI

Light Theme

Dark Theme

IDisplayClusterBlueprintAPI

Blueprint API interface

Windows

MacOS

Linux

References

Module	DisplayCluster
Header	/Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Blueprints/IDisplayClusterBlueprintAPI.h
Include	#include "Blueprints/IDisplayClusterBlueprintAPI.h"

Syntax

class IDisplayClusterBlueprintAPI

Remarks

Blueprint API interface

Functions

	Name	Description
void	AddClusterEventListener ( TScriptInterface< IDisplayClusterCl... )	Returns amount of nodes in cluster.
void	EmitClusterEvent ( const FDisplayClusterClusterEvent&..., bool MasterOnly )	Returns amount of nodes in cluster.
TArray< UDis...	GetAllCameras()	Cameras.
TArray< UDis...	GetAllNodes()	Returns array of all nodes references by its id name.
TArray< UDis...	GetAllScreens()	Returns array of all screen references.
void	GetAxis ( const FString& DeviceId, uint8 DeviceChannel, float& Value, bool& IsAvailable )	Axes.
int32	GetAxisDeviceAmount()	Input API /////////////////////////////////////////////////////////////////////////////////////////// Device information.
bool	GetAxisDeviceIds ( TArray< FString >& IDs )	Return array of names of all VRPN axis devices.
void	GetBufferRatio ( const FString& InViewportId, float& OutBufferRatio )
int32	GetButtonDeviceAmount()	Return amount of VRPN button devices.
bool	GetButtonDeviceIds ( TArray< FString >& IDs )	Return array of names of all VRPN button devices.
void	GetButtonState ( const FString& DeviceId, uint8 DeviceChannel, bool& CurState, bool& IsChannelAvailable )	Buttons.
UDisplayClus...	GetCameraById ( const FString& id )	Returns camera component with specified ID.
int32	GetCamerasAmount()	Returns amount of cameras.
UDisplayClus...	GetDefaultCamera()	Returns default camera component.
bool	GetEyesSwap ( const FString& CameraId )	Get Swap eye rendering state.
float	GetInterpupillaryDistance ( const FString& CameraId )	Render/Camera API.
void	GetLocalViewports ( bool IsRTT, TArray< FString >& ViewportIDs, TArray< FString >& ViewportTypes, TArray< FIntPoint >& ViewportLocat..., TArray< FIntPoint >& ViewportSizes )	Config API.
UDisplayClus...	GetNodeById ( const FString& id )	Nodes.
FString	GetNodeId()	Returns node name of the current application instance.
int32	GetNodesAmount()	Returns amount of nodes in cluster.
EDisplayClus...	GetOperationMode()	Return current operation mode.
ADisplayClus...	GetRootActor()	Game API.
UDisplayClus...	GetRootComponent()	Returns DisplayCluster root component.
UDisplayClus...	GetScreenById ( const FString& id )	Screens.
int32	GetScreensAmount()	Returns amount of screens defined in configuration file.
int32	GetTrackerDeviceAmount()	Return amount of VRPN tracker devices.
bool	GetTrackerDeviceIds ( TArray< FString >& IDs )	Return array of names of all VRPN tracker devices.
void	GetTrackerLocation ( const FString& DeviceId, uint8 DeviceChannel, FVector& Location, bool& IsChannelAvailable )	Trackers.
void	GetTrackerQuat ( const FString& DeviceId, uint8 DeviceChannel, FQuat& Rotation, bool& IsChannelAvailable )	Return tracker quaternion values at specified device and channel.
bool	GetViewportRect ( const FString& ViewportID, FIntPoint& ViewportLoc, FIntPoint& ViewportSize )
void	IsButtonPressed ( const FString& DeviceId, uint8 DeviceChannel, bool& CurPressed, bool& IsChannelAvailable )	Return whether VRPN button is pressed at specified device and channel.
void	IsButtonReleased ( const FString& DeviceId, uint8 DeviceChannel, bool& CurReleased, bool& IsChannelAvailable )	Return whether VRPN button is released at specified device and channel.
bool	IsCluster()	Whether application is in cluster mode or not.
bool	IsMaster()	Cluster API.
bool	IsModuleInitialized()	DisplayCluster module API.
bool	IsSlave()	Return if current node is not a master computer in cluster.
bool	IsStandalone()	Whether application is in standalone mode or not.
void	RemoveClusterEventListener ( TScriptInterface< IDisplayClusterCl... )	Returns amount of nodes in cluster.
void	SetBufferRatio ( const FString& InViewportId, float InBufferRatio )
void	SetDefaultCameraById ( const FString& id )	Sets default camera component specified by ID.
void	SetEyesSwap ( const FString& CameraId, bool EyeSwapped )	Swap eye rendering.
void	SetFinalPostProcessingSettings ( const FString& ViewportID, const FPostProcessSettings& FinalP... )
void	SetInterpupillaryDistance ( const FString& CameraId, float EyeDistance )	Set eye interpupillary distance (eye separation) for stereoscopic rendering.
void	SetOverridePostProcessingSettings ( const FString& ViewportID, const FPostProcessSettings& Overri..., float BlendWeight )
void	SetStartPostProcessingSettings ( const FString& ViewportID, const FPostProcessSettings& StartP... )
void	SetViewportCamera ( const FString& InCameraId, const FString& InViewportId )	Render API.
bool	ToggleEyesSwap ( const FString& CameraId )	Toggle current eye swap state.
void	WasButtonPressed ( const FString& DeviceId, uint8 DeviceChannel, bool& WasPressed, bool& IsChannelAvailable )	Return whether VRPN button was released at specified device and channel.
void	WasButtonReleased ( const FString& DeviceId, uint8 DeviceChannel, bool& WasReleased, bool& IsChannelAvailable )	Return whether VRPN button was released at specified device and channel.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss