FStaticMeshInstanceBuffer

A vertex buffer of positions.

Windows
MacOS
Linux

Inheritance Hierarchy

FRenderResource

FStaticMeshInstanceBuffer

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/InstancedStaticMesh.h

Include

#include "Engine/InstancedStaticMesh.h"

Syntax

class FStaticMeshInstanceBuffer : public FRenderResource

Remarks

A vertex buffer of positions.

Variables

Name Description

Public variable

TSharedPtr< FSt...

 

InstanceData

The vertex data storage type

Public variable

bool

 

RequireCPUAccess

Keep CPU copy of instance data

Constructors

Name Description

Public function

FStaticMeshInstanceBuffer

(
    ERHIFeatureLevel::Type InFeatureLev...,
    bool InRequireCPUAccess
)

Default constructor.

Destructors

Name Description

Public function

~FStaticMeshInstanceBuffer()

Destructor.

Functions

Name Description

Public function Const

void

 

BindInstanceVertexBuffer

(
    const FVertexFactory* VertexFa...,
    FInstancedStaticMeshDataType& Inst...
)

Public function Const

void

 

GetInstanceCustomDataValues

(
    int32 InstanceIndex,
    TArray< float >& InstanceCustomDat...
)

Public function Const

FStaticMeshI...

 

GetInstanceData()

Public function

FVertexBuffe...

 

GetInstanceLightmapBuffer()

Public function

FVertexBuffe...

 

GetInstanceOriginBuffer()

Public function Const

void

 

GetInstanceShaderValues

(
    int32 InstanceIndex,
    FVector4 InstanceTransform,
    FVector4& InstanceLightmapAndShado...,
    FVector4& InstanceOrigin
)

Public function Const

void

 

GetInstanceTransform

(
    int32 InstanceIndex,
    FMatrix& Transform
)

Public function

FVertexBuffe...

 

GetInstanceTransformBuffer()

Public function Const

uint32

 

GetNumInstances()

Other accessors.

Public function Const

SIZE_T

 

GetResourceSize()

Public function

void

 

InitFromPreallocatedData

(
    FStaticMeshInstanceData& Other
)

Initializes the buffer with the component's data.

Public function

void

 

UpdateFromCommandBuffer_Concurrent

(
    FInstanceUpdateCmdBuffer& CmdBuffe...
)

Overridden from FRenderResource

Name Description

Public function Virtual Const

FString

 

GetFriendlyName()

Public function Virtual

void

 

InitResource()

Initializes the resource. This is only called by the rendering thread.

Public function Virtual

void

 

InitRHI()

Initializes the RHI resources used by this resource.

Public function Virtual

void

 

ReleaseResource()

Prepares the resource for deletion. This is only called by the rendering thread.

Public function Virtual

void

 

ReleaseRHI()

Releases the RHI resources used by this resource.

Operators

Name Description

Public function

void

 

operator=

(
    const FStaticMeshInstanceBuffer& O...
)

Specialized assignment operator, only used when importing LOD's.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss