Blender V5.0
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
blender::ImplicitSharingPtr< T, IsStrong > Class Template Reference

#include <BLI_implicit_sharing_ptr.hh>

Public Types

using element_type = T

Public Member Functions

 ImplicitSharingPtr ()=default
 ImplicitSharingPtr (const T *data)
 ImplicitSharingPtr (std::nullptr_t)
 ImplicitSharingPtr (const ImplicitSharingPtr &other)
 ImplicitSharingPtr (ImplicitSharingPtr &&other)
 ~ImplicitSharingPtr ()
ImplicitSharingPtr & operator= (const ImplicitSharingPtr &other)
ImplicitSharingPtr & operator= (ImplicitSharingPtr &&other)
const T * operator-> () const
const T & operator* () const
 operator bool () const
const T * get () const
const T * release ()
void reset ()
bool has_value () const
uint64_t hash () const

Static Public Member Functions

static uint64_t hash_as (const T *data)

Friends

bool operator== (const T *a, const ImplicitSharingPtr &b)
bool operator== (const ImplicitSharingPtr &a, const T *b)

Detailed Description

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
class blender::ImplicitSharingPtr< T, IsStrong >

ImplicitSharingPtr is a smart pointer that manages implicit sharing. It's designed to work with types that derive from ImplicitSharingMixin. It is fairly similar to #std::shared_ptr but requires the reference count to be embedded in the data.

Definition at line 24 of file BLI_implicit_sharing_ptr.hh.

Member Typedef Documentation

◆ element_type

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
using blender::ImplicitSharingPtr< T, IsStrong >::element_type = T

Definition at line 29 of file BLI_implicit_sharing_ptr.hh.

Constructor & Destructor Documentation

◆ ImplicitSharingPtr() [1/5]

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
blender::ImplicitSharingPtr< T, IsStrong >::ImplicitSharingPtr ( )
default

◆ ImplicitSharingPtr() [2/5]

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
blender::ImplicitSharingPtr< T, IsStrong >::ImplicitSharingPtr ( const T * data)
inlineexplicit

Definition at line 33 of file BLI_implicit_sharing_ptr.hh.

◆ ImplicitSharingPtr() [3/5]

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
blender::ImplicitSharingPtr< T, IsStrong >::ImplicitSharingPtr ( std::nullptr_t )
inline

Definition at line 36 of file BLI_implicit_sharing_ptr.hh.

◆ ImplicitSharingPtr() [4/5]

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
blender::ImplicitSharingPtr< T, IsStrong >::ImplicitSharingPtr ( const ImplicitSharingPtr< T, IsStrong > & other)
inline

Definition at line 38 of file BLI_implicit_sharing_ptr.hh.

◆ ImplicitSharingPtr() [5/5]

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
blender::ImplicitSharingPtr< T, IsStrong >::ImplicitSharingPtr ( ImplicitSharingPtr< T, IsStrong > && other)
inline

Definition at line 43 of file BLI_implicit_sharing_ptr.hh.

◆ ~ImplicitSharingPtr()

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
blender::ImplicitSharingPtr< T, IsStrong >::~ImplicitSharingPtr ( )
inline

Definition at line 48 of file BLI_implicit_sharing_ptr.hh.

Member Function Documentation

◆ get()

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
const T * blender::ImplicitSharingPtr< T, IsStrong >::get ( ) const
inline

Definition at line 94 of file BLI_implicit_sharing_ptr.hh.

Referenced by IMB_colormanagement_working_space_convert(), blender::nodes::geo_eval_log::GeoTreeLogger::log_value(), blender::nodes::node_geo_sort_elements_cc::node_geo_exec(), blender::tests::TEST(), blender::tests::TEST(), and blender::tests::TEST().

◆ has_value()

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
bool blender::ImplicitSharingPtr< T, IsStrong >::has_value ( ) const
inline

Definition at line 112 of file BLI_implicit_sharing_ptr.hh.

Referenced by blender::bke::GeometrySet::has(), and blender::ImplicitSharingPtrAndData::has_value().

◆ hash()

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
uint64_t blender::ImplicitSharingPtr< T, IsStrong >::hash ( ) const
inline

Definition at line 117 of file BLI_implicit_sharing_ptr.hh.

◆ hash_as()

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
uint64_t blender::ImplicitSharingPtr< T, IsStrong >::hash_as ( const T * data)
inlinestatic

Definition at line 122 of file BLI_implicit_sharing_ptr.hh.

◆ operator bool()

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
blender::ImplicitSharingPtr< T, IsStrong >::operator bool ( ) const
inline

Definition at line 89 of file BLI_implicit_sharing_ptr.hh.

◆ operator*()

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
const T & blender::ImplicitSharingPtr< T, IsStrong >::operator* ( ) const
inline

Definition at line 83 of file BLI_implicit_sharing_ptr.hh.

◆ operator->()

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
const T * blender::ImplicitSharingPtr< T, IsStrong >::operator-> ( ) const
inline

Definition at line 77 of file BLI_implicit_sharing_ptr.hh.

◆ operator=() [1/2]

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
ImplicitSharingPtr & blender::ImplicitSharingPtr< T, IsStrong >::operator= ( const ImplicitSharingPtr< T, IsStrong > & other)
inline

Definition at line 53 of file BLI_implicit_sharing_ptr.hh.

◆ operator=() [2/2]

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
ImplicitSharingPtr & blender::ImplicitSharingPtr< T, IsStrong >::operator= ( ImplicitSharingPtr< T, IsStrong > && other)
inline

Definition at line 65 of file BLI_implicit_sharing_ptr.hh.

◆ release()

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
const T * blender::ImplicitSharingPtr< T, IsStrong >::release ( )
inline

Definition at line 99 of file BLI_implicit_sharing_ptr.hh.

◆ reset()

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
void blender::ImplicitSharingPtr< T, IsStrong >::reset ( )
inline

Definition at line 106 of file BLI_implicit_sharing_ptr.hh.

Referenced by blender::bke::GeometrySet::remove().

◆ operator== [1/2]

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
bool operator== ( const ImplicitSharingPtr< T, IsStrong > & a,
const T * b )
friend

Definition at line 134 of file BLI_implicit_sharing_ptr.hh.

◆ operator== [2/2]

template<typename T = ImplicitSharingInfo, bool IsStrong = true>
bool operator== ( const T * a,
const ImplicitSharingPtr< T, IsStrong > & b )
friend

Definition at line 129 of file BLI_implicit_sharing_ptr.hh.

The documentation for this class was generated from the following file:
Generated on for Blender by  doxygen 1.16.1