1. Epic GamesDeveloper
  3. DMXRuntime

DMXRuntime

API > API/Plugins

   
Name DMXRuntime
Type Runtime
Part of Plugins DMX Engine
Location /Engine/Plugins/VirtualProduction/DMX/DMXEngine/Source/DMXRuntime/
Module Build Rules DMXRuntime.Build.cs

Classes

Name Remarks
ADMXMVRSceneActor  
FDMXEntityFixturePatchCache Cache for fixture patches.
FDMXMVRFixtureActorLibrary  
FDMXRuntimeUtils  
FProtocolReceivedDelegate  
UDMXComponent Component that receives DMX input each Tick from a fixture patch.
UDMXEntity Base class for all entity types
UDMXEntityController  
UDMXEntityFixturePatch A DMX fixture patch that can be patch to channels in a DMX Universe via the DMX Library Editor.
UDMXEntityFixtureType Class to describe a type of Fixture.
UDMXEntityReferenceConversions Extend type conversions to handle Entity Reference structs
UDMXEntityUniverseManaged  
UDMXGDTFAssetImportData  
UDMXImport  
UDMXImportAttributeDefinitions  
UDMXImportDMXModes  
UDMXImportFixtureType  
UDMXImportGDTF A GDTF imported into Unreal Engine.
UDMXImportGDTFAttributeDefinitions  
UDMXImportGDTFDMXModes  
UDMXImportGDTFFixtureType  
UDMXImportGDTFGeometries  
UDMXImportGDTFModels  
UDMXImportGDTFPhysicalDescriptions  
UDMXImportGDTFProtocols  
UDMXImportGDTFWheels  
UDMXImportGeometries  
UDMXImportModels  
UDMXImportPhysicalDescriptions  
UDMXImportProtocols  
UDMXImportWheels  
UDMXLibrary DMX Library.Holds Fixture Types and Fixture Patches that can be used to send and receive DMX.
UDMXModulator Base class for custom modulators.
UDMXMVRAssetImportData  
UDMXMVRAssetUserData Asset user data for Actors in an MVR Scene
UDMXMVRChildListNode This node defines a generic graphical object.
UDMXMVRFixtureNode This node defines a light fixture object.
UDMXMVRGeneralSceneDescription MVR General Scene Description Object
UDMXMVRGroupObjectNode This node defines logical group of objects.
UDMXMVRLayerNode A Layer node in the Layers Node of a Scene.
UDMXMVRLayersNode This node defines a list of layers inside the scene.
UDMXMVRParametricObjectNodeBase UE specific: The base class for all Children in a Child List Node, whereas the standard refers to them as 'Parametric Objects'.
UDMXMVRRootNode The root node of an MVR General Scene Description as typically held in an MVR's GeneralSceneDescription.xml.
UDMXMVRSceneNode This node contains information about the scene.
UDMXMVRUnrealEngineDataNode This node contains a collection of data specified by the provider application.
UDMXMVRUserDataNode This node contains a collection of user data nodes defined and used by provider applications if required.
UDMXObjectBase  
UDMXSubsystem UDMXSubsystem Collections of DMX context blueprint subsystem functions and internal functions for DMX K2Nodes
UMovieSceneDMXLibrarySection A DMX Fixture Patch section
UMovieSceneDMXLibraryTrack Handles manipulation of DMX Libraries in a movie scene.

Structs

