code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

module: DMXPixelMappingRuntime

code: virtual void PostInitProperties()


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: This is called when a property is about to be modified externally

code: virtual void PreEditChange ( [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * PropertyAboutToChange )


description: Queue rendering to downsample rendering target

code: virtual void QueueDownsample()


description: Deprecated* Deprecated for performance reasons. Instead use 'Get DMX Pixel Mapping Renderer Component' and Render only once each tick.


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

code: virtual void ResetDMX()


description: Send DMX values of this component and all children.

code: virtual void SendDMX()


description: Handles reading, writing, and reference collecting usingFArchive. This implementation handles allFPropertyserialization, but can be overridden for native variables.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: Sets the position

code: virtual void SetPosition ( const FVector2D & NewPosition )


description: Sets the size

code: virtual void SetSize ( const FVector2D & NewSize )


description: Default Constructor

code: UDMXPixelMappingMatrixComponent()


className: UDMXPixelMappingMatrixComponent

description: DMX Matrix group component

CoordinateGrid

type: FIntPoint

Distribution

type: EDMXPixelMappin...

LayoutScript

type: TObjectPtr<UDM...

description: Layout script for the children of this component (hidden in customizations and displayed in its own panel).

PreEditUndoMatrixCellChildren

type: TArray<UDMXPix...

description: Children available PreEditUndo, useful to hide all removed ones in post edit undo


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


description: Rebuild widget for designer view

code: virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXPixelMappingComponentWidget](API\Plugins\DMXPixelMappingEditorWidgets\FDMXPixelMappingComponentWidget) > BuildSlot ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SConstraintCanvas](API\Runtime\Slate\Widgets\Layout\SConstraintCanvas) > InCanvas )


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

code: virtual bool CanBeMovedTo ( const [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) * Component ) const


description: Helper that returns render component if available


description: Returns the component widget


description: Get pixel index in downsample texture

code: virtual int32 GetDownsamplePixelIndex() const


description: Returns an editor color for the widget

code: virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetEditorColor() const


description: Property Name getters.


description: Returns the text of palette category

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: Returns the position

code: FVector2D GetPosition() const


description: Get the size

code: FVector2D GetSize() const


description: Returns the UI ZOrder

code: virtual int32 GetZOrder() const


description: Invalidates the pixel map, effectively causing the renderer component to aquire a new pixel map

code: void InvalidatePixelMapRenderer()


description: Whether component should be part of Palette view

code: virtual bool IsExposedToTemplate()


description: Whether component can be re-sized or re-position at the editor

code: virtual bool IsLockInDesigner() const


description: Returns true if the the component's over all its parents.

code: virtual bool IsOverParent() const


description: Returns true if the component is over specified position

code: virtual bool IsOverPosition ( const FVector2D & Position ) const


description: Whether component should be visible

code: virtual bool IsVisible() const


description: Called when the component was added to a parent

code: virtual void NotifyAddedToParent()


code: virtual void NotifyRemovedFromParent()


description: Returns true if the component overlaps the other

code: virtual bool OverlapsComponent ( [UDMXPixelMappingOutputComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingOutputComponent) * Other ) const


description: Called after applying a transaction to the object. Default implementation simply calls PostEditChange.

code: virtual void PostEditUndo()


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called before applying a transaction to the object. Default implementation simply calls PreEditChange.

code: virtual void PreEditUndo()


description: Queue rendering to downsample rendering target

code: virtual void QueueDownsample()


description: Sets the position

code: virtual void SetPosition ( const FVector2D & NewPosition )


description: Sets the ZOrder in the UI

code: virtual void SetZOrder ( int32 NewZOrder )


description: Sets the size

code: virtual void SetSize ( const FVector2D & NewSize )


description: Udpates the component widget. If bWithChildrenRecursive, updates child Components' Component Widget recursively

code: void UpdateComponentWidget ( [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) NewVisibility, bool bWithChildrenRecursive )


description: Default Constructor

code: UDMXPixelMappingOutputComponent()


description: Updates children to match the size of this instance Makes the component the highest ZOrdered of components in the component rectangle, updates childs if needed

code: void ZOrderTopmost()


className: UDMXPixelMappingOutputComponent

description: Base class for all Designer and configurable components

bLockInDesigner

type: bool

EditorColor

type: FLinearColor

description: The color displayed in editor

LabelAlignment

description: Where the component's label is shown, if it uses one.

PreEditUndoChildren

description: Children available PreEditUndo, useful to hide all removed ones in post edit undo

ZOrder

description: ZOrder in the UI


className: UDMXPixelMappingOutputDMXComponent

description: For legacy reasons also used by deprecated DMXPixelMappingScreenComponent

CellBlendingQuality

type: EDMXPixelBlendi...

description: The quality level to use when averaging colors during downsampling.

ColorSpace

description: The Color Space currently in use

ColorSpaceClass

type: TSubclassOf<UD...

description: Sets which color space Pixel Mapping sends

FixturePatchRef

type: FDMXEntityFixtu...

ModulatorClasses

type: TArray<TSubcla...

description: Modulators applied to the output before sending DMX

Modulators

type: TArray<TObject...

description: The actual modulator instances


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

code: virtual bool CanBeMovedTo ( const [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) * Component ) const


description: Deprecated* Please useUDMXPixelMappingPixelMapRendererto render the pixel map

code: PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid AddPixelToDownsampleSet ( [FDMXPixelMappingDownsamplePixelParamsV2](API\Plugins\DMXPixelMappingRenderer\FDMXPixelMappingDownsamplePixelP-_1) && InDownsamplePixelParam )


code: static const [FLinearColor](API\Runtime\Core\Math\FLinearColor) ClearTextureColor_DEPRECATED = FLinearColor::Black;


code: void EmptyDownsampleBuffer()


description: Deprecated* Pixel Mapping Components no longer hold their own widget, in an effort to separate Views from Data.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SConstraintCanvas](API\Runtime\Slate\Widgets\Layout\SConstraintCanvas) > GetComponentsCanvas() const


code: bool GetDownsampleBufferPixel ( const int32 InDownsamplePixelIndex, [FLinearColor](API\Runtime\Core\Math\FLinearColor) & OutLinearColor )


code: bool GetDownsampleBufferPixels ( const int32 InDownsamplePixelIndexStart, const int32 InDownsamplePixelIndexEnd, [TArray](API\Runtime\Core\Containers\TArray)< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > & OutLinearColors )


code: int32 GetDownsamplePixelNum()


description: Helper function for generatingUObjectname, the child should implement their own logic for Prefix name generation.

code: virtual const [FName](API\Runtime\Core\UObject\FName) & GetNamePrefix()


description: Returns the Modulators of the component corresponding to the patch specified. Note, this node does a lookup on all fixture patches in use, hence may be slow and shouldn't be called on tick.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") bool GetPixelMappingComponentModulators ( [FDMXEntityFixturePatchRef](API\Plugins\DMXRuntime\Library\FDMXEntityFixturePatchRef) FixturePatchRef, [TArray](API\Runtime\Core\Containers\TArray)< [UDMXModulator](API\Plugins\DMXRuntime\Modulators\UDMXModulator) * > & DMXModulators )


description: Returns a copy of the current pixel map render elements


code: FIntPoint GetPixelPosition ( int32 InIndex ) const


description: Returns the pixel mapping preprocess renderer


description: Gets the rendered input texture, or nullptr if no input texture is currently rendered

code: [UTexture](API\Runtime\Engine\Engine\UTexture) * GetRenderedInputTexture() const


code: PRAGMA_DISABLE_DEPRECATION_WARNINGS const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IDMXPixelMappingRenderer](API\Plugins\DMXPixelMappingRenderer\IDMXPixelMappingRenderer) > & GetRenderer()


description: Returns the name of the component. If user name is set returns the custom user name (see SetUserName)

code: virtual [FString](API\Runtime\Core\Containers\FString) GetUserName() const


description: Invalidates the pixel map, effectively causing a rebuild of the mapping on the next Render call. Does not rebuild the renderer self. Use InitializeRenderer to rebuild the renderers.

code: void InvalidatePixelMapRenderer()


code: static const FIntPoint MaxDownsampleBufferTargetSize_DEPRECATED = FIntPoint(4096);


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description: Called after applying a transaction to the object. Default implementation simply calls PostEditChange.

code: virtual void PostEditUndo()


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Deprecated* Since a pixel mapping asset doesn't have a clear world context,GetWorld()is no longer supported.

code: [UWorld](API\Runtime\Engine\Engine\UWorld) * GetWorld() const


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Render downsample texture for this component and all children

code: virtual void Render()


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

code: virtual void RenderAndSendDMX()


code: void RenderEditorPreviewTexture()


code: bool ResetColorDownsampleBufferPixel ( const int32 InDownsamplePixelIndex )


code: bool ResetColorDownsampleBufferPixels ( const int32 InDownsamplePixelIndexStart, const int32 InDownsamplePixelIndexEnd )


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

code: virtual void ResetDMX()


description: Send DMX values of this component and all children.

code: virtual void SendDMX()


description: Deprecated* Please useUDMXPixelMappingPixelMapRendererto render the pixel map

code: void SetDownsampleBuffer ( [TArray](API\Runtime\Core\Containers\TArray)< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > && InDownsampleBuffer, FIntRect InRect )


description: Deprecated* Pixel Mapping Components no longer hold their own widget, in an effort to separate Views from Data.

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > TakeWidget()


description: Updates the preprocess renderer from the current render type and source texture

code: void UpdatePreprocessRenderer()


description: Default Constructor

code: UDMXPixelMappingRendererComponent()


className: UDMXPixelMappingRendererComponent

description: Component for rendering input texture.

Brightness

type: float

description: The brightness of the renderer

InputMaterial

type: TObjectPtr<UMa...

description: The material used for pixel mapping

InputTexture

type: TObjectPtr<UTe...

description: The texture used for pixel mapping

InputWidget

type: TSubclassOf<UU...

description: The UMG widget used for pixel mapping

LayoutScript

description: Layout script for the children of this component (hidden in customizations and displayed in its own panel).

RendererType

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


description: Add a new child componet

code: virtual void AddChild ( [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) * InComponent )


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


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

code: virtual bool CanBeMovedTo ( const [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) * Component ) const


description: Finds a renderer component by its name. Faster than UDMXPixelMappingBaseComponent::FindComponentByName

code: [UDMXPixelMappingRendererComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingRendererComponen-) * FindRendererComponentByName ( const [FName](API\Runtime\Core\UObject\FName) & Name ) const


description: Helper function for generatingUObjectname, the child should implement their own logic for Prefix name generation.

code: virtual const [FName](API\Runtime\Core\UObject\FName) & GetNamePrefix()


description: Returns the name of the component. If user name is set returns the custom user name (see SetUserName)

code: virtual [FString](API\Runtime\Core\Containers\FString) GetUserName() const


code: virtual void PostLoad()


description: Remove the child component by the given component object.

code: virtual void RemoveChild ( [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) * InComponent )


code: virtual void Render()


code: virtual void RenderAndSendDMX()


description: Rebuild widget for designer view

code: virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXPixelMappingComponentWidget](API\Plugins\DMXPixelMappingEditorWidgets\FDMXPixelMappingComponentWidget) > BuildSlot ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SConstraintCanvas](API\Runtime\Slate\Widgets\Layout\SConstraintCanvas) > InCanvas )


className: UDMXPixelMappingRootComponent

description: Root component in the components tree


description: Loop through X and Y pixels in screen component

code: void ForEachPixel ( [ForEachPixelCallback](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingScreenComponent\ForEachPixelCall-) InCallback )


className: ForEachPixelCallback

code: typedef [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(const int32, const int32, const int32)> ForEachPixelCallback


description: Returns the output Ports of the renderer component

code: [TSet](API\Runtime\Core\Containers\TSet)< [FDMXOutputPortSharedRef](API\Plugins\DMXProtocol\FDMXOutputPortSharedRef) > GetOutputPorts() const


description: Returns the text of palette category

code: virtual const [FText](API\Runtime\Core\Internationalization\FText) GetPaletteCategory()


description: Get range of the downsample pixel positions

code: const [TTuple](API\Runtime\Core\Misc\TTuple)< int32, int32 > GetPixelDownsamplePositionRange() const


description: Calculate screen size of the single pixel in screen component

code: const FVector2D GetScreenPixelSize() const


description: Whether component should be part of Palette view

code: virtual bool IsExposedToTemplate()


className: MinGridSize

code: static const FVector2D MinGridSize = FVector2D(1.f);


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description: Queue rendering to downsample rendering target

code: virtual void QueueDownsample()


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

code: virtual void ResetDMX()


description: Send DMX values of this component and all children.

code: virtual void SendDMX()


description: Sets the position

code: virtual void SetPosition ( const FVector2D & NewPosition )


description: Sets the size

code: virtual void SetSize ( const FVector2D & NewSize )


className: UDMXPixelMappingScreenComponent

description: DMX Screen(Grid) rendering component

bSendToAllOutputPorts

description: If true, outputs to all DMX Output Ports

OutputPortReferences

type: TArray<FDMXOut...

description: The port this render component outputs to

PixelFormat

type: EDMXCellFormat


description: Default Constructor

code: UDMXPixelMappingScreenComponent()


description: Adds a normalized attribute value to a DMX channel value map

code: static void ConvertNormalizedAttributeValueToChannelValue ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * InFixturePatch, const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & InAttributeName, float InNormalizedValue, [TMap](API\Runtime\Core\Containers\TMap)< int32, uint8 > & InOutChannelToValueMap )


className: FDMXPixelMappingRuntimeUtils

description: No constructors are accessible with public or protected access.

code: class FDMXPixelMappingRuntimeUtils


description: Handles property changes for modulator classes in one place for Matrix and GroupItems, useless for other classes.

code: static void HandleModulatorPropertyChange ( [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) * Component, [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedChainEvent, const [TArray](API\Runtime\Core\Containers\TArray)< [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UDMXModulator](API\Plugins\DMXRuntime\Modulators\UDMXModulator) >> & ModulatorClasses, [TArray](API\Runtime\Core\Containers\TArray)< [UDMXModulator](API\Plugins\DMXRuntime\Modulators\UDMXModulator) * > & InOutModulators )


code: typedef TBaseDelegate_OneParam< void, [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) * > FOnEditorRebuildChildrenComponentsDelegate


code: FDMXPixelMappingLayoutToken()


code: FDMXPixelMappingLayoutToken ( [TWeakObjectPtr](API\Runtime\Core\UObject\TWeakObjectPtr)< [UDMXPixelMappingOutputComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingOutputComponent) > OutputComponent )


className: FDMXPixelMappingLayoutToken

description: The position and size of a comoponent in a layout

Component

type: TWeakObjectPtr<...

description: The output component to which the token is applied

FixtureID

description: The Fixture ID of the Component's Fixture Patch, or 0 if the component has no Fixture Patch, or the Fixture ID is not set.

PositionX

description: The position of the component on the X-Axis

PositionY

description: The position of the component on the Y-Axis

SizeX

description: The size of the component on the X-Axis

SizeY

description: The size of the component on the Y-Axis


description: Lays out children of the selection according to OutTokens. Tokens that are not returned remain unchanged. Called when the script is loaded (unless set otherwise in editor) and when Properties were changed.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintNativeEvent, Category="DMX") void Layout ( const [TArray](API\Runtime\Core\Containers\TArray)< [FDMXPixelMappingLayoutToken](API\Plugins\DMXPixelMappingRuntime\LayoutScripts\FDMXPixelMappingLayoutToken) > & InTokens, [TArray](API\Runtime\Core\Containers\TArray)< [FDMXPixelMappingLayoutToken](API\Plugins\DMXPixelMappingRuntime\LayoutScripts\FDMXPixelMappingLayoutToken) > & OutTokens )


code: virtual void Layout_Implementation ( const [TArray](API\Runtime\Core\Containers\TArray)< [FDMXPixelMappingLayoutToken](API\Plugins\DMXPixelMappingRuntime\LayoutScripts\FDMXPixelMappingLayoutToken) > & InTokens, [TArray](API\Runtime\Core\Containers\TArray)< [FDMXPixelMappingLayoutToken](API\Plugins\DMXPixelMappingRuntime\LayoutScripts\FDMXPixelMappingLayoutToken) > & OutTokens )


description: Sets the number of Tokens that will be passed when Layout is called

code: virtual void SetNumTokens ( int32 NewNumTokens )


description: Sets the position of the parent component where the components that are being layouted reside in.

code: virtual void SetParentComponentPosition ( const FVector2D NewPosition )


description: Sets the size of the parent component where the components that are being layouted reside in.

code: virtual void SetParentComponentSize ( const FVector2D & NewSize )


description: Sets the Texture Size

code: virtual void SetTextureSize ( const FVector2D & NewTextureSize )


className: UDMXPixelMappingLayoutScript

description: Allows scripting of Pixel Mapping Component Layouts. Override the Layout function to implement a layout.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable, EditInlineNew, Abstract) class UDMXPixelMappingLayoutScript : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

NumTokens

description: The number of tokens in the Layout.

ParentComponentPosition

description: The position of the parent component where the components that are being layouted reside in.

ParentComponentSize

description: The size of the parent component where the components that are being layouted reside in.

TextureSize

description: The size of the texture in the Pixel Mapping asset.


description: Creates an instance of the Component according to the class specified during construction. Returns nullptr if the ComponentType is not a ComponentType.

code: template<typename ComponentType> ComponentType * CreateComponent ( [UDMXPixelMappingRootComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingRootComponent) * InRootComponent )


description: Gets the category for the Component


description: Constructor for a template that can be specified by class

code: FDMXPixelMappingComponentTemplate ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) > InComponentClass )


description: Constructor for a group items template that can hold fixture patches

code: FDMXPixelMappingComponentTemplate ( [TSubclassOf](API\Runtime\CoreUObject\Templates\TSubclassOf)< [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) > InComponentClass, const [FDMXEntityFixturePatchRef](API\Plugins\DMXRuntime\Library\FDMXEntityFixturePatchRef) & InFixturePatchRef )


description: Virtual Destructor


className: FDMXPixelMappingComponentTemplate

description: The Component template represents a Component or a set of Components to create.

code: class FDMXPixelMappingComponentTemplate : public [TSharedFromThis< FDMXPixelMappingComponentTemplate >](API\Runtime\Core\Templates\TSharedFromThis)

Name

type: FText

description: The name of the Component template.


description: Checks if nested objects are created, otherwise create them.

code: void CreateOrLoadObjects()


description: Destroys invalid components. Useful when fixture type or fixture patch changed

code: void DestroyInvalidComponents()


description: Returns the first component that corresponds to the patch or null if none present

code: [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) * FindComponent ( [UDMXEntityFixturePatch](API\Plugins\DMXRuntime\Library\UDMXEntityFixturePatch) * FixturePatch ) const


description: Find the component by name.

code: [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) * FindComponent ( const [FName](API\Runtime\Core\UObject\FName) & Name ) const


description: Find the component by widget.

code: [UDMXPixelMappingOutputComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingOutputComponent) * FindComponent ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InWidget ) const


description:
Looking for the first component of class by given name
An instance of the templated Component

code: template<typename TComponentClass> TComponentClass * FindComponentOfClass ( const [FName](API\Runtime\Core\UObject\FName) & InName ) const


description: Recursively Iterates through all compnents

code: void ForEachComponent ( [TComponentPredicate](API\Runtime\Core\GenericPlatform\TFunctionRef) Predicate ) const


description: Iterates through components by class with given Predicate callback

code: template<typename TComponentClass> void ForEachComponentOfClass ( [TComponentPredicateType](API\Runtime\Core\GenericPlatform\TFunctionRef)< TComponentClass > Predicate ) const


description: Get array ofFNamepointers by given class

code: template<typename TComponentClass> void GetAllComponentsNamesOfClass ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FName](API\Runtime\Core\UObject\FName) >> & InComponentNames ) const


description: Get all component by given class

code: template<typename TComponentClass> void GetAllComponentsOfClass ( [TArray](API\Runtime\Core\Containers\TArray)< TComponentClass * > & OutComponents ) const


description: Get root component of the component tree


description: Do any object-specific cleanup required immediately after loading an object. This is not called for newly-created objects, and by default will always execute on the game thread.

code: virtual void PostLoad()


description: Recurcevly preload all components in tree.

code: void PreloadWithChildren()


description: Removes the Component from the hierarchy and all sub Components.

