1. Epic GamesDeveloper
  3. UNiagaraSpriteRendererProperties

UNiagaraSpriteRendererProperties

Unreal Engine C++ API Reference > Plugins > Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;EditInlineNew, Meta&61;&40;DisplayName&61;"Sprite Renderer"&41;, MinimalAPI&41;  
class UNiagaraSpriteRendererProperties : public UNiagaraRendererProperties

Variables

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

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Const const TArray< FVector2f > &  
Public function Const int32  
Public function Const uint32  
Protected function void  
Public function Static void The bindings depend on variables that are created during the NiagaraModule startup.
Protected function void  
Public function void  
Protected function void  

Overridden from UNiagaraRendererProperties

  Type Name Description
Public function Virtual void  
Public function Virtual void  
Public function Virtual FNiagaraBoundsCalculator *  
Public function Virtual FNiagaraRenderer *  
Public function Virtual Const void  
Protected function Virtual Const FNiagaraVariable Returns the variable associated with the supplied binding if it should be bound given the current settings of the RendererProperties.
Public function Virtual Const TArray< FNiagaraVariable >  
Public function Virtual Const ENiagaraRendererSourceDataMode  
Public function Virtual const TArray< FNiagaraVariable > &  
Public function Virtual Const void

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

  
Public function Virtual Const void  
Public function Virtual Const void

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

  
Public function Virtual Const void

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

  
Public function Virtual Const void

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

  
Public function Virtual Const const FVertexFactoryType *  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual bool 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.
Public function Virtual void

RemoveVariable ( const FNiagaraVariableBase& OldVariable,
const FVersionedNiagaraEmitter& InEmitter
)

  
Public function Virtual void

RenameVariable ( const FNiagaraVariableBase& OldVariable,
const FNiagaraVariableBase& NewVariable,
const FVersionedNiagaraEmitter& InEmitter
)

  
Protected function Virtual void

UpdateSourceModeDerivates ( ENiagaraRendererSourceDataMode InSourceMode,
bool bFromPropertyEdit
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Constants

Name Description
SpriteRendererPropertiesToDeferredInit  

Deprecated Variables

  Type Name Description
Public variable UProperty TArray< FNiagaraMaterialAttributeBinding > MaterialParameterBindings_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page