Navigation
API > API/Plugins > API/Plugins/DMXPixelMappingRuntime > API/Plugins/DMXPixelMappingRuntime/Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDMXPixelMappingBaseComponent
- UDMXPixelMappingOutputComponent
- UDMXPixelMappingRendererComponent
References
| Module | DMXPixelMappingRuntime |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingRendererComponent.h |
| Include | #include "Components/DMXPixelMappingRendererComponent.h" |
Syntax
UCLASS (BlueprintType)
class UDMXPixelMappingRendererComponent : public UDMXPixelMappingOutputComponent
Remarks
Component for rendering input texture.
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bChildrenFollowSize | If true, children are positioned relative to the size of this renderer | |
| float | Brightness | The exposure of the pixel mapping renderer. This property affects the DMX output. | |
| TObjectPtr< UMaterialInterface > | InputMaterial | The material used for pixel mapping | |
| TObjectPtr< UTexture > | InputTexture | The texture used for pixel mapping | |
| TSubclassOf< UUserWidget > | InputWidget | The UMG widget used for pixel mapping | |
| TObjectPtr< UDMXPixelMappingLayoutScript > | LayoutScript | Layout script for the children of this component (hidden in customizations and displayed in its own panel). | |
| EDMXPixelMappingRendererPixelFormat | PixelFormat | The dynamic range of the renderer | |
| EDMXPixelMappingRendererType | RendererType | Selects the input type. It can be a Texture, a Material or a User Widget. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Default Constructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
| PRAGMA_DISABLE_DEPRECATION_WARNINGS void | AddPixelToDownsampleSet
(
FDMXPixelMappingDownsamplePixelParamsV2&& InDownsamplePixelParam |
||
| void | |||
| void | |||
| bool | GetDownsampleBufferPixel
(
const int32 InDownsamplePixelIndex, |
||
| bool | GetDownsampleBufferPixels
(
const int32 InDownsamplePixelIndexStart, |
||
| PRAGMA_ENABLE_DEPRECATION_WARNINGSint32 | |||
| bool | GetPixelMappingComponentModulators
(
FDMXEntityFixturePatchRef FixturePatchRef, |
Returns the Modulators of the component corresponding to the patch specified. | |
| TArray< TSharedRef< UE::DMXPixelMapping::Rendering::FPixelMapRenderElement > > | Returns a copy of the current pixel map render elements | ||
| FIntPoint | GetPixelPosition
(
int32 InIndex |
||
| UDMXPixelMappingPreprocessRenderer * | Returns the pixel mapping preprocess renderer | ||
| UTextureRenderTarget2D * | |||
| UTexture * | Gets the rendered input texture, or nullptr if no input texture is currently rendered | ||
| PRAGMA_DISABLE_DEPRECATION_WARNINGS const TSharedPtr< IDMXPixelMappingRenderer > & | GetRenderer () |
||
| UWorld * | GetWorld () |
||
| void | Invalidates the pixel map, effectively causing a rebuild of the mapping on the next Render call. | ||
| PRAGMA_ENABLE_DEPRECATION_WARNINGS void | |||
| bool | ResetColorDownsampleBufferPixel
(
const int32 InDownsamplePixelIndex |
||
| bool | ResetColorDownsampleBufferPixels
(
const int32 InDownsamplePixelIndexStart, |
||
| void | SetDownsampleBuffer
(
TArray< FLinearColor >&& InDownsampleBuffer, |
||
| void | Updates the preprocess renderer from the current render type and source texture |
Overridden from UDMXPixelMappingBaseComponent
| Type | Name | Description | |
|---|---|---|---|
| bool | CanBeMovedTo
(
const UDMXPixelMappingBaseComponent* Component |
Check if a Component can be moved under another one (used for copy/move/duplicate) | |
| const FName & | Helper function for generating UObject name, the child should implement their own logic for Prefix name generation. | ||
| FString | GetUserName () |
Returns the name of the component. | |
| void | Render () |
Render downsample texture for this component and all children | |
| void | Render downsample texture and send DMX for this component and all children | ||
| void | ResetDMX
(
EDMXPixelMappingResetDMXMode ResetMode |
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
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedChainEvent |
This alternate version of PostEditChange is called when properties inside structs are modified. | |
| void | PostEditUndo () |
Called after applying a transaction to the object. | |
| void | 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. | |
| void | Handles reading, writing, and reference collecting using FArchive. |
Constants
| Name | Description |
|---|---|
| ClearTextureColor_DEPRECATED | |
| MaxDownsampleBufferTargetSize_DEPRECATED |