1. Epic GamesDeveloper
  3. UNiagaraSpriteRendererProperties

UNiagaraSpriteRendererProperties

API > API/Plugins > API/Plugins/Niagara

   
Name UNiagaraSpriteRendererProperties
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraSpriteRendererProperties.h
Include Path #include "NiagaraSpriteRendererProperties.h"

Syntax

UCLASS (EditInlineNew, Meta=(DisplayName="Sprite Renderer", SupportsStateless), MinimalAPI)  
class UNiagaraSpriteRendererProperties : public UNiagaraRendererProperties

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraSpriteRendererProperties()

   NiagaraSpriteRendererProperties.h  

Constants

Name Type Remarks Include Path
SpriteRendererPropertiesToDeferredInit TArray< TWeakObjectPtr< UNiagaraSpriteRendererProperties > >   NiagaraSpriteRendererProperties.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Alignment ENiagaraSpriteAlignment Imagine the particle texture having an arrow pointing up, these modes define how the particle aligns that texture to other particle attributes. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
AlphaThreshold float Alpha channel values larger than the threshold are considered occupied and will be contained in the bounding geometry. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Cutout"
  • Meta=(UIMin="0", UIMax="1")
bCastShadows uint8 When disabled the renderer will not cast shadows. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Rendering"
bEnableCameraDistanceCulling uint8 Enables frustum culling of individual sprites NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Visibility"
bIncludeInHitProxy uint8 When disabled the mesh batches do not contribute to the hit proxy, i.e. they are not part of editor selection. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Rendering"
BoundingMode TEnumAsByte< enum ESubUVBoundingVertexCount > More bounding vertices results in reduced overdraw, but adds more triangle overhead. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Cutout"
bRemoveHMDRollInVR uint8 If true, removes the HMD view roll (e.g. in VR) NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
  • Meta=(DisplayName="Remove HMD Roll")
bSortOnlyWhenTranslucent uint8 If true, the particles are only sorted when using a translucent material. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sorting"
  • Meta=(EditCondition="SortMode != ENiagaraSortMode::None", EditConditionHides)
bSubImageBlend uint8 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. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="SubUV"
  • Meta=(DisplayName="Sub UV Blending Enabled")
bUseMaterialCutoutTexture bool Use the cutout texture from the material opacity mask, or if none exist, from the material opacity. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cutout"
CameraOffsetBinding FNiagaraVariableAttributeBinding Which attribute should we use for camera offset when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
ColorBinding FNiagaraVariableAttributeBinding Which attribute should we use for color when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
CustomSortingBinding FNiagaraVariableAttributeBinding Which attribute should we use for custom sorting? Defaults to Particles.NormalizedAge. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
  • Meta=(EditCondition="SourceMode != ENiagaraRendererSourceDataMode::Emitter")
CutoutTexture TObjectPtr< UTexture2D > Texture to generate bounding geometry from. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Cutout"
  • Meta=(EditCondition="!bUseMaterialCutoutTexture", EditConditionHides)
DynamicMaterial1Binding FNiagaraVariableAttributeBinding Which attribute should we use for dynamic material parameters when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
DynamicMaterial2Binding FNiagaraVariableAttributeBinding Which attribute should we use for dynamic material parameters when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
DynamicMaterial3Binding FNiagaraVariableAttributeBinding Which attribute should we use for dynamic material parameters when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
DynamicMaterialBinding FNiagaraVariableAttributeBinding Which attribute should we use for dynamic material parameters when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
FacingMode ENiagaraSpriteFacingMode Determines how the particle billboard orients itself relative to the camera. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
GpuTranslucentLatency ENiagaraRendererGpuTranslucentLatency Gpu simulations run at different points in the frame depending on what features are used, i.e. depth buffer, distance fields, etc. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Sprite Rendering"
MacroUVRadius float World space radius that UVs generated with the ParticleMacroUV material node will tile based on. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
Material TObjectPtr< UMaterialInterface > The material used to render the particle. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
MaterialParameters FNiagaraRendererMaterialParameters If this array has entries, we will create a MaterialInstanceDynamic per Emitter instance from Material and set the Material parameters using the Niagara simulation variables listed. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
MaterialParamValidMask uint32   NiagaraSpriteRendererProperties.h  
MaterialRandomBinding FNiagaraVariableAttributeBinding Which attribute should we use for material randoms when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
MaterialUserParamBinding FNiagaraUserParameterBinding Use the UMaterialInterface bound to this user variable if it is set to a valid value. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
MaxCameraDistance float   NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Visibility"
  • Meta=(EditCondition="bEnableCameraDistanceCulling", UIMin=0.0f, EditConditionHides)
MaxFacingCameraBlendDistance float When FacingMode is FacingCameraDistanceBlend, the distance at which the sprite is fully facing the camera position NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
  • Meta=(UIMin="0")
MICMaterial TObjectPtr< UMaterialInstanceConstant >   NiagaraSpriteRendererProperties.h
  • Transient
MinCameraDistance float   NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Visibility"
  • Meta=(EditCondition="bEnableCameraDistanceCulling", UIMin=0.0f, EditConditionHides)
MinFacingCameraBlendDistance float When FacingMode is FacingCameraDistanceBlend, the distance at which the sprite is fully facing the camera plane. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
  • Meta=(UIMin="0")
NormalizedAgeBinding FNiagaraVariableAttributeBinding Which attribute should we use for Normalized Age? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
OpacitySourceMode TEnumAsByte< enum EOpacitySourceMode >   NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Cutout"
PivotInUVSpace FVector2D Determines the location of the pivot point of this particle. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
  • Meta=(DisplayName="Default Pivot in UV Space")
PivotOffsetBinding FNiagaraVariableAttributeBinding Which attribute should we use for pivot offset? (NOTE: Values are expected to be in UV space). NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
PixelCoverageBlend float When pixel coverage is enabled this allows you to control the blend of the pixel coverage color adjustment. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
  • Meta=(EditCondition="PixelCoverageMode != ENiagaraRendererPixelCoverageMode::Disabled", UIMin=0.0f, UIMax=1.0f, EditConditionHides)
PixelCoverageMode ENiagaraRendererPixelCoverageMode This setting controls what happens when a sprite becomes less than a pixel in size. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
PositionBinding FNiagaraVariableAttributeBinding Which attribute should we use for position when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
PrevCameraOffsetBinding FNiagaraVariableAttributeBinding   NiagaraSpriteRendererProperties.h
  • Transient
PrevPivotOffsetBinding FNiagaraVariableAttributeBinding   NiagaraSpriteRendererProperties.h
  • Transient
PrevPositionBinding FNiagaraVariableAttributeBinding   NiagaraSpriteRendererProperties.h
  • Transient
PrevSpriteAlignmentBinding FNiagaraVariableAttributeBinding   NiagaraSpriteRendererProperties.h
  • Transient
PrevSpriteFacingBinding FNiagaraVariableAttributeBinding   NiagaraSpriteRendererProperties.h
  • Transient
PrevSpriteRotationBinding FNiagaraVariableAttributeBinding   NiagaraSpriteRendererProperties.h
  • Transient
PrevSpriteSizeBinding FNiagaraVariableAttributeBinding   NiagaraSpriteRendererProperties.h
  • Transient
PrevVelocityBinding FNiagaraVariableAttributeBinding   NiagaraSpriteRendererProperties.h
  • Transient
RendererLayoutWithCustomSort FNiagaraRendererLayout   NiagaraSpriteRendererProperties.h  
RendererLayoutWithoutCustomSort FNiagaraRendererLayout   NiagaraSpriteRendererProperties.h  
RendererVisibility uint32 If a render visibility tag is present, particles whose tag matches this value will be visible in this renderer. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Visibility"
RendererVisibilityTagBinding FNiagaraVariableAttributeBinding Which attribute should we use for RendererVisibilityTag? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
SortMode ENiagaraSortMode Determines how we sort the particles prior to rendering. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sorting"
SortPrecision ENiagaraRendererSortPrecision Sort precision to use when sorting is active. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sorting"
  • Meta=(EditCondition="SortMode != ENiagaraSortMode::None", EditConditionHides)
SourceMode ENiagaraRendererSourceDataMode Whether or not to draw a single element for the Emitter or to draw the particles. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Sprite Rendering"
SpriteAlignmentBinding FNiagaraVariableAttributeBinding Which attribute should we use for sprite alignment when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
SpriteFacingBinding FNiagaraVariableAttributeBinding Which attribute should we use for sprite facing when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
SpriteRotationBinding FNiagaraVariableAttributeBinding Which attribute should we use for sprite rotation (in degrees) when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
SpriteSizeBinding FNiagaraVariableAttributeBinding Which attribute should we use for sprite size when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
SubImageIndexBinding FNiagaraVariableAttributeBinding Which attribute should we use for sprite sub-image indexing when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
SubImageSize FVector2D When using SubImage lookups for particles, this variable contains the number of columns in X and the number of rows in Y. NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="SubUV"
  • Meta=(DisplayAfter=bSubImageBlend)
UVScaleBinding FNiagaraVariableAttributeBinding Which attribute should we use for UV scale when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"
VelocityBinding FNiagaraVariableAttributeBinding Which attribute should we use for velocity when generating sprites? NiagaraSpriteRendererProperties.h
  • EditAnywhere
  • Category="Bindings"

Protected

Name Type Remarks Include Path Unreal Specifiers
DerivedData FSubUVDerivedData Derived data for this asset, generated off of SubUVTexture. NiagaraSpriteRendererProperties.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CacheDerivedData()

   NiagaraSpriteRendererProperties.h  

const TArray< FVector2f > & GetCutoutData()

   NiagaraSpriteRendererProperties.h  

int32 GetNumCutoutVertexPerSubimage()

   NiagaraSpriteRendererProperties.h  

uint32 GetNumIndicesPerInstance()

   NiagaraSpriteRendererProperties.h  

void UpdateCutoutTexture()

   NiagaraSpriteRendererProperties.h  

Overridden from UNiagaraRendererProperties

Name Remarks Include Path Unreal Specifiers

virtual void CacheFromCompiledData ( const FNiagaraDataSetCompiledData* CompiledData
)

   NiagaraSpriteRendererProperties.h  

virtual void CollectPSOPrecacheData ( const FNiagaraEmitterInstance* InEmitter,
FPSOPrecacheParamsList& OutParams
) const

   NiagaraSpriteRendererProperties.h  

virtual FNiagaraBoundsCalculator * CreateBoundsCalculator()

   NiagaraSpriteRendererProperties.h  

virtual FNiagaraRenderer * CreateEmitterRenderer ( ERHIFeatureLevel::Type FeatureLevel,
const FNiagaraEmitterInstance* Emitter,
const FNiagaraSystemInstanceController& InController
)

   NiagaraSpriteRendererProperties.h  

virtual void GetAdditionalVariables ( TArray< FNiagaraVariableBase >& OutArray
) const

   NiagaraSpriteRendererProperties.h  

virtual TArray< FNiagaraVariable > GetBoundAttributes()

   NiagaraSpriteRendererProperties.h  

virtual ENiagaraRendererSourceDataMode GetCurrentSourceMode()

   NiagaraSpriteRendererProperties.h  

virtual float GetMaterialStreamingScale()

   NiagaraSpriteRendererProperties.h  

virtual const TArray< FNiagaraVariable > & GetOptionalAttributes()

   NiagaraSpriteRendererProperties.h  

virtual void GetRendererFeedback ( const FVersionedNiagaraEmitter& InEmitter,
TArray< FText >& OutErrors,
TArray< FText >& OutWarnings,
TArray< FText >& OutInfo
) const

   NiagaraSpriteRendererProperties.h  

