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 > FNiagaraSharedObject

Light Theme

Dark Theme

FNiagaraSharedObject

Base class for objects in Niagara that are owned by one object but are then passed for reading to other objects, potentially on other threads.

Windows

MacOS

Linux

Inheritance Hierarchy

FNiagaraSharedObject

FNiagaraDataBuffer

References

Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataSet.h
Include	#include "NiagaraDataSet.h"

Syntax

class FNiagaraSharedObject

Remarks

Base class for objects in Niagara that are owned by one object but are then passed for reading to other objects, potentially on other threads. This class allows us to know if the object is being used so we do not overwrite it and to ensure it's lifetime so we do not access freed data.

Variables

		Name	Description
	TAtomic< int32 ...	ReadRefCount	Count of other object currently reading this data.

Constructors

	Name	Description
	FNiagaraSharedObject()

Destructors

	Name	Description
	~FNiagaraSharedObject()

Functions

	Name	Description
void	AddReadRef()
void	Destroy()	The owner of this object is now done with it but it may still be in use by others, possibly on other threads.
void	FlushDeletionList()
bool	IsBeingRead()
bool	IsBeingWritten()
bool	IsInUse()
void	ReleaseReadRef()
bool	TryLock()
void	Unlock()

Constants

Name	Description
CritSec
DeferredDeletionList

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

Take our survey

Dismiss