UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | List of all members
FStaticMeshInstanceData Class Reference

#include <StaticMeshResources.h>

Public Member Functions

 FStaticMeshInstanceData ()
 
 FStaticMeshInstanceData (bool bInUseHalfFloat)
 
 ~FStaticMeshInstanceData ()
 
void Serialize (FArchive &Ar)
 
void AllocateInstances (int32 InNumInstances, int32 InNumCustomDataFloats, EResizeBufferFlags BufferFlags, bool DestroyExistingInstances)
 
int32 IsValidIndex (int32 Index) const
 
void GetInstanceTransform (int32 InstanceIndex, FRenderTransform &Transform) const
 
void GetInstanceRandomID (int32 InstanceIndex, float &RandomInstanceID) const
 
void GetInstanceLightMapData (int32 InstanceIndex, FVector4f &InstanceLightmapAndShadowMapUVBias) const
 
void GetInstanceCustomDataValues (int32 InstanceIndex, TArrayView< float > OutCustomData) const
 
void SetInstance (int32 InstanceIndex, const FMatrix44f &Transform, float RandomInstanceID, const FVector2D &LightmapUVBias, const FVector2D &ShadowmapUVBias)
 
void SetInstance (int32 InstanceIndex, const FMatrix44f &Transform, float RandomInstanceID)
 
void SetInstance (int32 InstanceIndex, const FMatrix44f &Transform, const FVector2D &LightmapUVBias, const FVector2D &ShadowmapUVBias)
 
void SetInstance (int32 InstanceIndex, const FMatrix44f &Transform)
 
void SetInstanceLightMapData (int32 InstanceIndex, const FVector2D &LightmapUVBias, const FVector2D &ShadowmapUVBias)
 
void SetInstanceCustomData (int32 InstanceIndex, int32 Index, float CustomData)
 
void NullifyInstance (int32 InstanceIndex)
 
void SetInstanceEditorData (int32 InstanceIndex, FColor HitProxyColor, bool bSelected)
 
void ClearInstanceEditorData (int32 InstanceIndex)
 
void SwapInstance (int32 Index1, int32 Index2)
 
int32 GetNumInstances () const
 
int32 GetNumCustomDataFloats () const
 
void SetAllowCPUAccess (bool InNeedsCPUAccess)
 
bool GetTranslationUsesHalfs () const
 
FResourceArrayInterface * GetOriginResourceArray ()
 
FResourceArrayInterface * GetTransformResourceArray ()
 
FResourceArrayInterface * GetLightMapResourceArray ()
 
FResourceArrayInterface * GetCustomDataResourceArray ()
 
uint32 GetOriginStride ()
 
uint32 GetTransformStride ()
 
uint32 GetLightMapStride ()
 
uint32 GetCustomDataStride ()
 
SIZE_T GetResourceSize () const
 

Detailed Description

The implementation of the static mesh instance data storage type.

Constructor & Destructor Documentation

◆ FStaticMeshInstanceData() [1/2]

FStaticMeshInstanceData::FStaticMeshInstanceData ( )
inline

◆ FStaticMeshInstanceData() [2/2]

FStaticMeshInstanceData::FStaticMeshInstanceData ( bool  bInUseHalfFloat)
inline

Constructor

Parameters
bInUseHalfFloat- true if device has support for half float in vertex arrays

◆ ~FStaticMeshInstanceData()

FStaticMeshInstanceData::~FStaticMeshInstanceData ( )
inline

Member Function Documentation

◆ AllocateInstances()

void FStaticMeshInstanceData::AllocateInstances ( int32  InNumInstances,
int32  InNumCustomDataFloats,
EResizeBufferFlags  BufferFlags,
bool  DestroyExistingInstances 
)
inline

◆ ClearInstanceEditorData()

void FStaticMeshInstanceData::ClearInstanceEditorData ( int32  InstanceIndex)
inline

◆ GetCustomDataResourceArray()

FResourceArrayInterface * FStaticMeshInstanceData::GetCustomDataResourceArray ( )
inline

◆ GetCustomDataStride()

uint32 FStaticMeshInstanceData::GetCustomDataStride ( )
inline

◆ GetInstanceCustomDataValues()