code: void RemoveComponent ( [UDMXPixelMappingBaseComponent](API\Plugins\DMXPixelMappingRuntime\Components\UDMXPixelMappingBaseComponent) * InComponent )


className: TComponentPredicate


className: TComponentPredicateType

code: typedef [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(Type *)> TComponentPredicateType


className: UDMXPixelMapping

description: Public container of Pixel Mapping object and it using for asset

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType, Blueprintable) class UDMXPixelMapping : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

RootComponent

type: TObjectPtr<UDM...

description: Holds the reference to root component

ThumbnailImage

description: Holds the Thumbnail for asset


module: DMXProtocol

code: enum { DMX_MAX_CHANNEL_VALUE = 255 }


code: enum { DMX_UNIVERSE_SIZE = 512 }


className: EDMXCommunicationType

description: Type of network communication

code: enum EDMXCommunicationType { Broadcast, Unicast, Multicast, InternalOnly, }


className: EDMXSendResult

description: Result when sending a DMX packet

code: enum EDMXSendResult { Success, ErrorGetUniverse, ErrorSetBuffer, ErrorSizeBuffer, ErrorEnqueuePackage, ErrorNoSenderInterface, }


description: Cleanup the list of keywords using commas and removing spaces/tabs

code: void CleanupKeywords()


code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetKeywords() const


className: EDMXFixtureSignalFormat

code: enum EDMXFixtureSignalFormat { E8Bit = 0, E16Bit = 1, E24Bit = 2, E32Bit = 3, }


code: bool operator!= ( const [FDMXAttribute](API\Plugins\DMXProtocol\FDMXAttribute) & Other ) const


description: Comparison operator

code: bool operator== ( const [FDMXAttribute](API\Plugins\DMXProtocol\FDMXAttribute) & Other ) const


className: FDMXAttribute

Keywords

type: FString

description: Keywords used when auto-mapping Fixture Functions from a GDTF file to match Fixture Functions to existing Attributes.

Name

type: FName

description: Name of this Attribute, displayed on Attribute selectors


description: Deprecated* Deprecated since attributes now can take any name. If it is desired to resolve against default attributes from project settings, do a lookup onUDMXProtocolSettings::Attributes


className: bCanBeNone

description: Deprecated 5.1 without replacement. Always true

code: static const bool bCanBeNone = true;


description: Deprecated members originating from deprecatedFDMXNameListItem

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetPossibleValues()


description: Returns the predefined values

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetPredefinedValues()


description: IsValid member accessor

code: bool IsValid() const


className: OnValuesChanged

description: Deprecated 5.1 without replacement. To listen to changes of default defined protocols, please refer toUDMXProtocolSettings::GetOnDefaultAttributesChanged


code: void SetFromName ( const [FName](API\Runtime\Core\UObject\FName) & InName )


description: Default constructor. Assigns Attribute to the first available Attribute from the plugin settings

code: FDMXAttributeName()


description: Construct from an Attribute

code: FDMXAttributeName ( const [FDMXAttribute](API\Plugins\DMXProtocol\FDMXAttribute) & InAttribute )


description: Construct from an Attribute name

code: FDMXAttributeName ( const [FName](API\Runtime\Core\UObject\FName) & NameAttribute )


className: FDMXAttributeName

description: The Attribute Name


description: Clamps the Value to be in value range of the Signal Format

code: static uint32 ClampValueBySignalFormat ( uint32 Value, [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) SignalFormat )


code: template<typename T> static uint32 ClampValueBySignalFormat ( T Value, [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) SignalFormat )


description:
Returns the Max Value the Data Type can take
The Max Value of the Data Type, e.g. 255 forEDMXFixtureSignalFormat::E8Bit.

code: static uint32 GetSignalFormatMaxValue ( [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) SignalFormat )


description: Returns the number of Bytes the Signal Format uses

code: static uint8 GetSizeOfSignalFormat ( [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) SignalFormat )


description: TODO: All DMX conversions eventually should be moved here (e.g. from subsystem, fixture type) as statics, unit tested and optimized. BP implementations in other classes should be forwarded here, native C++ implementations should be flagged deprecated to reduce code scattering. Converts a uint32 to a byte array

code: template<typename T, typename U> static [TArray](API\Runtime\Core\Containers\TArray)< uint8 > UnsignedInt32ToByteArray ( T Value, [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) SignalFormat, bool bLSBOrder )


description: Converts a normalized value to a byte array. Normalized value has to be in the 0-1 range. Assumes max signal format is 24bit.

code: template<typename T, typename U> static [TArray](API\Runtime\Core\Containers\TArray)< uint8 > NormalizedDMXValueToByteArray ( T NormalizedValue, [EDMXFixtureSignalFormat](API\Plugins\DMXProtocol\EDMXFixtureSignalFormat) SignalFormat, bool bLSBOrder )


className: FDMXConversions

description: No constructors are accessible with public or protected access.

code: class FDMXConversions


description: Deprecated without replacement. Always false

code: static const bool bCanBeNone = false;


description: Deprecated without replacement. Protocols cannot be enabled or disabled after engine startup.


className: FDMXFixtureCategory::operator bool

description: Bool (is valid) operator

code: operator bool() const


className: FDMXFixtureCategory::operator const FName &

code: operator const FName &() const


className: FDMXFixtureCategory::operator FName &

code: operator FName &()


code: bool operator== ( const [FDMXFixtureCategory](API\Plugins\DMXProtocol\FDMXFixtureCategory) & Other ) const


code: bool operator== ( const [FName](API\Runtime\Core\UObject\FName) & Other ) const


code: FDMXFixtureCategory ( const [FName](API\Runtime\Core\UObject\FName) & InName )


className: FDMXFixtureCategory

description: Category of a fixture

description: The Protocol Name


className: FDMXInputPortSharedPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDMXInputPort](API\Plugins\DMXProtocol\IO\FDMXInputPort), ESPMode::ThreadSafe > FDMXInputPortSharedPtr


className: FDMXInputPortSharedRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXInputPort](API\Plugins\DMXProtocol\IO\FDMXInputPort), ESPMode::ThreadSafe > FDMXInputPortSharedRef


description: The name representation of this object

code: virtual [FName](API\Runtime\Core\UObject\FName) GetName() const


description: Whether the current value is None

code: virtual bool IsNone() const


description: The value of no item selected.

code: static const [FName](API\Runtime\Core\UObject\FName) None = TEXT("<Invalid NameListItem>");


description: Set this object from aFName

code: virtual void SetFromName ( const [FName](API\Runtime\Core\UObject\FName) & InName )


description: Set this object to represent a None value

code: virtual void SetToNone()


className: FDMXNameListItem

description: Types that represent names in aSNameListPickerdropdown must:

description: Label of the item this struct represents


className: FDMXOutputPortSharedRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXOutputPort](API\Plugins\DMXProtocol\IO\FDMXOutputPort), ESPMode::ThreadSafe > FDMXOutputPortSharedRef


className: FDMXOutputPortSharedPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDMXOutputPort](API\Plugins\DMXProtocol\IO\FDMXOutputPort), ESPMode::ThreadSafe > FDMXOutputPortSharedPtr


className: FDMXPortSharedPtr

description: Ports.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FDMXPort](API\Plugins\DMXProtocol\IO\FDMXPort), ESPMode::ThreadSafe > FDMXPortSharedPtr


className: FDMXPortSharedRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< class [FDMXPort](API\Plugins\DMXProtocol\IO\FDMXPort), ESPMode::ThreadSafe > FDMXPortSharedRef


className: DefaultProtocolArtNetName

code: static const [FName](API\Runtime\Core\UObject\FName) DefaultProtocolArtNetName = "Art-Net";


className: DefaultProtocolSACNName

code: static const [FName](API\Runtime\Core\UObject\FName) DefaultProtocolSACNName = "sACN";


className: FDMXOnRequestProtocolBlocklistEvent

description: Event broadcast so other Plugins can block specific protocols from registering.

code: class FDMXOnRequestProtocolBlocklistEvent : public TBaseMulticastDelegate_OneParam< void, TArray< FName > & >


className: FDMXOnRequestProtocolRegistrationEvent

description: See DMXProtocolArtNet for an example of a Protocol implementation.

code: class FDMXOnRequestProtocolRegistrationEvent : public TBaseMulticastDelegate_OneParam< void, TArray< FDMXProtocolRegistrationParams > & >


description: Get the instance of this module.

code: static [FDMXProtocolModule](API\Plugins\DMXProtocol\FDMXProtocolModule) & Get()


description:
If protocol exists return the pointer otherwise it create a new protocol first and then return the pointer.
Return the pointer to protocol.

code: virtual [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) GetProtocol ( const [FName](API\Runtime\Core\UObject\FName) InProtocolName )


description: Get the reference to all protocol factories map

code: const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [IDMXProtocolFactory](API\Plugins\DMXProtocol\Interfaces\IDMXProtocolFactory) * > & GetProtocolFactories() const


description: Get the reference to all protocols map

code: const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) > & GetProtocols() const


className: OnRequestProtocolBlocklistEvent


className: OnRequestProtocolRegistrationEvent


description: Deprecated* Please use the OnRequestProtocolRegistration event instead.

code: void RegisterProtocol ( const [FName](API\Runtime\Core\UObject\FName) & ProtocolName, [IDMXProtocolFactory](API\Plugins\DMXProtocol\Interfaces\IDMXProtocolFactory) * Factory )


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


code: void UnregisterProtocol ( const [FName](API\Runtime\Core\UObject\FName) & ProtocolName )


className: FDMXProtocolModule

description: For use in Engine, see comments in DMXPortManager.h For protocol development, see comments in IDMXProtocol.h

code: class FDMXProtocolModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: bCanBeNone

description: Deprecated without replacement. Always false.

code: static const bool bCanBeNone = false;


description: Deprecated members originating from deprecatedFDMXNameListItem

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetPossibleValues()


description: Returns the Protocol this name represents


description: IsValid member accessor

code: bool IsValid() const


className: OnValuesChanged


className: FDMXProtocolName::operator bool

description: Bool (is valid) operator

code: operator bool() const


className: FDMXProtocolName::operator const FName &

code: operator const FName &() const


className: FDMXProtocolName::operator FName &

code: operator FName &()


code: bool operator== ( const [FDMXProtocolName](API\Plugins\DMXProtocol\FDMXProtocolName) & Other ) const


code: bool operator== ( const [FName](API\Runtime\Core\UObject\FName) & Other ) const


code: operator const IDMXProtocolPtr() const


code: bool operator== ( const [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) & Other ) const


code: bool operator!= ( const [FDMXProtocolName](API\Plugins\DMXProtocol\FDMXProtocolName) & Other ) const


code: bool operator!= ( const [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) & Other ) const


code: bool operator!= ( const [FName](API\Runtime\Core\UObject\FName) & Other ) const


description: Construct from a protocol name

code: FDMXProtocolName ( const [FName](API\Runtime\Core\UObject\FName) & InName )


description: Construct from a protocol

code: FDMXProtocolName ( [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) InProtocol )


className: FDMXProtocolName

description: A DMX protocol as a name that can be displayed in UI. The protocol is directly accessible via GetProtocol

description: The Protocol Name


className: GUID

description: The GUID for this custom version number.

code: static const [FGuid](API\Runtime\Core\Misc\FGuid) GUID;


className: Type

code: enum Type { BeforeCustomVersionWasAdded = 0, OutputPortSupportsManyUnicastAddresses, VersionPlusOne, LatestVersion = VersionPlusOne - 1, }


className: FDMXProtocolObjectVersion

description: No constructors are accessible with public or protected access.

code: struct FDMXProtocolObjectVersion


className: FDMXProtocolRegistrationParams

code: struct FDMXProtocolRegistrationParams

ProtocolFactory

type: IDMXProtocolFac...

description: The factory used to create the protocol

ProtocolName

description: The name to use for the protocol (also used in UIs)


description:
Creates an Internet Address
The Internet Address or nullptr if IPAddress and Port don't yield a valid Internet Address

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > CreateInternetAddr ( const [FString](API\Runtime\Core\Containers\FString) & IPAddress, int32 Port )


description: Tries to find a local network interface card IP that matches an IP Address with wildcards

code: static bool FindLocalNetworkInterfaceCardIPAddress ( const [FString](API\Runtime\Core\Containers\FString) & InIPAddressWithWildcards, [FString](API\Runtime\Core\Containers\FString) & OutLocalNetworkInterfaceCardIPAddress )


description: Generates a unique name given a base one and a list of existing ones, by appending an index to existing names. If InBaseName is an empty String, it returns "Default name".

code: static [FString](API\Runtime\Core\Containers\FString) GenerateUniqueNameFromExisting ( const [TSet](API\Runtime\Core\Containers\TSet)< [FString](API\Runtime\Core\Containers\FString) > & InExistingNames, const [FString](API\Runtime\Core\Containers\FString) & InBaseName )


description: Returns an array of local network interfaces

code: static [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FString](API\Runtime\Core\Containers\FString) > > GetLocalNetworkInterfaceCardIPs()


description:
Utility to separate a name from an index at the end.
True if there was an index on InString.

code: static bool GetNameAndIndexFromString ( const [FString](API\Runtime\Core\Containers\FString) & InString, [FString](API\Runtime\Core\Containers\FString) & OutName, int32 & OutIndex )


description: Can't instantiate this class

code: FDMXProtocolUtils()


className: FDMXProtocolUtils

code: class FDMXProtocolUtils


code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: FDMXSignal ( const double InTimestamp, const int32 InUniverseID, const int32 InPriority, const [TArray](API\Runtime\Core\Containers\TArray)< uint8 > & InChannelData )


code: FDMXSignal ( const double InTimestamp, const int32 InUniverseID, const int32 InPriority, [TArray](API\Runtime\Core\Containers\TArray)< uint8 > && InChannelData )


className: FDMXSignal

description: A single, generic DMX signal. One universe of raw DMX data received

code: class FDMXSignal : public [TSharedFromThis< FDMXSignal, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)

ChannelData

type: TArray< uint8 >

Timestamp

type: double


className: FDMXSignalSharedPtr

description: Signal.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FDMXSignal](API\Plugins\DMXProtocol\FDMXSignal), ESPMode::ThreadSafe > FDMXSignalSharedPtr


className: FDMXSignalSharedRef

code: typedef [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXSignal](API\Plugins\DMXProtocol\FDMXSignal), ESPMode::ThreadSafe > FDMXSignalSharedRef


className: GetTypeHash

description: Unique hash from a DMX Attribute

code: uint32 GetTypeHash ( const [FDMXAttribute](API\Plugins\DMXProtocol\FDMXAttribute) & Attribute )


className: FLogCategoryLogDMXProtocol

code: struct FLogCategoryLogDMXProtocol : public [FLogCategory< ELogVerbosity::Log, ELogVerbosity::All >](API\Runtime\Core\Logging\FLogCategory)


code: uint32 GetTypeHash ( const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & DMXNameListItem )


className: IDMXProtocolPtr

description: Protocol.

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IDMXProtocol](API\Plugins\DMXProtocol\Interfaces\IDMXProtocol), ESPMode::ThreadSafe > IDMXProtocolPtr


className: IDMXProtocolPtrWeak

code: typedef [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IDMXProtocol](API\Plugins\DMXProtocol\Interfaces\IDMXProtocol), ESPMode::ThreadSafe > IDMXProtocolPtrWeak


description:
If protocol exists return the pointer otherwise it create a new protocol first and then return the pointer.
Return the pointer to protocol

code: static [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) Get ( const [FName](API\Runtime\Core\UObject\FName) & ProtocolName )


description:
Returns the communication types the protocol supports for its input ports. Can be empty if the protocol doesn't want to expose a selection to the user. If an empty array is returned, input ports that use the protocol will set CommunicationType toEDMXCommunicationType::InternalOnly.
Array of communication types the user can select from, when defining input ports in editor.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [EDMXCommunicationType](API\Plugins\DMXProtocol\EDMXCommunicationType) > GetInputPortCommunicationTypes() const


description:
Get maximum supported universe ID for protocol
Maximum supported universe ID for protocol

code: int32 GetMaxUniverseID() const


description:
Get minimum supported universe ID for protocol
Minimum supported universe ID for protocol

code: int32 GetMinUniverseID() const


description:
Returns the communication types the protocol supports for its input ports. Can be empty if the protocol doesn't want to expose a selection to the user. If an empty array is returned, output ports that use the protocol will set CommunicationType toEDMXCommunicationType::InternalOnly.
Array of communication types the user can select from, when defining output ports in editor.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [EDMXCommunicationType](API\Plugins\DMXProtocol\EDMXCommunicationType) > GetOutputPortCommunicationTypes() const


description: ~EndIDMXProtocolInterface definition

code: static const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [IDMXProtocolFactory](API\Plugins\DMXProtocol\Interfaces\IDMXProtocolFactory) * > & GetProtocolFactories()


description:
Get the Protocol Name
ReturnFNameof the protocol

code: const [FName](API\Runtime\Core\UObject\FName) & GetProtocolName() const


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & GetProtocolNames()


code: static const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) > & GetProtocols()


description: As an example, this should be true, when the output port broadcasts to network. Broadcast traffic is heard by any input port that receives this protocol on corresponding universes. We forward this info to users, so they can take appropriate messures when specifying their ports.

code: bool IsCausingLoopback ( [EDMXCommunicationType](API\Plugins\DMXProtocol\EDMXCommunicationType) InCommunicationType )


description:
Whether protocol enabled
Return true if the protocol is enabled

code: bool IsEnabled() const


description: Returns a valid Universe ID as close as possible to the provided Universe ID

code: int32 MakeValidUniverseID ( int32 DesiredUniverseID ) const


description: Returns true if the Universe ID is valid for the protocol

code: bool IsValidUniverseID ( int32 UniverseID ) const


description:
Called to register a DMXInputPort with the protocol. This should be implemented so each port can only register once (see Art-Net for an example).
True if the port was successfully registered

code: bool RegisterInputPort ( const [FDMXInputPortSharedRef](API\Plugins\DMXProtocol\FDMXInputPortSharedRef) & InputPort )


description:
Called to register a DMXOutputPort with the protocol. If initially valid, returned sender needs to guarantee to be valid while the port is registered. This should be implemented so each port can only register once (see Art-Net for an example).
The DMX senders that can be used while the output port is registered.

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IDMXSender](API\Plugins\DMXProtocol\Interfaces\IDMXSender) > > RegisterOutputPort ( const [FDMXOutputPortSharedRef](API\Plugins\DMXProtocol\FDMXOutputPortSharedRef) & OutputPort )


description:
Returns true if the Protocol supports a priority setting to filter inbound and outbound signals
Whether the protocol supports Priority settings.

code: bool SupportsPrioritySettings() const


description: Called to unregister a DMXInputPort with the protocol.

code: void UnregisterInputPort ( const [FDMXInputPortSharedRef](API\Plugins\DMXProtocol\FDMXInputPortSharedRef) & InputPort )


className: IDMXProtocol

description: See DMXProtocolArtNet for an example of a Protocol implementation.

code: class IDMXProtocol : public [IDMXProtocolBase](API\Plugins\DMXProtocol\Interfaces\IDMXProtocolBase)


description: Called to unregister a DMXOutputPort with the protocol.

code: void UnregisterOutputPort ( const [FDMXOutputPortSharedRef](API\Plugins\DMXProtocol\FDMXOutputPortSharedRef) & OutputPort )


code: bool Tick ( float DeltaTime )


className: IDMXProtocolBase

code: class IDMXProtocolBase : public [TSharedFromThis< IDMXProtocolBase, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


description:
It creates only one instance of Protocol. There is the condition to check in DMXProtocolModule
Return the pointer to protocol

code: [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) CreateProtocol ( const [FName](API\Runtime\Core\UObject\FName) & ProtocolName )


className: IDMXProtocolFactory

code: class IDMXProtocolFactory


code: virtual ~IDMXProtocolFactory()


code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FBufferArchive](API\Runtime\Core\Serialization\FBufferArchive) > Pack ( const uint16 PropertiesNum )


code: virtual ~IDMXProtocolPacket()


description: Sends the DMX signal. Note, this may called concurrently from various threads

code: void SendDMXSignal ( const [FDMXSignalSharedRef](API\Plugins\DMXProtocol\FDMXSignalSharedRef) & DMXSignal )


className: IDMXProtocolPacket

code: struct IDMXProtocolPacket


description: DEPRECATED 5.0

code: virtual void ClearBuffer()


className: IDMXSender

code: class IDMXSender : public [TSharedFromThis< IDMXSender >](API\Runtime\Core\Templates\TSharedFromThis)


className: EDMXPortPriorityStrategy

description: Not: Not all protocols have a use for this

code: enum EDMXPortPriorityStrategy { None, Equal, HigherThan, LowerThan, Highest, Lowest, }


description: Adds a Raw Listener that receives all raw signals received on this port. Only useful for objects that want to process all data, and not just data on tick (e.g. DMX Take Recorder). Should not be used directly, instead see DMXRawListener constructor.

code: virtual void AddRawListener ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXRawListener](API\Plugins\DMXProtocol\IO\FDMXRawListener) > InRawListener )


code: virtual bool CheckPriority ( const int32 InPriority )


description: Clears all buffers

code: void ClearBuffers()


description: Creates an output port tied to a specific config. Makes the config valid if it's invalid.

code: static [FDMXInputPortSharedRef](API\Plugins\DMXProtocol\FDMXInputPortSharedRef) CreateFromConfig ( [FDMXInputPortConfig](API\Plugins\DMXProtocol\IO\FDMXInputPortConfig) & InputPortConfig )


description: Gets all the last signal received. Game-Thread only

code: const [TMap](API\Runtime\Core\Containers\TMap)< int32, [FDMXSignalSharedPtr](API\Plugins\DMXProtocol\FDMXSignalSharedPtr) > & GameThreadGetAllDMXSignals() const


description: Gets the last signal received in specified local universe. Returns false if no signal was received. Game-Thread only

code: bool GameThreadGetDMXSignal ( int32 LocalUniverseID, [FDMXSignalSharedPtr](API\Plugins\DMXProtocol\FDMXSignalSharedPtr) & OutDMXSignal )


description: DEPRECATED 4.27. Gets the DMX signal from an extern (remote) Universe ID.

code: bool GameThreadGetDMXSignalFromRemoteUniverse ( [FDMXSignalSharedPtr](API\Plugins\DMXProtocol\FDMXSignalSharedPtr) & OutDMXSignal, int32 RemoteUniverseID, bool bEvenIfNotLoopbackToEngine )


description: Injects a dmx signal into the game thread. Note, only signals get from game thread are affected but not raw listeners. Useful for nDisplay replication.

code: void GameThreadInjectDMXSignal ( const [FDMXSignalSharedRef](API\Plugins\DMXProtocol\FDMXSignalSharedRef) & DMXSignal )


description: Returns the Guid of the Port

code: virtual const [FGuid](API\Runtime\Core\Misc\FGuid) & GetPortGuid() const


description: Return the stat id to use for this tickable

code: virtual [TStatId](API\Runtime\Core\Stats\TStatId) GetStatId() const


description:
Virtual that can be overloaded by the inheriting class. It is used to determine whether an object will ever be able to tick, and if not, it will not get added to the tickable objects array. If the tickable tick type is Conditional then the virtual IsTickable will be called to determine whether to tick the object on each given frame
true if object will ever want to be ticked, false otherwise.

code: virtual ETickableTickType GetTickableTickType() const


description: Thread-safe: Pushes a DMX Signal into the buffer

code: void InputDMXSignal ( const [FDMXSignalSharedRef](API\Plugins\DMXProtocol\FDMXSignalSharedRef) & DMXSignal )


description: Returns true if receive DMX is disabled

code: bool IsReceiveDMXEnabled() const


description:
Used to determine whether the object should be ticked in the editor. Defaults to false since that is the previous behavior.
true if this tickable object can be ticked in the editor

code: virtual bool IsTickableInEditor() const


description: Returns true if the port is successfully registered with its protocol

code: virtual bool IsRegistered() const


description: Registers the port with its protocol. Returns true if successfully registered

code: virtual bool Register()


description: Creates a dmx input port config that corresponds to the port


description: Removes the Raw Listener from the port. Should not be used directly, instead see DMXRawListener.

code: virtual void RemoveRawListener ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXRawListener](API\Plugins\DMXProtocol\IO\FDMXRawListener) > InRawListener )


description: Sets if the port should listen to its default queue. If false, another raw listener can create the default queue by adding a raw listener and inject its data via GameThreadInjectDMXSignal Useful for nDisplay replication.

code: void SetUseDefaultQueue ( bool bUse )


description: Single Producer thread-safe: Pushes a DMX Signal into the buffer (For protocol only)

code: void SingleProducerInputDMXSignal ( const [FDMXSignalSharedRef](API\Plugins\DMXProtocol\FDMXSignalSharedRef) & DMXSignal )


description: Pure virtual that must be overloaded by the inheriting class. It will be called from within LevelTick.cpp after ticking all actors or from the rendering thread (depending on bIsRenderingThreadObject)

code: virtual void Tick ( float DeltaTime )


description: Unregisteres the port if it was registered with its protocol

code: virtual void Unregister()


description: Updates the Port to use the config of the InputPortConfig. Makes the config valid if it's invalid.

code: void UpdateFromConfig ( [FDMXInputPortConfig](API\Plugins\DMXProtocol\IO\FDMXInputPortConfig) & InOutInputPortConfig, bool bForceUpdateRegistrationWithProtocol )


className: FDMXInputPort

description: Can only be constructed via DMXPortManger, see FDMXPortManager::CreateInputPort and FDMXPortManager::CreateInputPortFromConfig

code: class FDMXInputPort : public [FDMXPort](API\Plugins\DMXProtocol\IO\FDMXPort), public [FTickableGameObject](API\Runtime\Engine\FTickableGameObject)


code: int32 GetExternUniverseStart() const


code: int32 GetLocalUniverseStart() const


code: int32 GetNumUniverses() const


code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetPortGuid() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetPortName() const


code: const [EDMXPortPriorityStrategy](API\Plugins\DMXProtocol\IO\EDMXPortPriorityStrategy) GetPortPriorityStrategy() const


code: const int32 GetPriority() const


code: const [FName](API\Runtime\Core\UObject\FName) & GetProtocolName() const


description: Changes members to result in a valid config

code: void MakeValid()


description: Upgrades this config to the latest engine version

code: void Upgrade()


description: Default constructor, only for Default Objects

code: FDMXInputPortConfig()


description: Constructs a config from the guid

code: FDMXInputPortConfig ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InPortGuid )


description: Constructs a config from the guid and given initialization data

code: FDMXInputPortConfig ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InPortGuid, const [FDMXInputPortConfigParams](API\Plugins\DMXProtocol\IO\FDMXInputPortConfigParams) & InitializationData )


className: FDMXInputPortConfig

description: Property changes are handled in details customization consistently.

AutoCompleteDeviceAddress

description: Searches available Network Interface Card IP Addresses and uses the first match as the 'Network Interface Card IP Address' (both in Editor and Game).

bAutoCompleteDeviceAddressEnabled

type: bool

description: Enables 'Auto Complete Device Address', hidden via customization - EditConditionInlineToggle doesn't support Config

bIsExternUnivereStartEditable

description: Edit condition for the ExternUniverseStart property

CommunicationType

type: EDMXCommunicati...

description: The type of communication used with this port

DeviceAddress

description: The Network Interface Card's IP Adress, over which DMX is received

ExternUniverseStart

description: Remaps the range of local Universes (Num Universes from Local Universe Start) to a different set of Universes at the Protocol level.

LocalUniverseStart

description: Local Start Universe

NumUniverses

description: Number of Universes

PortGuid

type: FGuid

description: Unique identifier, shared with the port instance.

PortName

description: The name displayed wherever the port can be displayed

Priority

description: Priority value, can act as a filter or a threshold

PriorityStrategy

type: EDMXPortPriorit...

description: How to deal with the priority value

ProtocolName

description: DMX Protocol


code: FDMXInputPortConfigParams ( const [FDMXInputPortConfig](API\Plugins\DMXProtocol\IO\FDMXInputPortConfig) & InputPortConfig )


className: FDMXInputPortConfigParams

description: Data to create a new input port config with related constructor.

code: struct FDMXInputPortConfigParams


description: Returns a non const Guid of the port, required for serialization only


description: Returns true if the port is enabled. Always true unless constructed with bIsAlwaysEnabled = false

code: bool IsEnabledFlagSet() const


code: bool operator== ( const [FDMXInputPortReference](API\Plugins\DMXProtocol\IO\FDMXInputPortReference) & Other ) const


code: bool operator!= ( const [FDMXInputPortReference](API\Plugins\DMXProtocol\IO\FDMXInputPortReference) & Other ) const


code: FDMXInputPortReference ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InPortGuid, bool bIsEnabledFlag )


code: FDMXInputPortReference ( const [FDMXInputPortReference](API\Plugins\DMXProtocol\IO\FDMXInputPortReference) & InInputPortReference, bool bIsEnabledFlag )


className: FDMXInputPortReference

description: Reference of an input port

bEnabledFlag

type: uint32:  1

description: Optional flag for port references that can be enabled or disabled

PortGuid

description: Unique identifier shared with port config and port instance.


className: FDMXOnPortsChangedDelegate

code: typedef TMulticastDelegate_NoParams< void > FDMXOnPortsChangedDelegate


description: Adds a Raw Listener that receives all raw signals received on this port. Only useful for objects that want to process all data, and not just data on tick (e.g. DMX Take Recorder). Should not be used directly, instead see DMXRawListener constructor.

code: virtual void AddRawListener ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXRawListener](API\Plugins\DMXProtocol\IO\FDMXRawListener) > InRawListener )


description: Clears all buffers

code: void ClearBuffers()


description: Creates an output port tied to a specific config. Hidden on purpose, useFDMXPortManagerto create instances

code: static [FDMXOutputPortSharedRef](API\Plugins\DMXProtocol\FDMXOutputPortSharedRef) CreateFromConfig ( [FDMXOutputPortConfig](API\Plugins\DMXProtocol\IO\FDMXOutputPortConfig) & OutputPortConfig )


description: Stop

code: virtual void Exit()


description: DEPRECATED 4.27. Gets the DMX signal from an extern (remote) Universe ID.

code: bool GameThreadGetDMXSignalFromRemoteUniverse ( [FDMXSignalSharedPtr](API\Plugins\DMXProtocol\FDMXSignalSharedPtr) & OutDMXSignal, int32 RemoteUniverseID, bool bEvenIfNotLoopbackToEngine )


description:
Game-Thread only: Gets the last signal received in specified local universe.
True if the OutDMXSignal was set.

code: bool GameThreadGetDMXSignal ( int32 LocalUniverseID, [FDMXSignalSharedPtr](API\Plugins\DMXProtocol\FDMXSignalSharedPtr) & OutDMXSignal, bool bEvenIfNotLoopbackToEngine )


description: Returns the output port's delay in seconds

code: double GetDelaySeconds() const


description: Returns the Destination Addresses

code: [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetDestinationAddresses() const


description: Returns the Guid of the Port

code: virtual const [FGuid](API\Runtime\Core\Misc\FGuid) & GetPortGuid() const


description:
Gets single thread interface pointer used for ticking this runnable when multi-threading is disabled. If the interface is not implemented, this runnable will not be ticked when FPlatformProcess::SupportsMultithreading() is false.
Pointer to the single thread interface or nullptr if not implemented.

code: virtual [FSingleThreadRunnable](API\Runtime\Core\Misc\FSingleThreadRunnable) * GetSingleThreadInterface()


description: Exit

code: virtual bool Init()


description: Creates a dmx output port config that corresponds to the port


description: Returns true if the port is successfully registered with its protocol

code: virtual bool IsRegistered() const


description: Called when the DMX send rate changed

code: void OnSendingRefreshRateChanged()


description: Called to set if DMX should be enabled

code: void OnSetReceiveDMXEnabled ( bool bEnabled )


description: Called to set if DMX should be enabled

code: void OnSetSendDMXEnabled ( bool bEnabled )


description: Updates the thread, sending DMX

code: void ProcessSendDMX()


description: Registers the port with its protocol. Returns true if successfully registered

code: virtual bool Register()


description: Removes the Raw Listener from the port. Should not be used directly, instead see DMXRawListener.

code: virtual void RemoveRawListener ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXRawListener](API\Plugins\DMXProtocol\IO\FDMXRawListener) > InRawListener )


description: Exit

code: virtual uint32 Run()


description: Sends DMX over the port

code: void SendDMX ( int32 LocalUniverseID, const [TMap](API\Runtime\Core\Containers\TMap)< int32, uint8 > & ChannelToValueMap )


description: DEPRECATED 4.27. Sends DMX over the port with an extern (remote) Universe ID. Soly here to support legacy functions that would send to an extern universe

code: void SendDMXToRemoteUniverse ( const [TMap](API\Runtime\Core\Containers\TMap)< int32, uint8 > & ChannelToValueMap, int32 RemoteUniverse )


description: Exit

code: virtual void Stop()


description: Tick function.

code: virtual void Tick()


description: Unregisteres the port if it was registered with its protocol

code: virtual void Unregister()


description: Updates the Port to use the config of the OutputPortConfig. Makes the config valid if it's invalid.

code: void UpdateFromConfig ( [FDMXOutputPortConfig](API\Plugins\DMXProtocol\IO\FDMXOutputPortConfig) & OutputPortConfig, bool bForceUpdateRegistrationWithProtocol )


className: FDMXOutputPort

description: Note, internally locks have to be acquired in order as they're declared in the header.

code: class FDMXOutputPort : public [FDMXPort](API\Plugins\DMXProtocol\IO\FDMXPort), public [FRunnable](API\Runtime\Core\HAL\FRunnable), public [FSingleThreadRunnable](API\Runtime\Core\Misc\FSingleThreadRunnable)


description: Returns true if loopback to engine is enabled (only true if loopback to engine is set enabled)

code: bool IsLoopbackToEngineEnabled() const


description: Determinates if loopback to engine is needed (may be true even is loopback to engine is not enabled)

code: bool NeedsLoopbackToEngine() const


description: Determinates if send dmx is enabled

code: bool IsSendDMXEnabled() const


description: Determinates if dmx needs to be sent (may be false even if send is enabled)

code: bool NeedsSendDMX() const


description: Sets if there is a valid sender obj

code: void SetHasValidSender ( bool bInHasValidSender )


description: Set the variable from the port config in project settings

code: void SetLoopbackToEngine ( bool bInLoopbackToEngine )


description: Sets if receive is enabled

code: void SetReceiveEnabled ( bool bInReceiveEnabled )


description: Sets if send is enabled

code: void SetSendEnabled ( bool bInSendEnabled )


className: FDMXOutputPortCommunicationDeterminator

description: Helper to determine how DMX should be communicated (loopback, send)


code: const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & GetDelayFrameRate() const


description: Deprecated* Output Ports now support many destination addresses. UseFDMXOutputPortConfig::GetDestinationAddressesPropertyNameCheckedinstead.


description: Deprecated* Output Ports now support many destination addresses. UseFDMXOutputPortConfig::GetDestinationAddressesinstead.

code: const [FString](API\Runtime\Core\Containers\FString) & GetDestinationAddress() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FDMXOutputPortDestinationAddress](API\Plugins\DMXProtocol\IO\FDMXOutputPortDestinationAddress) > & GetDestinationAddresses() const


code: int32 GetExternUniverseStart() const


code: int32 GetLocalUniverseStart() const


code: int32 GetNumUniverses() const


code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetPortGuid() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetPortName() const


code: const [FName](API\Runtime\Core\UObject\FName) & GetProtocolName() const


description: Changes members to result in a valid config

code: void MakeValid()


code: bool NeedsLoopbackToEngine() const


description: Upgrades this config to the latest engine version

code: void Upgrade()


description: Default constructor, only for Default Objects

code: FDMXOutputPortConfig()


description: Constructs a config from the guid

code: FDMXOutputPortConfig ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InPortGuid )


description: Constructs a config from the guid and given initialization data

code: FDMXOutputPortConfig ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InPortGuid, const [FDMXOutputPortConfigParams](API\Plugins\DMXProtocol\IO\FDMXOutputPortConfigParams) & InitializationData )


className: FDMXOutputPortConfig

description: Property changes are handled in details customization consistently.

AutoCompleteDeviceAddress

description: Searches available Network Interface Card IP Addresses and uses the first match as the 'Network Interface Card IP Address' (both in Editor and Game).

bAutoCompleteDeviceAddressEnabled

description: Enables 'Auto Complete Device Address', hidden via customization - EditConditionInlineToggle doesn't support Config

bIsExternUnivereStartEditable

description: Edit condition for the ExternUniverseStart property

bLoopbackToEngine

description: If true, the signals output from this port are input into to the engine.

CommunicationType

description: The type of communication used with this port

Delay

description: The amout by which sending of packets is delayed

DelayFrameRate

type: FFrameRate

description: Framerate of the delay

DestinationAddress

description: For Unicast, the IP address outbound DMX is sent to

DestinationAddresses

description: For Unicast, the IP addresses outbound DMX is sent to

DeviceAddress

description: The IP address of the network interface card over which outbound DMX is sent

ExternUniverseStart

description: Remaps the range of local Universes (Num Universes from Local Universe Start) to a different set of Universes at the Protocol level.

LocalUniverseStart

description: Local Start Universe

NumUniverses

description: Number of Universes

description: Unique identifier, shared with the port instance.

PortName

description: The name displayed wherever the port can be displayed

Priority

description: Priority on which packets are being sent

ProtocolName

description: DMX Protocol


code: FDMXOutputPortConfigParams ( const [FDMXOutputPortConfig](API\Plugins\DMXProtocol\IO\FDMXOutputPortConfig) & OutputPortConfig )


className: FDMXOutputPortConfigParams

description: Data to create a new output port config with related constructor

code: struct FDMXOutputPortConfigParams


code: bool operator== ( const [FDMXOutputPortDestinationAddress](API\Plugins\DMXProtocol\IO\FDMXOutputPortDestinationAddress) & Other ) const


code: bool operator!= ( const [FDMXOutputPortDestinationAddress](API\Plugins\DMXProtocol\IO\FDMXOutputPortDestinationAddress) & Other ) const


code: FDMXOutputPortDestinationAddress()


code: FDMXOutputPortDestinationAddress ( const [FString](API\Runtime\Core\Containers\FString) & DestinationAddress )


className: FDMXOutputPortDestinationAddress

description: The IP address outbound DMX is sent to

DestinationAddressString

description: The IP address outbound DMX is sent to


description: Returns true if the port is enabled. Always true unless constructed with bIsAlwaysEnabled = false

code: bool IsEnabledFlagSet() const


code: bool operator== ( const [FDMXOutputPortReference](API\Plugins\DMXProtocol\IO\FDMXOutputPortReference) & Other ) const


code: bool operator!= ( const [FDMXOutputPortReference](API\Plugins\DMXProtocol\IO\FDMXOutputPortReference) & Other ) const


code: FDMXOutputPortReference ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InPortGuid, bool bIsEnabledFlag )


code: FDMXOutputPortReference ( const [FDMXOutputPortReference](API\Plugins\DMXProtocol\IO\FDMXOutputPortReference) & InOutputPortReference, bool bIsEnabledFlag )


description: Adds a Raw Listener that receives all raw signals received on this port. Only useful for objects that want to process all data, and not just data on tick (e.g. DMX Take Recorder). Should not be used directly, instead see DMXRawListener constructor.

code: void AddRawListener ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXRawListener](API\Plugins\DMXProtocol\IO\FDMXRawListener) > InRawListener )


className: FDMXOutputPortReference

description: Reference of an input port

bEnabledFlag

description: Optional flag for port references that can be enabled or disabled

PortGuid

description: Unique identifier shared with port config and port instance.


description: Converts a local Universe ID to an extern Universe ID

code: int32 ConvertLocalToExternUniverseID ( int32 LocalUniverseID ) const


description: Converts an extern Universe ID to a local Universe ID

code: int32 ConvertExternToLocalUniverseID ( int32 ExternUniverseID ) const


code: const [FString](API\Runtime\Core\Containers\FString) & GetAutoCompleteDeviceAddress() const


code: int32 GetExternUniverseEnd() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetDeviceAddress() const


description: Returns the offset of the extern universe. LocalUniverse == ExternUniverse - ExternUniverseOffset

code: int32 GetExternUniverseOffset() const


code: int32 GetExternUniverseStart() const


code: int32 GetLocalUniverseEnd() const


code: int32 GetLocalUniverseStart() const


description: Returns the Guid of the Port

code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetPortGuid() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetPortName() const


code: const [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) & GetProtocol() const


description: Returns true if the Extern Universe is in this Port's Universe range

code: bool IsExternUniverseInPortRange ( int32 Universe ) const


description: Returns true if the Intern Universe is in this Port's Universe range

code: bool IsLocalUniverseInPortRange ( int32 Universe ) const


description: Returns true if the port is successfully registered with its protocol

code: bool IsRegistered() const


description: Tests whether the port is valid

code: bool IsValidPortSlow() const


description: Registers the port with its protocol. Returns true if successfully registered

code: bool Register()


description: Removes the Raw Listener from the port. Should not be used directly, instead see DMXRawListener.

code: void RemoveRawListener ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXRawListener](API\Plugins\DMXProtocol\IO\FDMXRawListener) > InRawListener )


description: Unregisteres the port if it was registered with its protocol

code: void Unregister()


description: Protected default constructor, child classes need to take care of member initialization

code: FDMXPort()


description: ~End DMXPort Interface declaration

code: virtual ~FDMXPort()


className: FDMXPort

description: Base class for a higher level abstraction of a DMX input or output. Higher level abstraction of a DMX input hiding networking specific and protocol specific complexity.

code: class FDMXPort : public [TSharedFromThis< FDMXPort, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)

AutoCompleteDeviceAddress

description: The auto-complete Device Address, supports wildcards

bAutoCompleteDeviceAddressEnabled

description: If true, instead of using the Device Address, the port will auto-complete the IP from the available Network Interface Card Addresses

CommunicationType

description: The communication type of this port

DeviceAddress

description: The address of the device that handles communication, e.g. the network interface for art-net

ExternUniverseStart

description: The start address this being transposed to.

LocalUniverseStart

description: The Local Start Universe

NumUniverses

description: Number of Universes

OnPortUpdated

type: FSimpleMulticas...

description: Broadcast when the port is updated

PortName

description: Variables that need be initialized from derived classes.

Protocol

type: IDMXProtocolPtr

description: The protocol of this port


description: Returns true if protocols are suspended

code: bool AreProtocolsSuspended()


className: CurrentManager

code: static [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FDMXPortManager](API\Plugins\DMXProtocol\IO\FDMXPortManager) > CurrentManager;


description: Returns the input port matching the port guid. Returns nullptr if the port doesn't exist.

code: [FDMXInputPortSharedPtr](API\Plugins\DMXProtocol\FDMXInputPortSharedPtr) FindInputPortByGuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PortGuid ) const


description: Returns the input port matching the port guid, checkedversion.

code: [FDMXInputPortSharedRef](API\Plugins\DMXProtocol\FDMXInputPortSharedRef) FindInputPortByGuidChecked ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PortGuid ) const


description: Returns the output port matching the port guid. Returns nullptr if the port doesn't exist.

code: [FDMXOutputPortSharedPtr](API\Plugins\DMXProtocol\FDMXOutputPortSharedPtr) FindOutputPortByGuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PortGuid ) const


description: Returns the output port matching the port guid, checked version.

code: [FDMXOutputPortSharedRef](API\Plugins\DMXProtocol\FDMXOutputPortSharedRef) FindOutputPortByGuidChecked ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PortGuid ) const


description: Returns the port matching the port guid. Returns nullptr if the port doesn't exist.

code: [FDMXPortSharedPtr](API\Plugins\DMXProtocol\FDMXPortSharedPtr) FindPortByGuid ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PortGuid ) const


description: Returns the port matching the port guid, checked version.

code: [FDMXPortSharedRef](API\Plugins\DMXProtocol\FDMXPortSharedRef) FindPortByGuidChecked ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PortGuid ) const


code: static [FDMXPortManager](API\Plugins\DMXProtocol\IO\FDMXPortManager) & Get()


description: Gets the input port that corresponds to the input port config. Checks the config is in the DMXProtocolSetting's InputPortConfigs array.

code: [FDMXInputPortSharedRef](API\Plugins\DMXProtocol\FDMXInputPortSharedRef) GetInputPortFromConfigChecked ( const [FDMXInputPortConfig](API\Plugins\DMXProtocol\IO\FDMXInputPortConfig) & InputPortConfig )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FDMXInputPortSharedRef](API\Plugins\DMXProtocol\FDMXInputPortSharedRef) > & GetInputPorts() const


description: Gets the output port that corresponds to the input port config. Checks the config is in the DMXProtocolSetting's OutputPortConfigs array.

code: [FDMXOutputPortSharedRef](API\Plugins\DMXProtocol\FDMXOutputPortSharedRef) GetOutputPortFromConfigChecked ( const [FDMXOutputPortConfig](API\Plugins\DMXProtocol\IO\FDMXOutputPortConfig) & OutputPortConfig )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FDMXOutputPortSharedRef](API\Plugins\DMXProtocol\FDMXOutputPortSharedRef) > & GetOutputPorts() const


code: void operator= ( [FDMXPortManager](API\Plugins\DMXProtocol\IO\FDMXPortManager) const & x )


description: Initializes the manager

code: static void StartupManager()


description: Note: When protocols are suspended, changes to project settings are no longer reflected and UpdateFromProtocolSettings has no effect.

code: void SuspendProtocols()


description: Updates ports from protocol settings. Useful when project settings were modified in some way. If optional bForceUpdateRegistrationWithProtocol is set to true, ports will reregister with the protocol.

code: void UpdateFromProtocolSettings ( bool bForceUpdateRegistrationWithProtocol )


description: Initialization.

code: FDMXPortManager()


description: Non-copyable.

code: FDMXPortManager ( [FDMXPortManager](API\Plugins\DMXProtocol\IO\FDMXPortManager) const & )


description: Thread-safe. Clears the raw buffer

code: void ClearBuffer()


className: FDMXPortManager

description: Use the DMXOutputPort's SendDMX method to send DMX.

code: class FDMXPortManager

OnPortsChanged

type: FDMXOnPortsChan...

description: Broadcast when port arrays or data changed


description: Destroys the manager.

code: static void ShutdownManager()


description:
Thread safe single consumer. Tries to dequeues a signal from the raw listener.
True if a signal was dequeued.

code: bool DequeueSignal ( void * Consumer, [FDMXSignalSharedPtr](API\Plugins\DMXProtocol\FDMXSignalSharedPtr) & OutSignal, int32 & OutLocalUniverseID )


description: Producer The producer object, tested in debug builds to be the owner port.  Signal The signal to enqueue

code: void EnqueueSignal ( void * Producer, const [FDMXSignalSharedRef](API\Plugins\DMXProtocol\FDMXSignalSharedRef) & Signal )


description: Starts receiving the Input

code: void Start()


description: Stops receiving the Input

code: void Stop()


description: Destructor

code: virtual ~FDMXRawListener()


description: Constructor

code: FDMXRawListener ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXPort](API\Plugins\DMXProtocol\IO\FDMXPort), ESPMode::ThreadSafe > InOwnerPort )


code: FDMXSignalFragment ( int32 InExternUniverseID, const [TMap](API\Runtime\Core\Containers\TMap)< int32, uint8 > & InChannelToValueMap, double InSendTime )


className: FDMXSignalFragment

description: Structs that holds the fragmented values to be sent along with a timestamp when to send it

code: struct FDMXSignalFragment : public [TSharedFromThis< FDMXSignalFragment, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)

ChannelToValueMap

type: TMap< int32, ui...

description: The map of channels and values to send

ExternUniverseID

description: The universe the fragment needs to be written to

SendTime

description: The time when the Fragment needs be sent


className: operator==

code: bool operator== ( const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & V1, const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & V2 )


className: operator!=

code: bool operator!= ( const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & V1, const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & V2 )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToName (DMX Attribute)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [FName](API\Runtime\Core\UObject\FName) Conv_DMXAttributeToName ( const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & InAttribute )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToString (DMX Attribute)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [FString](API\Runtime\Core\Containers\FString) Conv_DMXAttributeToString ( const [FDMXAttributeName](API\Plugins\DMXProtocol\FDMXAttributeName) & InAttribute )


className: FDMXRawListener

description: Needs frequent dequeuing. Stop needs to be called before the Input is released.

code: class FDMXRawListener : public [TSharedFromThis< FDMXRawListener >](API\Runtime\Core\Templates\TSharedFromThis)


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToString (DMX Fixture Category)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [FString](API\Runtime\Core\Containers\FString) Conv_DMXFixtureCategoryToString ( const [FDMXFixtureCategory](API\Plugins\DMXProtocol\FDMXFixtureCategory) & InFixtureCategory )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToName (DMX Fixture Category)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [FName](API\Runtime\Core\UObject\FName) Conv_DMXFixtureCategoryToName ( const [FDMXFixtureCategory](API\Plugins\DMXProtocol\FDMXFixtureCategory) & InFixtureCategory )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToString (DMX Protocol Name)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [FString](API\Runtime\Core\Containers\FString) Conv_DMXProtocolNameToString ( const [FDMXProtocolName](API\Plugins\DMXProtocol\FDMXProtocolName) & InProtocolName )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Meta=(DisplayName="ToName (DMX Protocol Name)", CompactNodeTitle="->", BlueprintAutocast), Category="Utilities|DMX") static [FName](API\Runtime\Core\UObject\FName) Conv_DMXProtocolNameToName ( const [FDMXProtocolName](API\Plugins\DMXProtocol\FDMXProtocolName) & InProtocolName )


className: UDMXNameContainersConversions


description:
Returns the IP addresses of the network interface cards available to the system.
The Network Interface Card IP Addresses

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > GetLocalDMXNetworkInterfaceCardIPs()


description:
Returns whether Receive DMX from the network is enabled globally.
If true, DMX is received from the Network

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static bool IsReceiveDMXEnabled()


description:
Returns whether send DMX to the network is enabled globally.
If true, DMX is sent to the Network

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static bool IsSendDMXEnabled()


description: Sets the Device Address of the Output Port. For networking Protocols that's the IP Adress of the network interface card.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static void SetDMXInputPortDeviceAddress ( [FDMXInputPortReference](API\Plugins\DMXProtocol\IO\FDMXInputPortReference) InputPort, const [FString](API\Runtime\Core\Containers\FString) & DeviceAddress )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static void SetDMXOutputPortDeviceAddress ( [FDMXOutputPortReference](API\Plugins\DMXProtocol\IO\FDMXOutputPortReference) OutputPort, const [FString](API\Runtime\Core\Containers\FString) & DeviceAddress )


