FRigVMOperand

The [FRigVMOperand](API\Runtime\RigVM\RigVMCore\FRigVMOperand) represents an argument used for an operator within the virtual machine.

Choose your operating system:

Windows

macOS

Linux

References

Module

RigVM

Header

/Engine/Source/Runtime/RigVM/Public/RigVMCore/RigVMMemoryCommon.h

Include

#include "RigVMCore/RigVMMemoryCommon.h"

Syntax

struct FRigVMOperand

Remarks

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.

Constructors

Name Description

Public function

FRigVMOperand()

Public function

FRigVMOperand

(
    ERigVMMemoryType InMemoryType,
    int32 InRegisterIndex,
    int32 InRegisterOffset
)

Functions

Name Description

Public function Const

int32

 

GetContainerIndex()

Returns the index of the container of this argument this function should be kept in sync with URigVM::GetContainerIndex()

Public function Const

ERigVMMemory...

 

GetMemoryType()

Returns the memory type of this argument

Public function Const

int32

 

GetRegisterIndex()

Returns the index of the register of this argument

Public function Const

int32

 

GetRegisterOffset()

Returns the register offset of this argument

Public function Const

bool

 

IsValid()

Returns the memory type of this argument

Public function

void

 

Load

(
    FArchive& Ar
)

Public function Const

void

 

Save

(
    FArchive& Ar
)

Public function

void

 

Serialize

(
    FArchive& Ar
)

Operators

Name Description

Public function Const

bool

 

operator!=

(
    const FRigVMOperand& InOther
)

Public function Const

bool

 

operator==

(
    const FRigVMOperand& InOther
)