Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Particles > USubUVAnimation

Light Theme

Dark Theme

USubUVAnimation

SubUV animation asset, which caches bounding geometry for regions in the SubUVTexture with non-zero opacity.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USubUVAnimation

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Particles/SubUVAnimation.h
Include	#include "Particles/SubUVAnimation.h"

Syntax

class USubUVAnimation : public UObject

Remarks

SubUV animation asset, which caches bounding geometry for regions in the SubUVTexture with non-zero opacity. Particle emitters with a SubUV module which use this asset leverage the optimal bounding geometry to reduce overdraw.

Variables

	Name	Description
float	AlphaThreshold	Alpha channel values larger than the threshold are considered occupied and will be contained in the bounding geometry.
TEnumAsByte< en...	BoundingMode	More bounding vertices results in reduced overdraw, but adds more triangle overhead.
TEnumAsByte< en...	OpacitySourceMode
int32	SubImages_Horizontal	The number of sub-images horizontally in the texture
int32	SubImages_Vertical	The number of sub-images vertically in the texture
UTexture2D *...	SubUVTexture	Texture to generate bounding geometry from.

Constructors

	Name	Description
	USubUVAnimation ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	FRHIShaderRe...	GetBoundingGeometrySRV()
	const FVecto...	GetFrameData ( int32 FrameIndex )
	int32	GetNumBoundingTriangles()
	int32	GetNumBoundingVertices()
	int32	GetNumFrames()
	bool	IsBoundingGeometryValid()

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	FinishDestroy()	Called to finish destroying the object.
bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally
void	Serialize ( FStructuredArchive::FRecord Record )	Handles reading, writing, and reference collecting using FArchive.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss