Navigation
API > API/Plugins > API/Plugins/DMXGDTF
Special type to define DMX value where n is the byte count. The byte count can be individually specified without depending on the resolution of the DMX Channel. By default byte mirroring is used for the conversion. So 255/1 in a 16 bit channel will result in 65535. You can use the byte shifting operator to use byte shifting for the conversion. So 255/1s in a 16 bit channel will result in 65280.
| Name | FDMXGDTFDMXValue |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/DMX/DMXGDTF/Source/DMXGDTF/Public/GDTF/DMXModes/DMXGDTFDMXValue.h |
| Include Path | #include "GDTF/DMXModes/DMXGDTFDMXValue.h" |
Syntax
struct FDMXGDTFDMXValue
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| GDTF/DMXModes/DMXGDTFDMXValue.h | |||
FDMXGDTFDMXValue
(
const TCHAR* InValue |
GDTF/DMXModes/DMXGDTFDMXValue.h | ||
FDMXGDTFDMXValue
(
const uint32 InValue, |
GDTF/DMXModes/DMXGDTFDMXValue.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bByteMirroring | bool | Whether to use byte mirroring or byte shifting when accessing the DMX value | GDTF/DMXModes/DMXGDTFDMXValue.h | |
| NumBytes | uint8 | The number of bytes of this DMX value | GDTF/DMXModes/DMXGDTFDMXValue.h | |
| Value | uint32 | The DMX Value | GDTF/DMXModes/DMXGDTFDMXValue.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString AsString() |
Returns the DMX value as string. If the DMX value is not set, returns 0/1. | GDTF/DMXModes/DMXGDTFDMXValue.h | |
bool Get
(
const TSharedRef< FDMXGDTFDMXChannel >& InDMXChannel, |
Gets the DMX value in the resolution of the specified DMX channel. | GDTF/DMXModes/DMXGDTFDMXValue.h | |
uint32 GetChecked
(
const TSharedRef< FDMXGDTFDMXChannel >& InDMXChannel |
Gets the DMX value in the resolution of the specified DMX channel, only valid when not IsSet (checked). | GDTF/DMXModes/DMXGDTFDMXValue.h | |
bool IsSet() |
Returns true if the DMX Value is set. | GDTF/DMXModes/DMXGDTFDMXValue.h | |
void Reset() |
Resets the DMX value | GDTF/DMXModes/DMXGDTFDMXValue.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FDMXGDTFDMXValue& Other |
GDTF/DMXModes/DMXGDTFDMXValue.h | ||
bool operator==
(
const FDMXGDTFDMXValue& Other |
GDTF/DMXModes/DMXGDTFDMXValue.h |