Name Remarks
FDMXByteArray64  
FDMXCachedFunctionChannelInfo Cached info of fixture function channels.
FDMXCell  
FDMXEntityControllerRef Represents a Controller from a DMX Library.
FDMXEntityFixturePatchConstructionParams Parameters to construct a Fixture Patch.
FDMXEntityFixturePatchRef Represents a Fixture Patch from a DMX Library.
FDMXEntityFixtureTypeConstructionParams Parameters to construct a Fixture Type.
FDMXEntityFixtureTypeRef Represents a Fixture Type from a DMX Library.
FDMXEntityReference Represents an Entity from a DMX Library.
FDMXFixtureCellAttribute  
FDMXFixtureFunction  
FDMXFixtureFunctionChannel  
FDMXFixtureMatrix  
FDMXFixtureMode  
FDMXFixturePatchChannel  
FDMXLibraryPortReferences Custom struct of in put and output port references for custom details customization with an enabled state
FDMXMVRFixtureAddresses The container for DMX Addresses for this fixture.
FDMXMVRFixtureGobo The Gobo used for the fixture. The image ressource must apply to the GDTF standard.
FDMXMVRFixtureMapping Defines a Mapping
FDMXMVRGeneralSceneDescriptionWorldParams  
FDMXMVRSceneFixtureTypeToActorClassPair  
FDMXMVRSceneGDTFToActorClassPair  
FDMXMVRVersion Version of the MVR standard currently being used by the engine
FDMXNormalizedAttributeValueMap Holds an array Attribute Names with their normalized Values (expand the property to see the map)
FDMXOptionalBool  
FDMXOptionalColorCIE1931  
FDMXOptionalFloat  
FDMXOptionalGuid  
FDMXOptionalInt32  
FDMXOptionalMVRFixtureGobo  
FDMXOptionalString  
FDMXOptionalTransform  
FDMXOptionalVector2D  
FDMXRawArtNetRequest  
FDMXRawSACN  
FDMXRequest  
FDMXRequestBase  
FLogCategoryLogDMXRuntime  
FMovieSceneDMXLibraryTemplate Template that performs evaluation of Fixture Patch sections

Typedefs

Name Type Remarks Include Path
FDataTypeChangeDelegate TMulticastDelegate_TwoParams< void, const UDMXEntityFixtureType *, const FDMXFixtureMode & > Notification when data type changed Library/DMXEntityFixtureType.h
FDMXColorCIE1931xyY FDMXGDTFColorCIE1931xyY   DMXTypes.h
FDMXOnDMXLibraryAssetDelegate TMulticastDelegate_OneParam< void, UDMXLibrary * >   DMXSubsystem.h
FDMXOnEntityArrayChangedDelegate TMulticastDelegate_TwoParams< void, class UDMXLibrary *, TArray< UDMXEntity * > >   Library/DMXLibrary.h
FDMXOnFixturePatchChangedDelegate TMulticastDelegate_OneParam< void, const UDMXEntityFixturePatch * >   Library/DMXEntityFixturePatch.h
FDMXOnFixtureTypeChangedDelegate TMulticastDelegate_OneParam< void, const UDMXEntityFixtureType * >   Library/DMXEntityFixtureType.h
FOnEntitiesUpdated_DEPRECATED TMulticastDelegate_OneParam< void, class UDMXLibrary * > DEPRECATED 5.0 Library/DMXLibrary.h

Enums

Public

Name Remarks
EDMXPixelMappingDistribution  

Constants

Name Type Remarks Include Path
LogDMXRuntime FLogCategoryLogDMXRuntime   DMXRuntimeLog.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActivationGroup PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXImportGDTFActivationGroup   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Attribute PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXImportGDTFAttribute   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Axis PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FDMXImportGDTFTypeAxis >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
BeamAngle float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
BeamRadius float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Beams PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FDMXImportGDTFBeam >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
BeamType PRAGMA_DISABLE_DEPRECATION_WARNINGS EDMXImportGDTFBeamType   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Blue FDMXColorCIE   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Breaks PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FDMXImportGDTFBreak >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
ChannelFunction PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXImportGDTFChannelFunction   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
ChannelSets TArray< FDMXImportGDTFChannelSet >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Color FDMXColorCIE   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
ColorRenderingIndex uint8   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
ColorTemperature float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Default PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXImportGDTFDMXValue   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
Description FString   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
DiodePart FString   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
DMXBreak uint8   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
DMXChangeTimeLimit float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
DMXChannels PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FDMXImportGDTFDMXChannel >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
DMXFrom PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXImportGDTFDMXValue   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
DMXInvert EDMXImportGDTFDMXInvert   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
DMXValue FDMXImportGDTFDMXValue   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
DominantWaveLength float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Emitter FDMXImportGDTFEmitter   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Energy float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Feature FDMXImportGDTFFeature   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Features PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FDMXImportGDTFFeature >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
FieldAngle float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Filter FDMXImportGDTFFilter   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
FilterBeam FDMXImportGDTFFilterBeam   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
FilterColor FDMXImportGDTFFilterColor   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
FilterGobo FDMXImportGDTFFilterGobo   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
FilterShaper FDMXImportGDTFFilterShaper   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Follower FString   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
FTMacros TArray< FDMXImportGDTFFTMacro >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
Geometry FDMXImportGDTFTypeGeometry   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
GeometryReference FDMXImportGDTFGeometryReference   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Green FDMXColorCIE   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Height float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Highlight FDMXImportGDTFDMXValue   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
InterpolationTo PRAGMA_DISABLE_DEPRECATION_WARNINGS EDMXImportGDTFInterpolationTo   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
LampType PRAGMA_DISABLE_DEPRECATION_WARNINGS EDMXImportGDTFLampType   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Length float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
LogicalChannel PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXImportGDTFLogicalChannel   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
LuminousFlux float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
LuminousIntensity float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
MainAttribute FString   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Master EDMXImportGDTFMaster   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Measurement PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXImportGDTFMeasurement   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
MeasurementPoints TArray< FDMXImportGDTFMeasurementPoint >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
MediaFileName TObjectPtr< UTexture2D >   Library/DMXImportGDTF.h
  • VisibleAnywhere
  • Category="Fixture Type"
MibFade float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
ModeFrom PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXImportGDTFDMXValue   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Model FName   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
ModeMaster FString   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
ModeTo FDMXImportGDTFDMXValue   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Offset TArray< int32 >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
OriginalAttribute FString   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
PhysicalFrom float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
PhysicalTo float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
PhysicalUnit EDMXImportGDTFPhysicalUnit   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Position FMatrix   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
PowerConsumption float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Pretty FString   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
PrimitiveType PRAGMA_DISABLE_DEPRECATION_WARNINGS EDMXImportGDTFPrimitiveType   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
RealFade float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Red PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXColorCIE   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Relations TArray< FDMXImportGDTFRelation >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
Slots PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FDMXImportGDTFWheelSlot >   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Snap EDMXImportGDTFSnap   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Transmission float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Type PRAGMA_DISABLE_DEPRECATION_WARNINGS EDMXImportGDTFType   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
Value int32   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
ValueSize uint8   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • BlueprintReadOnly
  • Category="DMX"
Wheel PRAGMA_DISABLE_DEPRECATION_WARNINGS FDMXImportGDTFWheel   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
WheelSlotIndex int32   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
WhitePoint FDMXColorCIE   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Width float   Library/DMXImportGDTF.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="DMX"
Y float   Library/DMXImport.h
  • EditAnywhere
  • Category=Color
  • Meta=(ClampMin="0", ClampMax="1.0")
YY uint8   Library/DMXImport.h
  • EditAnywhere
  • Category=Color
  • Meta=(ClampMin="0", ClampMax="255")

Functions

Public

Name Remarks Include Path Unreal Specifiers

FDMXColorCIE UE::DMX::DMXImport::Private::ParseColorCIE ( const FString& InColor
)

   Library/DMXImport.h  

FMatrix UE::DMX::DMXImport::Private::ParseMatrix ( FString&& InMatrixStr
)

   Library/DMXImport.h  

Static

Name Remarks Include Path Unreal Specifiers

static EnumType UE::DMX::DMXImport::Private::GetEnumValueFromString ( const FString& String
)

   Library/DMXImport.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page