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... )	Adds cluster event listener.
void	EmitClusterEventBinary ( const FDisplayClusterClusterEventBi..., bool bMasterOnly )	Emits binary cluster event.
void	EmitClusterEventJson ( const FDisplayClusterClusterEventJs..., bool bMasterOnly )	Emits JSON cluster event.
TArray< UDis...	GetAllCameras()	Cameras.
TArray< UDis...	GetAllNodes()	Returns array of all scene components (nodes).
TArray< UDis...	GetAllScreens()	Returns array of all screen components.
void	GetAxis ( const FString& DeviceID, int32 DeviceChannel, float& Value, bool& IsAvailable )	Axes.
int32	GetAxisDeviceAmount()	Input API /////////////////////////////////////////////////////////////////////////////////////////// Device information.
void	GetAxisDeviceIds ( TArray< FString >& DeviceIDs )	Returns array of names of all VRPN axis devices.
bool	GetBufferRatio ( const FString& ViewportId, float& BufferRatio )	Returns current buffer ratio for specified viewport.
int32	GetButtonDeviceAmount()	Returns amount of VRPN button devices.
void	GetButtonDeviceIds ( TArray< FString >& DeviceIDs )	Returns array of names of all VRPN button devices.
void	GetButtonState ( const FString& DeviceID, int32 DeviceChannel, bool& CurrentState, bool& IsChannelAvailable )	Buttons.
UDisplayClus...	GetCameraById ( const FString& CameraID )	Returns camera component with specified ID.
int32	GetCamerasAmount()	Returns amount of cameras.
UDisplayClus...	GetConfig()	Config API.
UDisplayClus...	GetDefaultCamera()	Returns default camera component.
void	GetKeyboardDeviceIds ( TArray< FString >& DeviceIDs )	Returns array of names of all keyboard devices.
void	GetLocalViewports ( TArray< FString >& ViewportIDs, TArray< FString >& ProjectionTypes, TArray< FIntPoint >& ViewportLocat..., TArray< FIntPoint >& ViewportSizes )	Returns list of local viewports.
UDisplayClus...	GetNodeById ( const FString& SceneNodeID )	Scene components.
FString	GetNodeId()	Returns cluster node name of the current application instance.
int32	GetNodesAmount()	Returns amount of nodes in a cluster.
EDisplayClus...	GetOperationMode()	Returns current operation mode.
ADisplayClus...	GetRootActor()	Game API.
UDisplayClus...	GetRootComponent()	Returns DisplayCluster root component.
UDisplayClus...	GetScreenById ( const FString& ScreenID )	Screens.
int32	GetScreensAmount()	Returns amount of screens defined in current configuration file.
int32	GetTrackerDeviceAmount()	Returns amount of VRPN tracker devices.
void	GetTrackerDeviceIds ( TArray< FString >& DeviceIDs )	Returns array of names of all VRPN tracker devices.
void	GetTrackerLocation ( const FString& DeviceID, int32 DeviceChannel, FVector& Location, bool& IsChannelAvailable )	Trackers.
void	GetTrackerQuat ( const FString& DeviceID, int32 DeviceChannel, FQuat& Rotation, bool& IsChannelAvailable )	Returns tracker quaternion values at specified device and channel.
bool	GetViewportRect ( const FString& ViewportId, FIntPoint& ViewportLoc, FIntPoint& ViewportSize )	Returns location and size of specified viewport.
void	IsButtonPressed ( const FString& DeviceID, int32 DeviceChannel, bool& IsPressedCurrently, bool& IsChannelAvailable )	Returns whether VRPN button is pressed at specified device and channel.
void	IsButtonReleased ( const FString& DeviceID, int32 DeviceChannel, bool& IsReleasedCurrently, bool& IsChannelAvailable )	Returns whether VRPN button is released at specified device and channel.
bool	IsMaster()	Cluster API.
bool	IsModuleInitialized()	DisplayCluster module API.
bool	IsSlave()	Returns true if current node is a slave computer in a cluster.
void	RemoveClusterEventListener ( TScriptInterface< IDisplayClusterCl... )	Removes cluster event listener.
void	SceneViewExtensionIsActiveInContextFunction ( const TArray< FString >& ViewportI..., FSceneViewExtensionIsActiveFunctor ... )	Returns a functor that determines if any given scene view extension should be active in the given context for the current frame
void	SendClusterEventBinaryTo ( const FString& Address, const int32 Port, const FDisplayClusterClusterEventBi..., bool bMasterOnly )	Sends binary cluster event to a specific target (outside of the cluster).
void	SendClusterEventJsonTo ( const FString& Address, const int32 Port, const FDisplayClusterClusterEventJs..., bool bMasterOnly )	Sends JSON cluster event to a specific target (outside of the cluster).
bool	SetBufferRatio ( const FString& ViewportId, float BufferRatio )	Sets buffer ratio for specified viewport.
void	SetDefaultCameraById ( const FString& CameraID )	Sets default camera component specified by ID.
void	SetFinalPostProcessingSettings ( const FString& ViewportId, const FPostProcessSettings& FinalP... )	Overrides postprocess settings for specified viewport.
void	SetOverridePostProcessingSettings ( const FString& ViewportId, const FPostProcessSettings& Overri..., float BlendWeight )	Overrides postprocess settings for specified viewport.
void	SetStartPostProcessingSettings ( const FString& ViewportId, const FPostProcessSettings& StartP... )	Overrides postprocess settings for specified viewport.
void	SetViewportCamera ( const FString& CameraId, const FString& ViewportId )	Render API.
void	WasButtonPressed ( const FString& DeviceID, int32 DeviceChannel, bool& WasPressed, bool& IsChannelAvailable )	Returns whether VRPN button was released at specified device and channel.
void	WasButtonReleased ( const FString& DeviceID, int32 DeviceChannel, bool& WasReleased, bool& IsChannelAvailable )	Returns 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