Navigation
API > API/Plugins > API/Plugins/RigVM
The FRigVMOperand represents an argument used for an operator within the virtual machine. Operands provide information about which memory needs to be referred to, which register within the memory all the way to the actual byte address in memory. The FRigVMOperand is a light weight address for a register in a FRigVMMemoryContainer. For external variables the register index represents the index of the external variable within the running VM.
| Name | FRigVMOperand |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMMemoryCommon.h |
| Include Path | #include "RigVMCore/RigVMMemoryCommon.h" |
Syntax
USTRUCT ()
struct FRigVMOperand
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| RigVMCore/RigVMMemoryCommon.h | |||
FRigVMOperand
(
ERigVMMemoryType InMemoryType, |
RigVMCore/RigVMMemoryCommon.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MemoryType | ERigVMMemoryType | RigVMCore/RigVMMemoryCommon.h | ||
| RegisterIndex | uint16 | The index of the register inside of the specific type of memory (work, literal etc). | RigVMCore/RigVMMemoryCommon.h | |
| RegisterOffset | uint16 | RigVMCore/RigVMMemoryCommon.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetContainerIndex() |
Returns the index of the container of this argument this function should be kept in sync with URigVM::GetContainerIndex() | RigVMCore/RigVMMemoryCommon.h | |
ERigVMMemoryType GetMemoryType() |
Returns the memory type of this argument | RigVMCore/RigVMMemoryCommon.h | |
int32 GetRegisterIndex() |
Returns the index of the register of this argument | RigVMCore/RigVMMemoryCommon.h | |
int32 GetRegisterOffset() |
Returns the register offset of this argument | RigVMCore/RigVMMemoryCommon.h | |
bool IsValid() |
Returns the memory type of this argument | RigVMCore/RigVMMemoryCommon.h | |
void Serialize
(
FArchive& Ar |
RigVMCore/RigVMMemoryCommon.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void ZeroPaddedMemoryIfNeeded
(
FRigVMOperand* InOperand |
RigVMCore/RigVMMemoryCommon.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FRigVMOperand& InOther |
RigVMCore/RigVMMemoryCommon.h | ||
bool operator==
(
const FRigVMOperand& InOther |
RigVMCore/RigVMMemoryCommon.h |