UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ParticleSortingGPU.cpp File Reference

Classes

class  FParticleSortKeyGenCS
 

Macros

#define PARTICLE_KEY_GEN_THREAD_COUNT   64
 

Typedefs

typedef TUniformBufferRef< FParticleKeyGenParametersFParticleKeyGenUniformBufferRef
 

Functions

 IMPLEMENT_GLOBAL_SHADER_PARAMETER_STRUCT (FParticleKeyGenParameters,"ParticleKeyGen")
 
 IMPLEMENT_SHADER_TYPE (, FParticleSortKeyGenCS, TEXT("/Engine/Private/ParticleSortKeyGen.usf"), TEXT("GenerateParticleSortKeys"), SF_Compute)
 
int32 GenerateParticleSortKeys (FRHICommandListImmediate &RHICmdList, FRHIUnorderedAccessView *KeyBufferUAV, FRHIUnorderedAccessView *SortedVertexBufferUAV, FRHITexture *PositionTextureRHI, const TArray< FParticleSimulationSortInfo > &SimulationsToSort, ERHIFeatureLevel::Type FeatureLevel, int32 BatchId)
 

Macro Definition Documentation

◆ PARTICLE_KEY_GEN_THREAD_COUNT

#define PARTICLE_KEY_GEN_THREAD_COUNT   64

The number of threads per group used to generate particle keys.

Typedef Documentation

◆ FParticleKeyGenUniformBufferRef

Function Documentation

◆ GenerateParticleSortKeys()

int32 GenerateParticleSortKeys ( FRHICommandListImmediate RHICmdList,
FRHIUnorderedAccessView KeyBufferUAV,
FRHIUnorderedAccessView SortedVertexBufferUAV,
FRHITexture PositionTextureRHI,
const TArray< FParticleSimulationSortInfo > &  SimulationsToSort,
ERHIFeatureLevel::Type  FeatureLevel,
int32  BatchId 
)

Generate sort keys for a list of particles.

Parameters
KeyBufferUAV- Unordered access view of the buffer where sort keys will be stored.
SortedVertexBufferUAV- Unordered access view of the vertex buffer where particle indices will be stored.
PositionTextureRHI- The texture containing world space positions for all particles.
SimulationsToSort- A list of simulations to generate sort keys for.
Returns
the total number of particles being sorted.

◆ IMPLEMENT_GLOBAL_SHADER_PARAMETER_STRUCT()

IMPLEMENT_GLOBAL_SHADER_PARAMETER_STRUCT ( FParticleKeyGenParameters  ,
"ParticleKeyGen"   
)

Uniform buffer parameters for generating particle sort keys.

◆ IMPLEMENT_SHADER_TYPE()

IMPLEMENT_SHADER_TYPE ( FParticleSortKeyGenCS  ,
TEXT("/Engine/Private/ParticleSortKeyGen.usf" ,
TEXT("GenerateParticleSortKeys")  ,
SF_Compute   
)