UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FGPUSpriteEmitterInfo Struct Reference

#include <ParticleModuleTypeDataGpu.h>

Public Member Functions

 FGPUSpriteEmitterInfo ()
 

Public Attributes

TObjectPtr< class UParticleModuleRequiredRequiredModule
 
TObjectPtr< class UParticleModuleSpawnSpawnModule
 
TObjectPtr< class UParticleModuleSpawnPerUnitSpawnPerUnitModule
 
TArray< TObjectPtr< class UParticleModule > > SpawnModules
 
struct FGPUSpriteLocalVectorFieldInfo LocalVectorField
 
FFloatDistribution VectorFieldScale
 
FFloatDistribution DragCoefficient
 
FFloatDistribution PointAttractorStrength
 
FFloatDistribution Resilience
 
FVector ConstantAcceleration
 
FVector PointAttractorPosition
 
float PointAttractorRadiusSq
 
FVector OrbitOffsetBase
 
FVector OrbitOffsetRange
 
FVector2D InvMaxSize
 
float InvRotationRateScale
 
float MaxLifetime
 
int32 MaxParticleCount
 
TEnumAsByte< EParticleScreenAlignmentScreenAlignment
 
TEnumAsByte< EParticleAxisLockLockAxisFlag
 
uint32 bEnableCollision: 1
 
TEnumAsByte< EParticleCollisionMode::TypeCollisionMode
 
uint32 bUseVelocityForMotionBlur:1
 
uint32 bRemoveHMDRoll: 1
 
float MinFacingCameraBlendDistance
 
float MaxFacingCameraBlendDistance
 
FRawDistributionVector DynamicColor
 
FRawDistributionFloat DynamicAlpha
 
FRawDistributionVector DynamicColorScale
 
FRawDistributionFloat DynamicAlphaScale
 
class FGPUSpriteResourcesResources
 

Detailed Description

The data needed by the runtime to simulate sprites.

Constructor & Destructor Documentation

◆ FGPUSpriteEmitterInfo()

FGPUSpriteEmitterInfo::FGPUSpriteEmitterInfo ( )
inline

Member Data Documentation

◆ bEnableCollision

uint32 FGPUSpriteEmitterInfo::bEnableCollision

If true, collisions are enabled for this emitter.

◆ bRemoveHMDRoll

uint32 FGPUSpriteEmitterInfo::bRemoveHMDRoll

If true, removes the HMD view roll (e.g. in VR)

◆ bUseVelocityForMotionBlur

uint32 FGPUSpriteEmitterInfo::bUseVelocityForMotionBlur

If true, use velocity to approximate motion blur

◆ CollisionMode

TEnumAsByte<EParticleCollisionMode::Type> FGPUSpriteEmitterInfo::CollisionMode

◆ ConstantAcceleration

FVector FGPUSpriteEmitterInfo::ConstantAcceleration

Constant acceleration to apply to particles.

◆ DragCoefficient

FFloatDistribution FGPUSpriteEmitterInfo::DragCoefficient

Per-particle drag coefficient.

◆ DynamicAlpha

FRawDistributionFloat FGPUSpriteEmitterInfo::DynamicAlpha

Dynamic alpha scale from the ColorOverLife module.

◆ DynamicAlphaScale

FRawDistributionFloat FGPUSpriteEmitterInfo::DynamicAlphaScale

Dynamic alpha scale from the ColorScaleOverLife module.

◆ DynamicColor

FRawDistributionVector FGPUSpriteEmitterInfo::DynamicColor

Dynamic color scale from the ColorOverLife module.

◆ DynamicColorScale

FRawDistributionVector FGPUSpriteEmitterInfo::DynamicColorScale

Dynamic color scale from the ColorScaleOverLife module.

◆ InvMaxSize

FVector2D FGPUSpriteEmitterInfo::InvMaxSize

One over the maximum size of a sprite particle.

◆ InvRotationRateScale

float FGPUSpriteEmitterInfo::InvRotationRateScale

The inverse scale to apply to rotation rate.

◆ LocalVectorField

struct FGPUSpriteLocalVectorFieldInfo FGPUSpriteEmitterInfo::LocalVectorField

Local vector field info.

◆ LockAxisFlag

TEnumAsByte<EParticleAxisLock> FGPUSpriteEmitterInfo::LockAxisFlag

The method for locking the particles to a particular axis.

◆ MaxFacingCameraBlendDistance

float FGPUSpriteEmitterInfo::MaxFacingCameraBlendDistance

The distance at which PSA_FacingCameraDistanceBlend is fully PSA_FacingCameraPosition

◆ MaxLifetime

float FGPUSpriteEmitterInfo::MaxLifetime

The maximum lifetime of particles in this emitter.

◆ MaxParticleCount

int32 FGPUSpriteEmitterInfo::MaxParticleCount

The maximum number of particles expected for this emitter.

◆ MinFacingCameraBlendDistance

float FGPUSpriteEmitterInfo::MinFacingCameraBlendDistance

The distance at which PSA_FacingCameraDistanceBlend is fully PSA_Square

◆ OrbitOffsetBase

FVector FGPUSpriteEmitterInfo::OrbitOffsetBase

Amount by which to offset particles when they are spawned.

◆ OrbitOffsetRange

FVector FGPUSpriteEmitterInfo::OrbitOffsetRange

◆ PointAttractorPosition

FVector FGPUSpriteEmitterInfo::PointAttractorPosition

Point attractor position.

◆ PointAttractorRadiusSq

float FGPUSpriteEmitterInfo::PointAttractorRadiusSq

Point attractor radius, squared.

◆ PointAttractorStrength

FFloatDistribution FGPUSpriteEmitterInfo::PointAttractorStrength

Point attractor strength over time.

◆ RequiredModule

TObjectPtr<class UParticleModuleRequired> FGPUSpriteEmitterInfo::RequiredModule

The required module. Needed for now, but should be divorced from the runtime.

◆ Resilience

FFloatDistribution FGPUSpriteEmitterInfo::Resilience

Damping factor applied to particle collisions.

◆ Resources

class FGPUSpriteResources* FGPUSpriteEmitterInfo::Resources

Pointer to runtime resources.

◆ ScreenAlignment

TEnumAsByte<EParticleScreenAlignment> FGPUSpriteEmitterInfo::ScreenAlignment

The method for aligning the particle based on the camera.

◆ SpawnModule

TObjectPtr<class UParticleModuleSpawn> FGPUSpriteEmitterInfo::SpawnModule

The spawn module. Needed for now, but should be divorced from the runtime.

◆ SpawnModules

TArray<TObjectPtr<class UParticleModule> > FGPUSpriteEmitterInfo::SpawnModules

List of spawn modules that must be evaluated at runtime.

◆ SpawnPerUnitModule

TObjectPtr<class UParticleModuleSpawnPerUnit> FGPUSpriteEmitterInfo::SpawnPerUnitModule

The spawn-per-unit module.

◆ VectorFieldScale

FFloatDistribution FGPUSpriteEmitterInfo::VectorFieldScale

Per-particle vector field scale.


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