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 > UDMXPixelMappingRendererComponent

Light Theme

Dark Theme

UDMXPixelMappingRendererComponent

Component for rendering input texture

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDMXPixelMappingBaseComponent

UDMXPixelMappingOutputComponent

UDMXPixelMappingRendererComponent

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable)
class UDMXPixelMappingRendererComponent : public UDMXPixelMappingOutputComponent

Remarks

Component for rendering input texture

Variables

	Name	Description
float	Brightness	Master brightness of the renderer
UMaterialInterf...	InputMaterial	Material to Downsampling
UTexture *	InputTexture	Texture to Downsampling
TSubclassOf< UU...	InputWidget	UMG to Downsampling
EDMXPixelMappin...	RendererType	Type of rendering, Texture, Material, UMG, etc...

Constructors

	Name	Description
	UDMXPixelMappingRendererComponent()	Default Constructor

Destructors

	Name	Description
	~UDMXPixelMappingRendererComponent()	Destructor

Functions

	Name	Description
void	AddPixelToDownsampleSet ( FDMXPixelMappingDownsamplePixelPara... )	Add pixel params for downsampling set
void	CreateOrUpdateDownsampleBufferTarget()	Create or update size of buffer target for rendering downsample pixels
void	EmptyDownsampleBuffer()	Remove all pixels from DownsampleBuffer
bool	GetDownsampleBufferPixel ( const int32 InDownsamplePixelIndex, FLinearColor& OutLinearColor )	Get Pixel color by given downsample pixel index. Returns false if no color value could be acquired
bool	GetDownsampleBufferPixels ( const int32 InDownsamplePixelIndexS..., const int32 InDownsamplePixelIndexE..., TArray< FLinearColor >& OutLinearC... )	Get Pixels color by given downsample pixel range.
int32	GetDownsamplePixelNum()	Get amount of downsample pixels
FIntPoint	GetPixelPosition ( int32 InIndex )	Get pixel position in downsample buffer target based on pixel index
UTextureRend...	GetPreviewRenderTarget()	Get target for preview, create new one if does not exists.
const TShare...	GetRenderer()	Get renderer interfece
UTexture ...	GetRendererInputTexture()	Get reference to the active input texture
UWorld *	GetWorld()	Get active world. It could be editor or build world
void	RenderEditorPreviewTexture()	Render all downsample pixel for editor preview texture
void	RendererInputTexture()	Render input texture for downsampling
bool	ResetColorDownsampleBufferPixel ( const int32 InDownsamplePixelIndex )	Reset the color by given downsample pixel index
bool	ResetColorDownsampleBufferPixels ( const int32 InDownsamplePixelIndexS..., const int32 InDownsamplePixelIndexE... )	Reset the color by given downsample pixel range
void	SetDownsampleBuffer ( TArray< FLinearColor >&& InDownsam..., FIntRect InRect )	Pass the downsample CPU buffer from Render Thread to Game Thread and store
TSharedRef< ...	TakeWidget()	Take of container widget which is holds widget for all child components.

Overridden from UDMXPixelMappingOutputComponent

		Name	Description
	FVector2D	GetSize()	Get rendering size of component

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	Render()	Render downsample texture for this component and all children
void	RenderAndSendDMX()	Render downsample texture and send DMX for this component and all children
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.
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Constants

Name	Description
ClearTextureColor	Initial texture color
MaxDownsampleBufferTargetSize	Max downsample target size

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

Take our survey

Dismiss