omni::visual::ContextBoundPtr< T, DELETER > Struct Template Reference

A pointer template which is free'd together with its context Holds an internal object which is responsible for freeing the held object when OpenGL context is free'd. More...

#include <ContextBoundPtr.h>

Collaboration diagram for omni::visual::ContextBoundPtr< T, DELETER >:

Public Member Functions
	ContextBoundPtr ()
template<typename PTR >
	ContextBoundPtr (PTR *_p, QOpenGLContext *_context=QOpenGLContext::globalShareContext())
	~ContextBoundPtr ()
	ContextBoundPtr (const ContextBoundPtr &that)=delete
	Delete copy constructor. More...
ContextBoundPtr &	operator= (const ContextBoundPtr &)=delete
	Delete copy assignment operator. More...
void	reset ()
	Delete held object and internal state. More...
template<typename PTR >
T *	reset (PTR *_p, QOpenGLContext *_context=QOpenGLContext::globalShareContext())
	Reset and and assign neew pointer. More...
T *	get () const
	operator bool () const
	Cast to bool operator. Return true if pointer is not null. More...
std::add_lvalue_reference< T > ::type	operator* () const
	Return reference. More...
T *	operator-> () const
QOpenGLContext *	context () const
	Return pointer to associated context. More...

Private Attributes
detail::ContextBoundPtrInternal < T > *	internal_ = nullptr

Detailed Description

template<typename T, typename DELETER>
struct omni::visual::ContextBoundPtr< T, DELETER >

A pointer template which is free'd together with its context Holds an internal object which is responsible for freeing the held object when OpenGL context is free'd.

Constructor & Destructor Documentation

template<typename T, typename DELETER>

omni::visual::ContextBoundPtr< T, DELETER >::ContextBoundPtr ( )

inline

{}

template<typename T, typename DELETER>

template<typename PTR >

omni::visual::ContextBoundPtr< T, DELETER >::ContextBoundPtr ( PTR *  _p, QOpenGLContext *  _context = QOpenGLContext::globalShareContext()  )

inline

                                                          {
        reset(_p, _context);
      }

template<typename T, typename DELETER>

omni::visual::ContextBoundPtr< T, DELETER >::~ContextBoundPtr ( )

inline

                         {
        // Internal is not deleted here because its done by the bound context
        //reset();
      }

template<typename T, typename DELETER>

omni::visual::ContextBoundPtr< T, DELETER >::ContextBoundPtr ( const ContextBoundPtr< T, DELETER > &  that )

delete

Delete copy constructor.

Member Function Documentation

template<typename T, typename DELETER>

QOpenGLContext* omni::visual::ContextBoundPtr< T, DELETER >::context ( ) const

inline

Return pointer to associated context.

                                      {
        return internal_ ? internal_->context_ : nullptr;
      }

template<typename T, typename DELETER>

T* omni::visual::ContextBoundPtr< T, DELETER >::get ( ) const

inline

                     {
        return internal_ ? internal_->ptr_ : nullptr;
      }

template<typename T, typename DELETER>

omni::visual::ContextBoundPtr< T, DELETER >::operator bool ( ) const

inlineexplicit

Cast to bool operator. Return true if pointer is not null.

                                     {
        return get() != nullptr;
      }

template<typename T, typename DELETER>

std::add_lvalue_reference<T>::type omni::visual::ContextBoundPtr< T, DELETER >::operator* ( ) const

inline

Return reference.

                                                                {
        return *get();
      }

template<typename T, typename DELETER>

T* omni::visual::ContextBoundPtr< T, DELETER >::operator-> ( ) const

inline

                             {
        return get();
      }

template<typename T, typename DELETER>

ContextBoundPtr& omni::visual::ContextBoundPtr< T, DELETER >::operator= ( const ContextBoundPtr< T, DELETER > &  )

delete

Delete copy assignment operator.

template<typename T, typename DELETER>

void omni::visual::ContextBoundPtr< T, DELETER >::reset ( )

inline

Delete held object and internal state.

                   {
        if (internal_) {
          delete internal_;
          internal_ = nullptr;
        }
      }

template<typename T, typename DELETER>

template<typename PTR >

T* omni::visual::ContextBoundPtr< T, DELETER >::reset ( PTR *  _p, QOpenGLContext *  _context = QOpenGLContext::globalShareContext()  )

inline

Reset and and assign neew pointer.

Reset and make new internal object

No initialization without context!

                                                                              {
        /// Reset and make new internal object
        reset();
        /// No initialization without context!
        bool _valid = _context ? _context->surface() != nullptr : false;
        if (!_valid) {
          return nullptr;
        }

        internal_ = new detail::ContextBoundPtrInternal<T,DELETER>(_p, _context);

        return get();
      }

Field Documentation

template<typename T, typename DELETER>

detail::ContextBoundPtrInternal<T>* omni::visual::ContextBoundPtr< T, DELETER >::internal_ = nullptr

private

---

The documentation for this struct was generated from the following file:

• include/omni/visual/ContextBoundPtr.h