FRawStaticIndexBuffer

Windows
MacOS
Linux

Inheritance Hierarchy

FRenderResource

FIndexBuffer

FRawStaticIndexBuffer

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/RawIndexBuffer.h

Include

#include "RawIndexBuffer.h"

Syntax

class FRawStaticIndexBuffer : public FIndexBuffer

Constructors

Name Description

Public function

FRawStaticIndexBuffer

(
    bool InNeedsCPUAccess
)

Initialization constructor.

Functions

Name Description

Public function Const

const uint16...

 

AccessStream16()

Get the direct read access to index data Only valid if NeedsCPUAccess = true and indices are 16 bit

Public function Const

const uint32...

 

AccessStream32()

Get the direct read access to index data Only valid if NeedsCPUAccess = true and indices are 32 bit

Public function

void

 

AppendIndices

(
    const uint32* IndicesToAppend,
    const uint32 NumIndicesToAppend
)

Append indices to the end of the buffer

Public function

void

 

CopyRHIForStreaming

(
    const FRawStaticIndexBuffer& Other,
    bool InAllowCPUAccess
)

Copy everything, keeping reference to the same RHI resources.

Public function

FIndexBuffer...

 

CreateRHIBuffer_Async()

Public function

FIndexBuffer...

 

CreateRHIBuffer_RenderThread()

Create an RHI index buffer with CPU data.

Public function

void

 

Discard()

Discard discards the serialized data when it is not needed

Public function

void

 

ExpandTo32Bit()

Expands the 16bit index buffer to 32bit

Public function Const

uint32

 

GetAllocatedSize()

Computes the amount of memory allocated to store the indices.

Public function Const

FIndexArrayV...

 

GetArrayView()

Retrieves an array view in to the index buffer.

Public function Const

void

 

GetCopy

(
    TArray< uint32 >& OutIndices
)

Retrieve a copy of the indices in this buffer.

Public function Const

uint32

 

GetIndex

(
    const uint32 At
)

Public function Const

int32

 

GetIndexDataSize()

== GetNumIndices() * (b32Bit ? 4 : 2)

Public function Const

int32

 

GetNumIndices()

Computes the number of indices stored in this buffer.

Public function

void

 

InitRHIForStreaming

(
    FRHIIndexBuffer* IntermediateB...,
    TRHIResourceUpdateBatcher< MaxNumUp...
)

Take over ownership of IntermediateBuffer

Public function

void

 

InsertIndices

(
    const uint32 At,
    const uint32* IndicesToAppend,
    const uint32 NumIndicesToAppend
)

Insert indices at the given position in the buffer

Public function Const

bool

 

Is32Bit()

Public function

void

 

ReleaseRHIForStreaming

(
    TRHIResourceUpdateBatcher< MaxNumUp...
)

Release any GPU resource owned by the RHI object

Public function

void

 

RemoveIndicesAt

(
    const uint32 At,
    const uint32 NumIndicesToRemove
)

Removes indices from the buffer

Public function

void

 

Serialize

(
    FArchive& Ar,
    bool bNeedsCPUAccess
)

Serialization.

Public function

void

 

SerializeMetaData

(
    FArchive& Ar
)

Serialize only meta data (e.g. number of indices) but not the actual index data

Public function

void

 

SetIndex

(
    const uint32 At,
    const uint32 NewIndexValue
)

Sets a single index value.

Public function

void

 

SetIndices

(
    const TArray< uint32 >& InIndices,
    EIndexBufferStride::Type DesiredStr...
)

Set the indices stored within this buffer.

Public function

bool

 

TrySetAllowCPUAccess

(
    bool bAllowCPUAccess
)

Copy everything, keeping reference to the same RHI resources.

Overridden from FRenderResource

Name Description

Public function Virtual

void

 

InitRHI()

Initializes the RHI resources used by this resource.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss