1. Epic GamesDeveloper
  3. TSharedPtr

TSharedPtr

[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr) is a non-intrusive reference-counted authoritative object pointer.

Unreal Engine C++ API Reference > Runtime > Core > Templates

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Templates/SharedPointer.h
Include #include "Templates/SharedPointer.h"

Syntax

template<class ObjectType, ESPMode InMode>  
class TSharedPtr

Remarks

TSharedPtr is a non-intrusive reference-counted authoritative object pointer. This shared pointer will be conditionally thread-safe when the optional Mode template argument is set to ThreadSafe.

Constructors

  Type Name Description
Public function   NOTE: FNullTag parameter is an Unreal extension to standard shared_ptr behavior.
Public function  

TSharedPtr ( OtherType* InObject,
DeleterType&& InDeleter
)

 Constructs a shared pointer that owns the specified object.
Public function  

TSharedPtr ( TSharedPtr< OtherType, Mode > const& InSharedPtr,
SharedPointerInternals::FStaticCastTag
)

 Special constructor used internally to statically cast one shared pointer type to another.
Public function  

TSharedPtr ( TSharedPtr< OtherType, Mode > const& InSharedPtr,
SharedPointerInternals::FConstCastTag
)

 Special constructor used internally to cast a 'const' shared pointer a 'mutable' pointer.
Public function  

TSharedPtr ( TSharedPtr< OtherType, Mode > const& OtherSharedPtr,
ObjectType* InObject
)

 Aliasing constructor used to create a shared pointer which shares its reference count with another shared object, but pointing to a different object, typically a subobject.
Public function  

TSharedPtr ( TSharedPtr< OtherType, Mode >&& OtherSharedPtr,
ObjectType* InObject
)

 Aliasing constructor used to create a shared pointer which shares its reference count with another shared object, but pointing to a different object, typically a subobject.
Public function  

TSharedPtr ( TSharedRef< OtherType, Mode > const& OtherSharedRef,
ObjectType* InObject
)

 Aliasing constructor used to create a shared pointer which shares its reference count with another shared object, but pointing to a different object, typically a subobject.
Public function  

TSharedPtr ( OtherType* InObject
)

 Constructs a shared pointer that owns the specified object.
Public function  

TSharedPtr ( SharedPointerInternals::TRawPtrProxy< OtherType > const& InRawPtrProxy
)

 NOTE: The following is an Unreal extension to standard shared_ptr behavior.
Public function  

TSharedPtr ( SharedPointerInternals::TRawPtrProxyWithDeleter< OtherType, DeleterType > const& InRawPtrProxy
)

 NOTE: The following is an Unreal extension to standard shared_ptr behavior.
Public function  

TSharedPtr ( SharedPointerInternals::TRawPtrProxyWithDeleter< OtherType, DeleterType >&& InRawPtrProxy
)

 NOTE: The following is an Unreal extension to standard shared_ptr behavior.
Public function  

TSharedPtr ( TSharedPtr< OtherType, Mode > const& InSharedPtr
)

 Constructs a shared pointer as a shared reference to an existing shared pointer's object.
Public function  

TSharedPtr ( TSharedPtr const& InSharedPtr
)

  
Public function  

TSharedPtr ( TSharedPtr&& InSharedPtr
)

  
Public function  

TSharedPtr ( TSharedRef< OtherType, Mode > const& InSharedRef
)

 NOTE: The following is an Unreal extension to standard shared_ptr behavior.

Functions

  Type Name Description
Public function Const ObjectType *

Get ()

 Returns the object referenced by this pointer, or nullptr if no object is reference
Public function Const int32 Returns the number of shared references to this object (including this reference.) IMPORTANT: Not necessarily fast! Should only be used for debugging purposes!
Public function Const bool Returns true if this is the only shared reference to this object.
Public function Const const bool

IsValid ()

 Checks to see if this shared pointer is actually pointing to an object
Public function void

Reset ()

 Resets this shared pointer, removing a reference to the object.
Public function TSharedRef< ObjectType, Mode > NOTE: The following is an Unreal extension to standard shared_ptr behavior.
Public function Const TSharedRef< ObjectType, Mode > NOTE: The following is an Unreal extension to standard shared_ptr behavior.
Public function Const TWeakPtr< ObjectType, Mode > Converts a shared pointer to a weak ptr.

Operators

  Type Name Description
Public function Const   Checks to see if this shared pointer is actually pointing to an object
Public function Const FMakeReferenceTo< ObjectType >::Type Dereference operator returns a reference to the object this shared pointer points to
Public function TSharedPtr & NOTE: The following is an Unreal extension to standard shared_ptr behavior.
Public function TSharedPtr &

operator= ( TSharedPtr const& InSharedPtr
)

 Assignment operator replaces this shared pointer with the specified shared pointer.
Public function TSharedPtr &

operator= ( TSharedPtr&& InSharedPtr
)

  
Public function TSharedPtr &

operator= ( SharedPointerInternals::TRawPtrProxy< OtherType > const& InRawPtrProxy
)

 NOTE: The following is an Unreal extension to standard shared_ptr behavior.
Public function TSharedPtr &

operator= ( SharedPointerInternals::TRawPtrProxyWithDeleter< OtherType, DeleterType > const& InRawPtrProxy
)

 NOTE: The following is an Unreal extension to standard shared_ptr behavior.
Public function TSharedPtr &

operator= ( SharedPointerInternals::TRawPtrProxyWithDeleter< OtherType, DeleterType >&& InRawPtrProxy
)

 NOTE: The following is an Unreal extension to standard shared_ptr behavior.
Public function Const ObjectType * Arrow operator returns a pointer to the object this shared pointer references

Typedefs

Name Description
ElementType  

Constants

Name Description
Mode  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page