RigVMCore

Choose your operating system:

Windows

macOS

Linux

Classes

Name

Description

Public struct

CRigVMUClass

Public struct

CRigVMUStruct

Public struct

FRigVMBaseOp

Base class for all VM operations.

Public struct

FRigVMBinaryOp

Operator used for beginblock and array reset

Public struct

FRigVMBreakpoint

Public struct

FRigVMByteCode

The FRigVMByteCode is a container to store a list of instructions with their corresponding data.

Public struct

FRigVMByteCodeEntry

Public struct

FRigVMByteCodeStatistics

Public struct

FRigVMChangeTypeOp

Change the type of a register

Public struct

FRigVMComparisonOp

Used for equals and not equals comparisons

Public struct

FRigVMCopyOp

Copy the content of one register to another

Public struct

FRigVMDebugInfo

Public struct

FRigVMExecuteContext

The execute context is used for mutable nodes to indicate execution order.

Public struct

FRigVMExecuteOp

Execute a function

Public struct

FRigVMExternalVariable

The external variable can be used to map external / unowned memory into the VM and back out

Public struct

FRigVMFunction

The FRigVMFunction is used to represent a function pointer generated by UHT for a given name.

Public struct

FRigVMInstruction

The FRigVMInstruction represents a single instruction within the VM.

Public struct

FRigVMInstructionArray

The FRigVMInstructionArray represents all current instructions within a RigVM and can be used to iterate over all operators and retrieve each instruction's data.

Public struct

FRigVMJumpIfOp

Jump to a new instruction index based on a condition.

Public struct

FRigVMJumpOp

Jump to a new instruction index.

Public struct

FRigVMMemoryContainer

The FRigVMMemoryContainer provides a heterogeneous memory container to store arbitrary data.

Public struct

FRigVMMemoryHandle

The FRigVMMemoryHandle is used to access the memory used within a URigMemoryStorage.

Public struct

FRigVMMemoryStatistics

Public struct

FRigVMOperand

The FRigVMOperand represents an argument used for an operator within the virtual machine.

Public struct

FRigVMParameter

The RigVMParameter define an input or output of the RigVM.

Public struct

FRigVMPropertyDescription

Property Management.

Public class

FRigVMPropertyPath

The RigVMPropertyPath is used to access a memory pointer for a tail property given the memory of the head property.

Public struct

FRigVMPropertyPathDescription

The RigVMPropertyPathDescription is used to provide all of the information necessary to describe a property path for creating it.

Public struct

FRigVMPropertyPathSegment

The RigVMPropertyPathSegment represents a single step needed to go from the head property of a property path to the tail.

Public struct

FRigVMPrototype

The Prototype is used to group multiple rigvm functions that share the same notation.

Public struct

FRigVMPrototypeArg

The Prototype argument represents a single parameter in a function call and all of its possible types

Public struct

FRigVMQuaternaryOp

Operator used for some array operations

Public struct

FRigVMQuinaryOp

Operator used for some array operations

Public struct

FRigVMRegister

The register represents an address with the VM's memory.

Public struct

FRigVMRegisterOffset

The register offset represents a memory offset within a register's memory.

Public struct

FRigVMRegistry

The FRigVMRegistry is used to manage all known function pointers for use in the RigVM.

Public struct

FRigVMRuntimeSettings

Public struct

FRigVMSenaryOp

Operator used for some array operations

Public struct

FRigVMSlice

Public struct

FRigVMStatistics

Public struct

FRigVMStruct

The base class for all RigVM enabled structs.

Public struct

FRigVMTernaryOp

Operator used for some array operations

Public struct

FRigVMUnaryOp

Operator used for zero, false, true, increment, decrement

Public struct

FRigVMUnitNodeCreatedContext

A context struct passed to FRigVMStruct::OnUnitNodeCreated

Public struct

FRigVMUnknownType

The unknown type is used to identify untyped nodes

Public struct

TRigVMIsBaseStructure

Public struct

TRigVMIsName

Public struct

TRigVMIsString

Public class

URigVM

The RigVM is the main object for evaluating FRigVMByteCode instructions.

Public class

URigVMMemoryStorage

The URigVMMemoryStorage represents an instance of heterogeneous memory.

Public class

URigVMMemoryStorageGeneratorClass

The URigVMMemoryStorageGeneratorClass is used to create / represent heterogeneous memory storages.

Typedefs

Enums

Name

Description

Public enum

ERigVMBreakpointAction

Possible actions when the VM is halted at a breakpoint.

Public enum

ERigVMCopyType

The kind of copy operation to perform.

Public enum

ERigVMMemoryType

The ERigVMMemoryType maps to memory container index in RigVM through FRigVMOperand::GetContainerIndex() or URigVM::GetContainerIndex(...) The type of memory used.

Public enum

ERigVMNodeCreatedReason

Context as of why the node was created

Public enum

ERigVMOpCode

The code for a single operation within the RigVM.

Public enum

ERigVMParameterType

The type of parameter for a VM.

Public enum

ERigVMPinDirection

The Pin Direction is used to differentiate different kinds of pins in the data flow graph - inputs, outputs etc.

Public enum

ERigVMPropertyPathSegmentType

The RigVMPropertyPathSegmentType is used to differentiate segments under a property path.

Public enum

ERigVMRegisterType

The type of register within the memory.

Functions

Name Description

Public function

void

 

RigVMCopy

(
    void* InTargetPtr,
    const void* InSourcePtr,
    int32 InCount
)

Public function

void

 

RigVMDestroy

(
    void* InPtr,
    int32 InCount
)

Public function

void

 

RigVMInitialize

(
    void* InPtr,
    int32 InCount
)