virtual void GetRendererFeedback ( const FVersionedNiagaraEmitter& InEmitter,
TArray< FNiagaraRendererFeedback >& OutErrors,
TArray< FNiagaraRendererFeedback >& OutWarnings,
TArray< FNiagaraRendererFeedback >& OutInfo
) const

   NiagaraSpriteRendererProperties.h  

virtual void GetRendererMaterialUsageFeedback ( TArray< FNiagaraRendererFeedback >& OutFeedback
) const

 Provides feedback on any material usage issues, i.e. incompatable material assignment or missing usage flags Automaticaly called from GetRendererFeedback where OutFeedback results in Errors NiagaraSpriteRendererProperties.h  

virtual void GetRendererTooltipWidgets ( const FNiagaraEmitterInstance* InEmitter,
TArray< TSharedPtr< SWidget > >& OutWidgets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool
) const

   NiagaraSpriteRendererProperties.h  

virtual void GetRendererWidgets ( const FNiagaraEmitterInstance* InEmitter,
TArray< TSharedPtr< SWidget > >& OutWidgets,
TSharedPtr< FAssetThumbnailPool > InThumbnailPool
) const

   NiagaraSpriteRendererProperties.h  

virtual void GetUsedMaterials ( const FNiagaraEmitterInstance* InEmitter,
TArray< UMaterialInterface* >& OutMaterials
) const

   NiagaraSpriteRendererProperties.h  

virtual const FVertexFactoryType * GetVertexFactoryType()

   NiagaraSpriteRendererProperties.h  

virtual bool IsSimTargetSupported ( ENiagaraSimTarget InSimTarget
) const

   NiagaraSpriteRendererProperties.h  

virtual bool NeedsMIDsForMaterials()

   NiagaraSpriteRendererProperties.h  

virtual bool PopulateRequiredBindings ( FNiagaraParameterStore& InParameterStore
)

 In the case that we need parameters bound in that aren't Particle variables, these should be set up here so that the data is appropriately populated after the simulation. NiagaraSpriteRendererProperties.h  

virtual void RemoveVariable ( const FNiagaraVariableBase& OldVariable,
const FVersionedNiagaraEmitterBase& InEmitter
)

   NiagaraSpriteRendererProperties.h  

virtual void RenameVariable ( const FNiagaraVariableBase& OldVariable,
const FNiagaraVariableBase& NewVariable,
const FVersionedNiagaraEmitterBase& InEmitter
)

   NiagaraSpriteRendererProperties.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   NiagaraSpriteRendererProperties.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraSpriteRendererProperties.h  

virtual void PostInitProperties()

   NiagaraSpriteRendererProperties.h  

virtual void PostLoad()

   NiagaraSpriteRendererProperties.h  

virtual void Serialize ( FStructuredArchive::FRecord Record
)

   NiagaraSpriteRendererProperties.h  

Protected

Name Remarks Include Path Unreal Specifiers

void InitBindings()

   NiagaraSpriteRendererProperties.h  

void SetPreviousBindings ( const FVersionedNiagaraEmitterBase& SrcEmitter,
ENiagaraRendererSourceDataMode InSourceMode
)

   NiagaraSpriteRendererProperties.h  

void UpdateMICs()

   NiagaraSpriteRendererProperties.h  

Overridden from UNiagaraRendererProperties

Name Remarks Include Path Unreal Specifiers

virtual FNiagaraVariable GetBoundAttribute ( const FNiagaraVariableAttributeBinding* Binding
) const

 Returns the variable associated with the supplied binding if it should be bound given the current settings of the RendererProperties. NiagaraSpriteRendererProperties.h  

virtual void UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSourceMode,
bool bFromPropertyEdit
)

   NiagaraSpriteRendererProperties.h  

Static

Name Remarks Include Path Unreal Specifiers
The bindings depend on variables that are created during the NiagaraModule startup. NiagaraSpriteRendererProperties.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
MaterialParameterBindings_DEPRECATED TArray< FNiagaraMaterialAttributeBinding >   NiagaraSpriteRendererProperties.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page