Navigation
API > API/Runtime > API/Runtime/Engine
| Name | FStaticMeshInstanceBuffer |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/InstancedStaticMesh.h |
| Include Path | #include "Engine/InstancedStaticMesh.h" |
Syntax
class FStaticMeshInstanceBuffer : public FRenderResource
Inheritance Hierarchy
- FRenderResource → FStaticMeshInstanceBuffer
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStaticMeshInstanceBuffer
(
ERHIFeatureLevel::Type InFeatureLevel, |
Default constructor. | Engine/InstancedStaticMesh.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FStaticMeshInstanceBuffer() |
Destructor. | Engine/InstancedStaticMesh.h |
Classes
| Name | Remarks |
|---|---|
| FInstanceCustomDataBuffer | |
| FInstanceLightmapBuffer | |
| FInstanceOriginBuffer | |
| FInstanceTransformBuffer |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InstanceData | TSharedPtr< FStaticMeshInstanceData, ESPMode::ThreadSafe > | The vertex data storage type | Engine/InstancedStaticMesh.h | |
| RequireCPUAccess | bool | Keep CPU copy of instance data | Engine/InstancedStaticMesh.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bFlushToGPUPending | bool | If true, then we have updates to the host data not yet committed to the GPU. | Engine/InstancedStaticMesh.h | |
| InstanceCustomDataBuffer | FStaticMeshInstanceBuffer::FInstanceCustomDataBuffer | Engine/InstancedStaticMesh.h | ||
| InstanceCustomDataSRV | FShaderResourceViewRHIRef | Engine/InstancedStaticMesh.h | ||
| InstanceLightmapBuffer | FStaticMeshInstanceBuffer::FInstanceLightmapBuffer | Engine/InstancedStaticMesh.h | ||
| InstanceLightmapSRV | FShaderResourceViewRHIRef | Engine/InstancedStaticMesh.h | ||
| InstanceOriginBuffer | FStaticMeshInstanceBuffer::FInstanceOriginBuffer | Engine/InstancedStaticMesh.h | ||
| InstanceOriginSRV | FShaderResourceViewRHIRef | Engine/InstancedStaticMesh.h | ||
| InstanceTransformBuffer | FStaticMeshInstanceBuffer::FInstanceTransformBuffer | Engine/InstancedStaticMesh.h | ||
| InstanceTransformSRV | FShaderResourceViewRHIRef | Engine/InstancedStaticMesh.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BindInstanceVertexBuffer
(
const FVertexFactory* VertexFactory, |
Engine/InstancedStaticMesh.h | ||
void FlushGPUUpload
(
FRHICommandListBase& RHICmdList |
Call to flush any pending GPU data copies, if bFlushToGPUPending is false it does nothing. | Engine/InstancedStaticMesh.h | |
void GetInstanceCustomDataValues
(
int32 InstanceIndex, |
Engine/InstancedStaticMesh.h | ||
FStaticMeshInstanceData * GetInstanceData() |
Engine/InstancedStaticMesh.h | ||
void GetInstanceEditorData
(
int32 InstanceIndex, |
Engine/InstancedStaticMesh.h | ||
FBufferRHIRef GetInstanceLightmapBuffer() |
Engine/InstancedStaticMesh.h | ||
void GetInstanceLightMapData
(
int32 InstanceIndex, |
Engine/InstancedStaticMesh.h | ||
FBufferRHIRef GetInstanceOriginBuffer() |
Engine/InstancedStaticMesh.h | ||
void GetInstanceRandomID
(
int32 InstanceIndex, |
Engine/InstancedStaticMesh.h | ||
void GetInstanceTransform
(
int32 InstanceIndex, |
Engine/InstancedStaticMesh.h | ||
FBufferRHIRef GetInstanceTransformBuffer() |
Engine/InstancedStaticMesh.h | ||
uint32 GetNumInstances() |
Other accessors. | Engine/InstancedStaticMesh.h | |
SIZE_T GetResourceSize() |
Engine/InstancedStaticMesh.h | ||
void InitFromPreallocatedData
(
FStaticMeshInstanceData& Other |
Initializes the buffer with the component's data. | Engine/InstancedStaticMesh.h | |
void SetFlushToGPUPending() |
Set flush to GPU as pending. | Engine/InstancedStaticMesh.h |
Overridden from FRenderResource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetFriendlyName() |
Engine/InstancedStaticMesh.h | ||
virtual void InitResource
(
FRHICommandListBase& RHICmdList |
Engine/InstancedStaticMesh.h | ||
virtual void InitRHI
(
FRHICommandListBase& RHICmdList |
Engine/InstancedStaticMesh.h | ||
virtual void ReleaseResource() |
Engine/InstancedStaticMesh.h | ||
virtual void ReleaseRHI() |
Engine/InstancedStaticMesh.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void operator=
(
const FStaticMeshInstanceBuffer& Other |
Specialized assignment operator, only used when importing LOD's. | Engine/InstancedStaticMesh.h |