UDMXPixelMappingRendererComponent

Component for rendering input texture

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

DMXPixelMappingRuntime

Header

/Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingRendererComponent.h

Include

#include "Components/DMXPixelMappingRendererComponent.h"

Syntax

UCLASS(BlueprintType, Blueprintable)
class UDMXPixelMappingRendererComponent : public UDMXPixelMappingOutputComponent

Remarks

Component for rendering input texture

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

float

 

Brightness

Master brightness of the renderer

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly

UMaterialInterf...

 

InputMaterial

Material to Downsampling

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

UTexture *

 

InputTexture

Texture to Downsampling

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

TSubclassOf< UU...

 

InputWidget

UMG to Downsampling

Public variable UProperty Category, EditAnywhere BlueprintReadOnly

EDMXPixelMappin...

 

RendererType

Type of rendering, Texture, Material, UMG, etc...

Constructors

Name Description

Public function

UDMXPixelMappingRendererComponent()

Default Constructor

Destructors

Name Description

Public function

~UDMXPixelMappingRendererComponent()

Destructor

Functions

Name Description

Public function

void

 

AddPixelToDownsampleSet

Add pixel params for downsampling set

Public function

void

 

CreateOrUpdateDownsampleBufferTarget()

Create or update size of buffer target for rendering downsample pixels

Public function

void

 

EmptyDownsampleBuffer()

Remove all pixels from DownsampleBuffer

Public function Const

TSharedPtr< ...

 

GetComponentsCanvas()

Returns the component canvas used for this widget

Public function

bool

 

GetDownsampleBufferPixel

(
    const int32 InDownsamplePixelIndex,
    FLinearColor& OutLinearColor
)

Get Pixel color by given downsample pixel index. Returns false if no color value could be acquired

Public function

bool

 

GetDownsampleBufferPixels

(
    const int32 InDownsamplePixelIndexS...,
    const int32 InDownsamplePixelIndexE...,
    TArray< FLinearColor >& OutLinearC...
)

Get Pixels color by given downsample pixel range.

Public function Const

int32

 

GetDownsamplePixelNum()

Get amount of downsample pixels

Public function UFunction BlueprintCallable, Category

bool

 

GetPixelMappingComponentModulators

(
    FDMXEntityFixturePatchRef FixturePa...,
    TArray< UDMXModulator* >& DMX...
)

Returns the Modulators of the component corresponding to the patch specified.

Public function Const

FIntPoint

 

GetPixelPosition

(
    int32 InIndex
)

Get pixel position in downsample buffer target based on pixel index

Public function

UTextureRend...

 

GetPreviewRenderTarget()

Get target for preview, create new one if does not exists.

Public function

const TShare...

 

GetRenderer()

Get renderer interfece

Public function Const

UTexture ...

 

GetRendererInputTexture()

Get reference to the active input texture

Public function Const

UWorld *

 

GetWorld()

Get active world. It could be editor or build world

Public function

void

 

RenderEditorPreviewTexture()

Render all downsample pixel for editor preview texture

Public function UFunction BlueprintCallable, Category

void

 

RendererInputTexture()

Render input texture for downsampling

Public function

bool

 

ResetColorDownsampleBufferPixel

(
    const int32 InDownsamplePixelIndex
)

Reset the color by given downsample pixel index

Public function

bool

 

ResetColorDownsampleBufferPixels

(
    const int32 InDownsamplePixelIndexS...,
    const int32 InDownsamplePixelIndexE...
)

Reset the color by given downsample pixel range

Public function

void

 

SetDownsampleBuffer

(
    TArray< FLinearColor >&& InDownsam...,
    FIntRect InRect
)

Pass the downsample CPU buffer from Render Thread to Game Thread and store

Public function

TSharedRef< ...

 

TakeWidget()

Take of container widget which is holds widget for all child components.

Overridden from UDMXPixelMappingOutputComponent

Name Description

Public function Virtual

void

 

SetSize

(
    const FVector2D& NewSize
)

Sets the size

Overridden from UDMXPixelMappingBaseComponent

Name Description

Public function Virtual Const

bool

 

CanBeMovedTo

(
    const UDMXPixelMappingBaseComponent...
)

Check if a Component can be moved under another one (used for copy/move/duplicate)

Public function Virtual

const FName ...

 

GetNamePrefix()

Helper function for generating UObject name, the child should implement their own logic for Prefix name generation.

Public function Virtual

void

 

Render()

Render downsample texture for this component and all children

Public function Virtual

void

 

RenderAndSendDMX()

Render downsample texture and send DMX for this component and all children

Public function Virtual

void

 

ResetDMX()

Reset all sending DMX channels to 0 for this component and all children

Public function Virtual

void

 

SendDMX()

Send DMX values of this component and all children

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeChainProperty

(
    FPropertyChangedChainEvent& Proper...
)

This alternate version of PostEditChange is called when properties inside structs are modified.

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Constants

Name

Description

ClearTextureColor

Initial texture color

MaxDownsampleBufferTargetSize

Max downsample target size