Open 3D Engine Atom Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Friends | List of all members
AZ::StableDynamicArrayWeakHandle< ValueType > Class Template Reference

#include <StableDynamicArray.h>

Public Member Functions

bool IsValid () const
 Returns true if this Handle currently holds a valid value.
 
bool IsNull () const
 Returns true if this Handle doesn't contain a value (same as !IsValid()).
 
ValueType & operator* () const
 
ValueType * operator-> () const
 
bool operator== (const StableDynamicArrayWeakHandle< ValueType > &rhs) const
 
bool operator!= (const StableDynamicArrayWeakHandle< ValueType > &rhs) const
 
bool operator< (const StableDynamicArrayWeakHandle< ValueType > &rhs) const
 

Friends

template<typename T >
class StableDynamicArrayHandle
 

Detailed Description

template<typename ValueType>
class AZ::StableDynamicArrayWeakHandle< ValueType >

A weak reference to the data allocated in the array. It can be copied, and will not auto-release the data when it goes out of scope. There is no guarantee that a weak handle is not dangling, so it should only be used in cases where it is known that the owning handle has not gone out of scope. This could potentially be augmented in the future to have a salt/generationId that could be used to determine if it is a dangling reference.

The documentation for this class was generated from the following files: