1. Epic GamesDeveloper
  3. UDMXPixelMappingRendererComponent

UDMXPixelMappingRendererComponent

Component for rendering input texture.

API > API/Plugins > API/Plugins/DMXPixelMappingRuntime

Component for rendering input texture.

   
Name UDMXPixelMappingRendererComponent
Type class
Header File /Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingRendererComponent.h
Include Path #include "Components/DMXPixelMappingRendererComponent.h"

Syntax

UCLASS (BlueprintType)  
class UDMXPixelMappingRendererComponent : public UDMXPixelMappingOutputComponent

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UDMXPixelMappingRendererComponent()

 Default Constructor Components/DMXPixelMappingRendererComponent.h  

Constants

Name Type Remarks Include Path
ClearTextureColor_DEPRECATED const FLinearColor   Components/DMXPixelMappingRendererComponent.h
MaxDownsampleBufferTargetSize_DEPRECATED const FIntPoint   Components/DMXPixelMappingRendererComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bChildrenFollowSize bool If true, children are positioned relative to the size of this renderer Components/DMXPixelMappingRendererComponent.h
  • EditAnywhere
  • Category="Layout"
Brightness float The exposure of the pixel mapping renderer. This property affects the DMX output. Components/DMXPixelMappingRendererComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Render Settings"
  • Meta=(ClampMin="0", UIMin="0", UIMax="1", DisplayName="Exposure")
InputMaterial TObjectPtr< UMaterialInterface > The material used for pixel mapping Components/DMXPixelMappingRendererComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Render Settings"
  • Meta=(DisplayName="User Interface Material")
InputTexture TObjectPtr< UTexture > The texture used for pixel mapping Components/DMXPixelMappingRendererComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Render Settings"
InputWidget TSubclassOf< UUserWidget > The UMG widget used for pixel mapping Components/DMXPixelMappingRendererComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Render Settings"
LayoutScript TObjectPtr< UDMXPixelMappingLayoutScript > Layout script for the children of this component (hidden in customizations and displayed in its own panel). Components/DMXPixelMappingRendererComponent.h
  • EditAnywhere
  • Instanced
  • Category="Layout"
PixelFormat EDMXPixelMappingRendererPixelFormat The dynamic range of the renderer Components/DMXPixelMappingRendererComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Render Settings"
RendererType EDMXPixelMappingRendererType Selects the input type. It can be a Texture, a Material or a User Widget. Components/DMXPixelMappingRendererComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Render Settings"

Protected

Name Type Remarks Include Path Unreal Specifiers
bInvalidatePixelMap bool True once the pixel map was built. Reset to false when the pixel map renderer is invalidated Components/DMXPixelMappingRendererComponent.h  
LayoutRect FVector2D The current rect in which children are laid out. Components/DMXPixelMappingRendererComponent.h  
PixelMapRenderElements TArray< TSharedRef< UE::DMXPixelMapping::Rendering::FPixelMapRenderElement > > Elements rendered during pixel mapping Components/DMXPixelMappingRendererComponent.h  
PixelMapRenderer TObjectPtr< UDMXPixelMappingPixelMapRenderer > Renderer responsible to pixel map Components/DMXPixelMappingRendererComponent.h  
PreprocessRenderer TObjectPtr< UDMXPixelMappingPreprocessRenderer > Renderer responsible to preprocess the input texture / material / user widget Components/DMXPixelMappingRendererComponent.h
  • VisibleAnywhere
  • Instanced
  • Category="Filtering"
UserWidget TObjectPtr< UUserWidget > The user widget instance currently in use Components/DMXPixelMappingRendererComponent.h
  • Transient
  • DuplicateTransient

Functions

Public

Name Remarks Include Path Unreal Specifiers

PRAGMA_DISABLE_DEPRECATION_WARNINGS void AddPixelToDownsampleSet ( FDMXPixelMappingDownsamplePixelParamsV2&& InDownsamplePixelParam
)

   Components/DMXPixelMappingRendererComponent.h  

void CreateOrUpdateDownsampleBufferTarget()

   Components/DMXPixelMappingRendererComponent.h  

void EmptyDownsampleBuffer()

   Components/DMXPixelMappingRendererComponent.h  

bool GetDownsampleBufferPixel ( const int32 InDownsamplePixelIndex,
FLinearColor& OutLinearColor
)

   Components/DMXPixelMappingRendererComponent.h  

bool GetDownsampleBufferPixels ( const int32 InDownsamplePixelIndexStart,
const int32 InDownsamplePixelIndexEnd,
TArray< FLinearColor >& OutLinearColors
)

   Components/DMXPixelMappingRendererComponent.h  

int32 GetDownsamplePixelNum()

   Components/DMXPixelMappingRendererComponent.h  
Returns the Modulators of the component corresponding to the patch specified. Components/DMXPixelMappingRendererComponent.h
  • BlueprintCallable
  • Category="DMX"
Returns a copy of the current pixel map render elements Components/DMXPixelMappingRendererComponent.h  

FIntPoint GetPixelPosition ( int32 InIndex
) const

   Components/DMXPixelMappingRendererComponent.h  

UDMXPixelMappingPreprocessRenderer * GetPreprocessRenderer()

 Returns the pixel mapping preprocess renderer Components/DMXPixelMappingRendererComponent.h  

UTextureRenderTarget2D * GetPreviewRenderTarget()

   Components/DMXPixelMappingRendererComponent.h  

UTexture * GetRenderedInputTexture()

 Gets the rendered input texture, or nullptr if no input texture is currently rendered Components/DMXPixelMappingRendererComponent.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS const TSharedPtr< IDMXPixelMappingRenderer > & GetRenderer()

   Components/DMXPixelMappingRendererComponent.h  

UWorld * GetWorld()

   Components/DMXPixelMappingRendererComponent.h  
Invalidates the pixel map, effectively causing a rebuild of the mapping on the next Render call. Components/DMXPixelMappingRendererComponent.h  

void RenderEditorPreviewTexture()

   Components/DMXPixelMappingRendererComponent.h  

bool ResetColorDownsampleBufferPixel ( const int32 InDownsamplePixelIndex
)

   Components/DMXPixelMappingRendererComponent.h  

bool ResetColorDownsampleBufferPixels ( const int32 InDownsamplePixelIndexStart,
const int32 InDownsamplePixelIndexEnd
)

   Components/DMXPixelMappingRendererComponent.h  

void SetDownsampleBuffer ( TArray< FLinearColor >&& InDownsampleBuffer,
FIntRect InRect
)

   Components/DMXPixelMappingRendererComponent.h  

void UpdatePreprocessRenderer()

 Updates the preprocess renderer from the current render type and source texture Components/DMXPixelMappingRendererComponent.h  

Overridden from UDMXPixelMappingBaseComponent

Name Remarks Include Path Unreal Specifiers

virtual bool CanBeMovedTo ( const UDMXPixelMappingBaseComponent* Component
) const

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

virtual const FName & GetNamePrefix()

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

virtual FString GetUserName ()

 Returns the name of the component. Components/DMXPixelMappingRendererComponent.h  

virtual void Render()

 Renders this component and all children Components/DMXPixelMappingRendererComponent.h  

virtual void RenderAndSendDMX()

 Render downsample texture and send DMX for this component and all children Components/DMXPixelMappingRendererComponent.h  

virtual void ResetDMX ( EDMXPixelMappingResetDMXMode ResetMode
)

 Reset all sending DMX channels to 0 for this component and all children Components/DMXPixelMappingRendererComponent.h  

virtual void SendDMX()

 Send DMX values of this component and all children. Components/DMXPixelMappingRendererComponent.h  

Protected

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedChainEvent
)

   Components/DMXPixelMappingRendererComponent.h  

virtual void PostEditUndo()

   Components/DMXPixelMappingRendererComponent.h  

virtual void PostInitProperties()

   Components/DMXPixelMappingRendererComponent.h  

virtual void PostLoad()

   Components/DMXPixelMappingRendererComponent.h  

virtual void Serialize ( FArchive& Ar
)

   Components/DMXPixelMappingRendererComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page