void FStaticMeshInstanceData::GetInstanceCustomDataValues ( int32  InstanceIndex,
TArrayView< float >  OutCustomData 
) const
inline

◆ GetInstanceLightMapData()

void FStaticMeshInstanceData::GetInstanceLightMapData ( int32  InstanceIndex,
FVector4f &  InstanceLightmapAndShadowMapUVBias 
) const
inline

◆ GetInstanceRandomID()

void FStaticMeshInstanceData::GetInstanceRandomID ( int32  InstanceIndex,
float &  RandomInstanceID 
) const
inline

◆ GetInstanceTransform()

void FStaticMeshInstanceData::GetInstanceTransform ( int32  InstanceIndex,
FRenderTransform &  Transform 
) const
inline

◆ GetLightMapResourceArray()

FResourceArrayInterface * FStaticMeshInstanceData::GetLightMapResourceArray ( )
inline

◆ GetLightMapStride()

uint32 FStaticMeshInstanceData::GetLightMapStride ( )
inline

◆ GetNumCustomDataFloats()

int32 FStaticMeshInstanceData::GetNumCustomDataFloats ( ) const
inline

◆ GetNumInstances()

int32 FStaticMeshInstanceData::GetNumInstances ( ) const
inline

◆ GetOriginResourceArray()

FResourceArrayInterface * FStaticMeshInstanceData::GetOriginResourceArray ( )
inline

◆ GetOriginStride()

uint32 FStaticMeshInstanceData::GetOriginStride ( )
inline

◆ GetResourceSize()

SIZE_T FStaticMeshInstanceData::GetResourceSize ( ) const
inline

◆ GetTransformResourceArray()

FResourceArrayInterface * FStaticMeshInstanceData::GetTransformResourceArray ( )
inline

◆ GetTransformStride()

uint32 FStaticMeshInstanceData::GetTransformStride ( )
inline

◆ GetTranslationUsesHalfs()

bool FStaticMeshInstanceData::GetTranslationUsesHalfs ( ) const
inline

◆ IsValidIndex()

int32 FStaticMeshInstanceData::IsValidIndex ( int32  Index) const
inline

◆ NullifyInstance()

void FStaticMeshInstanceData::NullifyInstance ( int32  InstanceIndex)
inline

◆ Serialize()

void FStaticMeshInstanceData::Serialize ( FArchive &  Ar)

◆ SetAllowCPUAccess()

void FStaticMeshInstanceData::SetAllowCPUAccess ( bool  InNeedsCPUAccess)
inline

◆ SetInstance() [1/4]

void FStaticMeshInstanceData::SetInstance ( int32  InstanceIndex,
const FMatrix44f &  Transform 
)
inline

◆ SetInstance() [2/4]

void FStaticMeshInstanceData::SetInstance ( int32  InstanceIndex,
const FMatrix44f &  Transform,
const FVector2D &  LightmapUVBias,
const FVector2D &  ShadowmapUVBias 
)
inline

◆ SetInstance() [3/4]

void FStaticMeshInstanceData::SetInstance ( int32  InstanceIndex,
const FMatrix44f &  Transform,
float  RandomInstanceID 
)
inline

◆ SetInstance() [4/4]

void FStaticMeshInstanceData::SetInstance ( int32  InstanceIndex,
const FMatrix44f &  Transform,
float  RandomInstanceID,
const FVector2D &  LightmapUVBias,
const FVector2D &  ShadowmapUVBias 
)
inline

◆ SetInstanceCustomData()

void FStaticMeshInstanceData::SetInstanceCustomData ( int32  InstanceIndex,
int32  Index,
float  CustomData 
)
inline

◆ SetInstanceEditorData()

void FStaticMeshInstanceData::SetInstanceEditorData ( int32  InstanceIndex,
FColor  HitProxyColor,
bool  bSelected 
)
inline

◆ SetInstanceLightMapData()

void FStaticMeshInstanceData::SetInstanceLightMapData ( int32  InstanceIndex,
const FVector2D &  LightmapUVBias,
const FVector2D &  ShadowmapUVBias 
)
inline

◆ SwapInstance()

void FStaticMeshInstanceData::SwapInstance ( int32  Index1,
int32  Index2 
)
inline
The documentation for this class was generated from the following files: