FGCReferenceTokenStream

Reference token stream class. Used for creating and parsing stream of object references.

Windows
MacOS
Linux

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/UObject/GarbageCollection.h

Include

#include "UObject/GarbageCollection.h"

Syntax

struct FGCReferenceTokenStream

Remarks

Reference token stream class. Used for creating and parsing stream of object references.

Constructors

Name Description

Public function

FGCReferenceTokenStream()

Constructor

Functions

Name Description

Public function Const

FGCReference...

 

AccessReferenceInfo

(
    uint32 CurrentIndex
)

Access reference info at passed in index. Used as helper to eliminate LHS.

Public function

int32

 

EmitCount

(
    uint32 Count
)

Emit count

Public function

int32

 

EmitPointer

(
    void const* Ptr
)

Emit a pointer

Public function

int32

 

EmitReferenceInfo

(
    FGCReferenceInfo ReferenceInfo,
    const FName& DebugName
)

Emit reference info.

Public function

uint32

 

EmitReturn()

Increase return count on last token.

Public function

uint32

 

EmitSkipIndexPlaceholder()

Emit placeholder for aray skip index, updated in UpdateSkipIndexPlaceholder

Public function

int32

 

EmitStride

(
    uint32 Stride
)

Emit stride

Public function

void

 

Empty()

Empties the token stream entirely

Public function

bool

 

EndOfStream

(
    uint32 CurrentIndex
)

Queries the stream for an end of stream condition

Public function

void

 

Fixup

(
    void*, class FR...,
    bool bKeepOuterToken,
    bool bKeepClassToken
)

Helper function to perform post parent token stream prepend fixup

Public function

uint32

 

GetSkipReturnCount

(
    FGCSkipInfo SkipInfo
)

Read return count stored at the index before the skip index.

Public function Const

FTokenInfo

 

GetTokenInfo

(
    int32 TokenIndex
)

Public function Const

bool

 

IsEmpty()

Return true if this is empty

Public function

void

 

PrependStream

(
    const FGCReferenceTokenStream& Oth...
)

Prepends passed in stream to existing one.

Public function

uint32

 

ReadCount

(
    uint32& CurrentIndex
)

Reads count and advances stream.

Public function

void *

 

ReadPointer

(
    uint32& CurrentIndex
)

Reads pointer and advance stream

Public function

FGCReference...

 

ReadReferenceInfo

(
    uint32& CurrentIndex
)

Reads in reference info and advances stream.

Public function

FGCSkipInfo

 

ReadSkipInfo

(
    uint32& CurrentIndex
)

Read in skip index and advances stream.

Public function

uint32

 

ReadStride

(
    uint32& CurrentIndex
)

Reads stride and advances stream.

Public function

void

 

Shrink()

Shrinks the token stream, removing array slack.

Public function Const

int32

 

Size()

Returns the size ofthe reference token stream.

Public function

void

 

UpdateSkipIndexPlaceholder

(
    uint32 SkipIndexIndex,
    uint32 SkipIndex
)

Updates skip index place holder stored and passed in skip index index with passed in skip index.

Enums

Name

Description

Public enum

EGCArrayInfoPlaceholder

Initialization value to ensure that we have the right skip index index
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss