Skip to content
CRUSHFORMV1.1.0
GET IT ON FAB

REFERENCESUBSYSTEMS AND LIBRARIES

UCFRenderSubsystem

MODULECrushformINCLUDECFRenderSubsystem.hPARENTUEngineSubsystem

Hands out atlas slots to dented or dirty deformers and copies their lattices and dirt into the atlases once per frame: the lattice atlas, the dirt atlas and, for bodies that keep the freshness of their dirt, the fresh atlas. One per process: the atlases are single assets, and PIE runs several worlds in one process. Not created on a dedicated server.

Functions

AUTHORITY · server, every machineLOCAL · this machinePURE · read only
UCFRenderSubsystem* Get()
C++ ONLY

The subsystem; null when it does not exist, as on a dedicated server.

void MarkDirty(UCFDeformComponent* Deformer, bool bLatticeChanged = true, bool bDirtChanged = false)
C++ ONLY

The deformer's lattice or dirt changed and it is dented or dirty: give it a slot if it has none and the cull limits let it draw, and upload what changed this frame. A newly assigned slot uploads both.

void Release(UCFDeformComponent* Deformer)
C++ ONLY

The deformer is undented and clean, or leaving: free its slot and draw its meshes undeformed.

bool HasSlot(const UCFDeformComponent* Deformer) const
PUREC++ ONLY

Whether the deformer holds an atlas slot.

bool IsDirtDrawn()
C++ ONLY

Whether dirt can be drawn at all: a dirt atlas of the right format (RGBA8) and size. Not a pure query: the first call resolves the lattice atlas and the dirt atlas and can load both synchronously.

bool IsScratchDrawn()
C++ ONLY

Whether the scratch atlas is usable: scratch lines show only then. Not a pure query: the first call resolves the lattice atlas and the scratch atlas and can load both synchronously.

int32 GetNumSlots() const
PUREC++ ONLY

Number of slots in the atlas.

int32 GetNumFreeSlots() const
PUREC++ ONLY

Number of slots not taken.

int32 GetNumWaiting() const
PUREC++ ONLY

Number of damaged deformers without a slot, waiting for one or hidden by the cull pass; they are drawn undeformed meanwhile.

const FCFRenderStats& GetStats() const
PUREC++ ONLY

The counters Crushform.Stats prints.