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 > Plugins > Niagara > UNiagaraSpriteRendererProperties

Light Theme

Dark Theme

UNiagaraSpriteRendererProperties

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraRendererProperties

UNiagaraSpriteRendererProperties

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraSpriteRendererProperties.h
Include	#include "NiagaraSpriteRendererProperties.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Meta=(DisplayName="Sprite Renderer"))
class UNiagaraSpriteRendererProperties : public UNiagaraRendererProperties

Variables

	Name	Description
ENiagaraSpriteA...	Alignment	Imagine the particle texture having an arrow pointing up, these modes define how the particle aligns that texture to other particle attributes.
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.
uint32: 1	bRemoveHMDRollInVR	If true, removes the HMD view roll (e.g. in VR)
uint32: 1	bSortOnlyWhenTranslucent	If true, the particles are only sorted when using a translucent material.
uint32: 1	bSubImageBlend	If true, blends the sub-image UV lookup with its next adjacent member using the fractional part of the SubImageIndex float value as the linear interpolation factor.
bool	bUseMaterialCutoutTexture	Use the cutout texture from the material opacity mask, or if none exist, from the material opacity.
FNiagaraVariabl...	CameraOffsetBinding	Which attribute should we use for camera offset when generating sprites?
FNiagaraVariabl...	ColorBinding	Which attribute should we use for color when generating sprites?
FNiagaraVariabl...	CustomSortingBinding	Which attribute should we use for custom sorting? Defaults to Particles.NormalizedAge.
UTexture2D *...	CutoutTexture	Texture to generate bounding geometry from.
FNiagaraVariabl...	DynamicMaterial1Binding	Which attribute should we use for dynamic material parameters when generating sprites?
FNiagaraVariabl...	DynamicMaterial2Binding	Which attribute should we use for dynamic material parameters when generating sprites?
FNiagaraVariabl...	DynamicMaterial3Binding	Which attribute should we use for dynamic material parameters when generating sprites?
FNiagaraVariabl...	DynamicMaterialBinding	Which attribute should we use for dynamic material parameters when generating sprites?
ENiagaraSpriteF...	FacingMode	Determines how the particle billboard orients itself relative to the camera.
UMaterialInterf...	Material	The material used to render the particle.
FNiagaraVariabl...	MaterialRandomBinding	Which attribute should we use for material randoms when generating sprites?
FNiagaraUserPar...	MaterialUserParamBinding	Use the UMaterialInterface bound to this user variable if it is set to a valid value.
float	MaxFacingCameraBlendDistance	When FacingMode is FacingCameraDistanceBlend, the distance at which the sprite is fully facing the camera position
float	MinFacingCameraBlendDistance	When FacingMode is FacingCameraDistanceBlend, the distance at which the sprite is fully facing the camera plane.
FNiagaraVariabl...	NormalizedAgeBinding	Which attribute should we use for Normalized Age?
TEnumAsByte< en...	OpacitySourceMode
FVector2D	PivotInUVSpace	Determines the location of the pivot point of this particle.
FNiagaraVariabl...	PositionBinding	Which attribute should we use for position when generating sprites?
ENiagaraSortMod...	SortMode	Determines how we sort the particles prior to rendering.
FNiagaraVariabl...	SpriteAlignmentBinding	Which attribute should we use for sprite alignment when generating sprites?
FNiagaraVariabl...	SpriteFacingBinding	Which attribute should we use for sprite facing when generating sprites?
FNiagaraVariabl...	SpriteRotationBinding	Which attribute should we use for sprite rotation (in degrees) when generating sprites?
FNiagaraVariabl...	SpriteSizeBinding	Which attribute should we use for sprite size when generating sprites?
FNiagaraVariabl...	SubImageIndexBinding	Which attribute should we use for sprite sub-image indexing when generating sprites?
FVector2D	SubImageSize	When using SubImage lookups for particles, this variable contains the number of columns in X and the number of rows in Y.
FNiagaraVariabl...	UVScaleBinding	Which attribute should we use for UV scale when generating sprites?
FNiagaraVariabl...	VelocityBinding	Which attribute should we use for velocity when generating sprites?

Constructors

	Name	Description
	UNiagaraSpriteRendererProperties()

Functions

	Name	Description
void	CacheDerivedData()
const TArray...	GetCutoutData()
int32	GetNumCutoutVertexPerSubimage()
void	InitBindings()
void	InitCDOPropertiesAfterModuleStartup()	The bindings depend on variables that are created during the NiagaraModule startup.
void	UpdateCutoutTexture()

Overridden from UNiagaraRendererProperties

	Name	Description
FNiagaraBoun...	CreateBoundsCalculator()
FNiagaraRend...	CreateEmitterRenderer ( ERHIFeatureLevel::Type FeatureLevel, const FNiagaraEmitterInstance*... )
void	FixMaterial ( UMaterial* Material )
uint32	GetNumIndicesPerInstance()	GPU simulation uses DrawIndirect, so the sim step needs to know indices per instance in order to prepare the draw call parameters.
const TArray...	GetOptionalAttributes()
void	GetRendererFeedback ( const UNiagaraEmitter* InEmitt..., TArray< FText >& OutErrors, TArray< FText >& OutWarnings, TArray< FText >& OutInfo )
void	GetRendererTooltipWidgets ( const FNiagaraEmitterInstance*..., TArray< TSharedPtr< SWidget >>& Ou..., TSharedPtr< FAssetThumbnailPool > I... )
void	GetRendererWidgets ( const FNiagaraEmitterInstance*..., TArray< TSharedPtr< SWidget >>& Ou..., TSharedPtr< FAssetThumbnailPool > I... )
void	GetUsedMaterials ( const FNiagaraEmitterInstance..., TArray< UMaterialInterface > ... )
bool	IsMaterialValidForRenderer ( UMaterial* Material, FText& InvalidMessage )
bool	IsSimTargetSupported ( ENiagaraSimTarget InSimTarget )

Overridden from UObject

	Name	Description
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	Serialize ( FStructuredArchive::FRecord Record )	Handles reading, writing, and reference collecting using FArchive.

Constants

Name	Description
SpriteRendererPropertiesToDeferredInit

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

Take our survey

Dismiss