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 > DMXPixelMappingRuntime > Components > UDMXPixelMappingScreenComponent

Light Theme

Dark Theme

UDMXPixelMappingScreenComponent

DMX [Screen(Grid)](API\Runtime\UMG\Components\EWidgetSpace) rendering component

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDMXPixelMappingBaseComponent

UDMXPixelMappingOutputComponent

UDMXPixelMappingOutputDMXComponent

UDMXPixelMappingScreenComponent

References

Module	DMXPixelMappingRuntime
Header	/Engine/Plugins/Experimental/DigitalMultiplex/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingScreenComponent.h
Include	#include "Components/DMXPixelMappingScreenComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UDMXPixelMappingScreenComponent : public UDMXPixelMappingOutputDMXComponent

Remarks

DMX Screen(Grid) rendering component

Variables

	Name	Description
float	AlphaIntensity
bool	bIgnoreAlphaChannel
bool	bSendToAllOutputPorts	If true, outputs to all DMX Output Ports
bool	bShowAddresses
bool	bShowUniverse
EDMXPixelMappin...	Distribution
int32	NumXCells
int32	NumYCells
TArray< FDMXOut...	OutputPortReferences	The port this render component outputs to
EDMXCellFormat	PixelFormat
float	PixelIntensity
int32	RemoteUniverse
int32	StartAddress

Constructors

	Name	Description
	UDMXPixelMappingScreenComponent()	Default Constructor

Functions

	Name	Description
void	ForEachPixel ( ForEachPixelCallback InCallback )	Loop through X and Y pixels in screen component
TSet< FDMXOu...	GetOutputPorts()	Returns the output Ports of the renderer component
const TTuple...	GetPixelDownsamplePositionRange()	Get range of the downsample pixel positions
const FVecto...	GetScreenPixelSize()	Calculate screen size of the single pixel in screen component
void	RenderWithInputAndSendDMX()

Overridden from UDMXPixelMappingOutputComponent

	Name	Description
TSharedRef< ...	BuildSlot ( TSharedRef< SConstraintCanvas > InC... )	Rebuild widget for designer view
const FText	GetPaletteCategory()	Returns the text of palette category
FVector2D	GetPosition()	Get rendering position of the component. Using for determining UV map input rendering offset
FVector2D	GetSize()	Get rendering size of component
bool	IsExposedToTemplate()	Whether component should be part of Palette view
void	QueueDownsample()	Queue rendering to downsample rendering target
void	SetPosition ( const FVector2D& InPosition )	Get rendering component position
void	SetSize ( const FVector2D& InSize )	Set rendering size of component
void	ToggleHighlightSelection ( bool bIsSelected )	Change widget visuals whether it selected or not
void	UpdateWidget()	Update the content in designer widget

Overridden from UDMXPixelMappingBaseComponent

	Name	Description
bool	CanBeMovedTo ( const UDMXPixelMappingBaseComponent... )	Check if a Component can be moved under another one (used for copy/move/duplicate)
const FName ...	GetNamePrefix()	Helper function for generating UObject name, the child should implement their own logic for Prefix name generation.
void	ResetDMX()	Reset all sending DMX channels to 0 for this component and all children
void	SendDMX()	Send DMX values of this component and all children

Overridden from UObject

		Name	Description
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.

Overridden from FTickableObjectBase

		Name	Description
	bool	IsTickable()	Virtual that can be overloaded by the inheriting class.
	void	Tick ( float DeltaTime )	Pure virtual that must be overloaded by the inheriting class.

Typedefs

Name	Description
ForEachPixelCallback

Constants

Name	Description
MaxGridUICells
MinGridSize

Deprecated Variables

		Name	Description
	FDMXProtocolNam...	ProtocolName_DEPRECATED

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

Take our survey

Dismiss