Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

Ogre::CompositorPtr Class Reference

Specialisation of SharedPtr to allow SharedPtr to be assigned to CompositorPtr. More...

#include <OgreCompositor.h>

Inheritance diagram for Ogre::CompositorPtr:

Ogre::SharedPtr< Compositor > List of all members.

Public Member Functions

 CompositorPtr ()
 CompositorPtr (Compositor *rep)
 CompositorPtr (const CompositorPtr &r)
 CompositorPtr (const ResourcePtr &r)
CompositorPtroperator= (const ResourcePtr &r)
 Operator used to convert a ResourcePtr to a CompositorPtr.

Compositoroperator * () const
Compositoroperator-> () const
Compositorget () const
void bind (Compositor *rep)
 Binds rep to the SharedPtr.

bool unique () const
unsigned int useCount () const
unsigned int * useCountPointer () const
CompositorgetPointer () const
bool isNull (void) const
void setNull (void)

Protected Member Functions

void release (void)
virtual void destroy (void)

Protected Attributes

CompositorpRep
unsigned int * pUseCount

Detailed Description

Specialisation of SharedPtr to allow SharedPtr to be assigned to CompositorPtr.

Note:
Has to be a subclass since we need operator=. We could templatise this instead of repeating per Resource subclass, except to do so requires a form VC6 does not support i.e. ResourceSubclassPtr<T> : public SharedPtr<T>

Definition at line 124 of file OgreCompositor.h.


Constructor & Destructor Documentation

Ogre::CompositorPtr::CompositorPtr  ) 
 

Definition at line 127 of file OgreCompositor.h.

Ogre::CompositorPtr::CompositorPtr Compositor rep  )  [explicit]
 

Definition at line 128 of file OgreCompositor.h.

Ogre::CompositorPtr::CompositorPtr const CompositorPtr r  ) 
 

Definition at line 129 of file OgreCompositor.h.

Ogre::CompositorPtr::CompositorPtr const ResourcePtr r  ) 
 

Definition at line 130 of file OgreCompositor.h.

References Ogre::SharedPtr< T >::getPointer(), OGRE_COPY_AUTO_SHARED_MUTEX, OGRE_LOCK_MUTEX, Ogre::ResourcePtr, and Ogre::SharedPtr< T >::useCountPointer().


Member Function Documentation

void Ogre::SharedPtr< Compositor >::bind Compositor rep  )  [inherited]
 

Binds rep to the SharedPtr.

Remarks:
Assumes that the SharedPtr is uninitialised!

Definition at line 100 of file OgreSharedPtr.h.

virtual void Ogre::SharedPtr< Compositor >::destroy void   )  [protected, virtual, inherited]
 

Definition at line 146 of file OgreSharedPtr.h.

Compositor * Ogre::SharedPtr< Compositor >::get  )  const [inherited]
 

Definition at line 94 of file OgreSharedPtr.h.

Compositor * Ogre::SharedPtr< Compositor >::getPointer  )  const [inherited]
 

Definition at line 112 of file OgreSharedPtr.h.

bool Ogre::SharedPtr< Compositor >::isNull void   )  const [inherited]
 

Definition at line 114 of file OgreSharedPtr.h.

Compositor & Ogre::SharedPtr< Compositor >::operator *  )  const [inherited]
 

Definition at line 92 of file OgreSharedPtr.h.

Compositor * Ogre::SharedPtr< Compositor >::operator->  )  const [inherited]
 

Definition at line 93 of file OgreSharedPtr.h.

CompositorPtr& Ogre::CompositorPtr::operator= const ResourcePtr r  ) 
 

Operator used to convert a ResourcePtr to a CompositorPtr.

Definition at line 144 of file OgreCompositor.h.

References Ogre::SharedPtr< T >::getPointer(), OGRE_COPY_AUTO_SHARED_MUTEX, OGRE_LOCK_MUTEX, Ogre::ResourcePtr, and Ogre::SharedPtr< T >::useCountPointer().

void Ogre::SharedPtr< Compositor >::release void   )  [protected, inherited]
 

Definition at line 129 of file OgreSharedPtr.h.

void Ogre::SharedPtr< Compositor >::setNull void   )  [inherited]
 

Definition at line 116 of file OgreSharedPtr.h.

bool Ogre::SharedPtr< Compositor >::unique  )  const [inherited]
 

Definition at line 108 of file OgreSharedPtr.h.

unsigned int Ogre::SharedPtr< Compositor >::useCount  )  const [inherited]
 

Definition at line 109 of file OgreSharedPtr.h.

unsigned int* Ogre::SharedPtr< Compositor >::useCountPointer  )  const [inherited]
 

Definition at line 110 of file OgreSharedPtr.h.


Member Data Documentation

Compositor * Ogre::SharedPtr< Compositor >::pRep [protected, inherited]
 

Definition at line 46 of file OgreSharedPtr.h.

unsigned int* Ogre::SharedPtr< Compositor >::pUseCount [protected, inherited]
 

Definition at line 47 of file OgreSharedPtr.h.


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:38:28 2006