description: Sets the Destination Address Address of the Output Port. For networking Protocols that's the Unicast IP Adress. Not required for Multicast and Broadcast.

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static void SetDMXOutputPortDestinationAddresses ( [FDMXOutputPortReference](API\Plugins\DMXProtocol\IO\FDMXOutputPortReference) OutputPort, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & DestinationAddresses )


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX", Meta=(DeprecatedFunction, DeprecationMessage="Deprecated 5.0. Output Ports now support many Destination Addresses. Please use SetDMXOutputPortDestinationAddresses instead.")) static void SetDMXOutputPortDestinationAddress ( [FDMXOutputPortReference](API\Plugins\DMXProtocol\IO\FDMXOutputPortReference) OutputPort, const [FString](API\Runtime\Core\Containers\FString) & DestinationAddress )


description: Sets if DMX is received from the network

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static void SetReceiveDMXEnabled ( bool bReceiveDMXEnabled, bool bAffectEditor )


description: Sets if DMX is sent to the network

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="DMX") static void SetSendDMXEnabled ( bool bSendDMXEnabled, bool bAffectEditor )


code: typedef TMulticastDelegate_OneParam< void, bool > FDMXOnAllFixturePatchesReceiveDMXInEditorEnabled


className: FDMXOnReceiveDMXEnabled

code: typedef TMulticastDelegate_OneParam< void, bool > FDMXOnReceiveDMXEnabled


className: FDMXOnSendDMXEnabled

code: typedef TMulticastDelegate_OneParam< void, bool > FDMXOnSendDMXEnabled


description: Returns the input port matching the predicate, or nullptr if it cannot be found

code: template<typename Predicate> [FDMXInputPortConfig](API\Plugins\DMXProtocol\IO\FDMXInputPortConfig) * FindInputPortConfig ( Predicate Pred )


code: template<typename Predicate> [FDMXOutputPortConfig](API\Plugins\DMXProtocol\IO\FDMXOutputPortConfig) * FindOutputPortConfig ( Predicate Pred )


description: Returns the property name of the bDMXComponentRecievesDMXInEditor Property


description: Returns the property name of the bDefaultReceiveDMXEnabled Property


description: Returns the property name of the bDefaultSendDMXEnabled Property


description: Gets a Delegate Broadcast when receive DMX is enabled or disabled


description: Gets a delegate broadcast when default attributes were changed


description: Gets a delegate broadcast when default fixture categories were changed


description: Gets a delegate broadcast when receive DMX is enabled or disabled


description: Gets a delegate broadcast when send DMX is enabled or disabled


description: Returns an automatic/unique name for an InputPort


description: Returns whether receive DMX is currently enabled, considering runtime override

code: bool IsReceiveDMXEnabled() const


description: Returns an automatic/unique name for an OutputPort


description: Returns whether send DMX is currently enabled, considering runtime override

code: bool IsSendDMXEnabled() const


description: Overrides if send DMX is enabled at runtime

code: void OverrideReceiveDMXEnabled ( bool bEnabled )


code: void OverrideSendDMXEnabled ( bool bEnabled )


description: This alternate version of PostEditChange is called when properties inside structs are modified. The property that was actually modified is located at the tail of the list. The head of the list of theFStructPropertymember variable that contains the property that was modified.

code: virtual void PostEditChangeChainProperty ( [FPropertyChangedChainEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedChainEvent) & PropertyChangedEvent )


description: Called when a property on this object has been modified externally

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


description: Gets a delegate broadcast when the Sending Refresh Rate (the DMX send rate) changed


description: Returns true if Fixture Patches should receive DMX in Editor


className: UDMXProtocolSettings

description: Note: To handle Port changes in code please refer toFDMXPortManager.

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Config=Engine, defaultconfig, AutoExpandCategories=("DMX|Communication Settings"), Meta=(DisplayName="DMX")) class UDMXProtocolSettings : public [UObject](API\Runtime\CoreUObject\UObject\UObject)

Attributes

type: TSet<FDMXAttri...

description: Common names to map Fixture Functions to and access them easily on Blueprints

FixtureCategories

type: TSet<FName>

description: Fixture Categories ENum

InputPortConfigs

type: TArray<FDMXInp...

description: DMX Input Port Configs

OutputPortConfigs

type: TArray<FDMXOut...

description: DMX Output Port Configs

SendingRefreshRate

description: Rate at which DMX is sent, in Hz from 1 to 1000. 44Hz is recommended.


description: Get the instance of this module.

module: DMXProtocolArtNet

code: static [FDMXProtocolArtNetModule](API\Plugins\DMXProtocolArtNet\FDMXProtocolArtNetModule) & Get()


code: static [FName](API\Runtime\Core\UObject\FName) const NAME_Artnet = FName( "Art-Net" );


className: ResetDMXSendUniverseCommand

description: Command for reset DMX universe through the console


className: SendDMXCommand

description: Command for sending DMX through the console


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


className: FDMXProtocolArtNetModule

code: class FDMXProtocolArtNetModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description:
It creates only one instance of Protocol. There is the condition to check in DMXProtocolModule
Return the pointer to protocol

code: virtual [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) CreateProtocol ( const [FName](API\Runtime\Core\UObject\FName) & ProtocolName )


className: FDMXProtocolFactoryArtNet

code: class FDMXProtocolFactoryArtNet : public [IDMXProtocolFactory](API\Plugins\DMXProtocol\Interfaces\IDMXProtocolFactory)


module: DMXProtocolBlueprintGraph

code: static bool IsAvailable()


className: FDMXProtocolBlueprintGraphModule

description: The public interface to this module

code: class FDMXProtocolBlueprintGraphModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: FDMXProtocolGraphPanelPinFactory

code: class FDMXProtocolGraphPanelPinFactory : public [FGraphPanelPinFactory](API\Editor\UnrealEd\FGraphPanelPinFactory)


description: Get the instance of this module.

module: DMXProtocolEditor

code: static [FDMXProtocolEditorModule](API\Plugins\DMXProtocolEditor\FDMXProtocolEditorModule) & Get()


className: FDMXProtocolEditorModule

description: Implements the DMXProtocolEditor Module

code: class FDMXProtocolEditorModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: EDMXPortSelectorItemType

code: enum EDMXPortSelectorItemType { TitleRow, Input, Output, }


className: EDMXPortSelectorMode

code: enum EDMXPortSelectorMode { SelectFromAvailableInputs, SelectFromAvailableOutputs, SelectFromAvailableInputsAndOutputs, }


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXPortSelectorItem](API\Plugins\DMXProtocolEditor\Widgets\FDMXPortSelectorItem) > CreateItem ( const [FDMXInputPortConfig](API\Plugins\DMXProtocol\IO\FDMXInputPortConfig) & InPortConfig )


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXPortSelectorItem](API\Plugins\DMXProtocolEditor\Widgets\FDMXPortSelectorItem) > CreateItem ( const [FDMXOutputPortConfig](API\Plugins\DMXProtocol\IO\FDMXOutputPortConfig) & InPortConfig )


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FDMXPortSelectorItem](API\Plugins\DMXProtocolEditor\Widgets\FDMXPortSelectorItem) > CreateTitleRowItem ( const [FString](API\Runtime\Core\Containers\FString) & TitleString )


code: const [FGuid](API\Runtime\Core\Misc\FGuid) & GetGuid() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetItemName() const


code: const [EDMXPortSelectorItemType](API\Plugins\DMXProtocolEditor\Widgets\EDMXPortSelectorItemType) GetType() const


code: bool IsTitleRow() const


className: FDMXPortSelectorItem

description: An item in the Port Selector Combo Box

code: class FDMXPortSelectorItem : public [TSharedFromThis< FDMXPortSelectorItem >](API\Runtime\Core\Templates\TSharedFromThis)


code: WidgetArgsType & InitialSelection &40; FGuid InArg &41;


description: Constructs the widget

code: void Construct ( const [FArguments](API\Plugins\DMXProtocolEditor\Widgets\SDMXPortSelector\FArguments) & InArgs )


code: WidgetArgsType & Mode &40; EDMXPortSelectorMode InArg &41;


code: WidgetArgsType & OnPortSelected &40; const FSimpleDelegate & InDelegate &41;


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


description: Returns the selected input port, or nullptr if no valid input port is selected


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SDMXPortSelector >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Returns true if a valid port is selected

code: bool HasSelection() const


description: Returns the selected output port, or nullptr if no valid output port is selected


description: Returns true if an input port is selected

code: bool IsInputPortSelected() const


description: Selects specified Port by Port Guid. If the Guid is not valid, clears the selection

code: void SelectPort ( const [FGuid](API\Runtime\Core\Misc\FGuid) & PortGuid )


description: Instead of showing a selected port, the widget displays 'Multiple Values' and no longer returns a selected port. The widget will no longer display 'Multiple Values' when a selection was made.

code: void SetHasMultipleValues()


className: SDMXPortSelector

description: Directly returns corresponding DMXPort via the GetPort method.

code: class SDMXPortSelector : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


module: DMXProtocolsACN

code: virtual [IDMXProtocolPtr](API\Plugins\DMXProtocol\IDMXProtocolPtr) CreateProtocol ( const [FName](API\Runtime\Core\UObject\FName) & ProtocolName )


className: FDMXProtocolFactorySACN

code: class FDMXProtocolFactorySACN : public [IDMXProtocolFactory](API\Plugins\DMXProtocol\Interfaces\IDMXProtocolFactory)


code: static [FName](API\Runtime\Core\UObject\FName) const NAME_SACN = FName( "sACN" );


description: Returns true if an output port is selected

code: bool IsOutputPortSelected() const


code: virtual void ShutdownModule()


code: virtual void StartupModule()


className: FDMXProtocolSACNModule

code: class FDMXProtocolSACNModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


module: DMXRuntime

code: const [FDMXByteArray64](API\Plugins\DMXRuntime\FDMXByteArray64) & operator= ( const [FDMXByteArray64](API\Plugins\DMXRuntime\FDMXByteArray64) & Rhs )


code: const [FDMXByteArray64](API\Plugins\DMXRuntime\FDMXByteArray64) & operator= ( const TArray64< uint8 > & Rhs )


code: bool Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


description: XyY color representation in the CIE 1931 color space, as typically used in GDTF and MVR

X

type: float

description: X

Y

description: Y

YY

description: Y