UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FParticleSimulationResources Class Reference

Public Member Functions

void Init ()
 
void Resize (FRHICommandListImmediate &RHICmdList)
 
void Release ()
 
void Destroy ()
 
FParticleStateTexturesGetCurrentStateTextures ()
 
FParticleStateTexturesGetPreviousStateTextures ()
 
FParticleStateTexturesGetVisualizeStateTextures ()
 
void Update (FRHICommandListImmediate &RHICmdList)
 
uint32 AllocateTile ()
 
void FreeTile (uint32 Tile)
 
int32 GetFreeTileCount () const
 
int32 GetAllocatedTileCount () const
 
bool SupportTileResizing () const
 

Public Attributes

FParticleStateTextures StateTextures [2]
 
FParticleAttributesTexture RenderAttributesTexture
 
FParticleAttributesTexture SimulationAttributesTexture
 
int32 FrameIndex = 0
 
FVector3f LWCTile = FVector3f::ZeroVector
 
FIntPoint SimulationResourcesSize = FIntPoint::ZeroValue
 
uint32 ParticleSimulationTileCountX = 0
 
uint32 ParticleSimulationTileCountY = 0
 
uint32 ParticleSimulationTileCount = 0
 

Detailed Description

Resources required for GPU particle simulation.

Member Function Documentation

◆ AllocateTile()

uint32 FParticleSimulationResources::AllocateTile ( )
inline

Allocate a particle tile.

◆ Destroy()

void FParticleSimulationResources::Destroy ( )
inline

Destroy resources.

◆ FreeTile()

void FParticleSimulationResources::FreeTile ( uint32  Tile)
inline

Free a particle tile.

◆ GetAllocatedTileCount()

int32 FParticleSimulationResources::GetAllocatedTileCount ( ) const
inline

Returns the number of allocated tiles.

◆ GetCurrentStateTextures()

FParticleStateTextures & FParticleSimulationResources::GetCurrentStateTextures ( )
inline

Retrieve texture resources with up-to-date particle state.

◆ GetFreeTileCount()

int32 FParticleSimulationResources::GetFreeTileCount ( ) const
inline

Returns the number of free tiles.

◆ GetPreviousStateTextures()

FParticleStateTextures & FParticleSimulationResources::GetPreviousStateTextures ( )
inline

Retrieve texture resources with previous particle state.

◆ GetVisualizeStateTextures()

FParticleStateTextures & FParticleSimulationResources::GetVisualizeStateTextures ( )
inline

◆ Init()

void FParticleSimulationResources::Init ( )
inline

Initialize resources.

How many tiles are in the simulation textures.

◆ Release()

void FParticleSimulationResources::Release ( )
inline

Release resources.

◆ Resize()

void FParticleSimulationResources::Resize ( FRHICommandListImmediate RHICmdList)
inline

Resize gpu simaluation resources.

◆ SupportTileResizing()

bool FParticleSimulationResources::SupportTileResizing ( ) const
inline

Support resizing tile allocator

◆ Update()

void FParticleSimulationResources::Update ( FRHICommandListImmediate RHICmdList)
inline

Update when AdvanceGPUParticleFrame is called .

Member Data Documentation

◆ FrameIndex

int32 FParticleSimulationResources::FrameIndex = 0

Frame index used to track double buffered resources on the GPU.

◆ LWCTile

FVector3f FParticleSimulationResources::LWCTile = FVector3f::ZeroVector

LWC tile offset, will be 0,0,0 for localspace emitters.

◆ ParticleSimulationTileCount

uint32 FParticleSimulationResources::ParticleSimulationTileCount = 0

◆ ParticleSimulationTileCountX

uint32 FParticleSimulationResources::ParticleSimulationTileCountX = 0

◆ ParticleSimulationTileCountY

uint32 FParticleSimulationResources::ParticleSimulationTileCountY = 0

◆ RenderAttributesTexture

FParticleAttributesTexture FParticleSimulationResources::RenderAttributesTexture

Texture holding render attributes.

◆ SimulationAttributesTexture

FParticleAttributesTexture FParticleSimulationResources::SimulationAttributesTexture

Texture holding simulation attributes.

◆ SimulationResourcesSize

FIntPoint FParticleSimulationResources::SimulationResourcesSize = FIntPoint::ZeroValue

◆ StateTextures

FParticleStateTextures FParticleSimulationResources::StateTextures[2]

Textures needed for simulation, double buffered.


The documentation for this class was generated from the following file: