Ogre::CompositorPtr Class Reference
[Effects]

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

#include <OgreCompositor.h>

Inheritance diagram for Ogre::CompositorPtr:

[legend]

List of all members.

Public Member Functions
	CompositorPtr ()
	CompositorPtr (Compositor *rep)
	CompositorPtr (const CompositorPtr &r)
	CompositorPtr (const ResourcePtr &r)
CompositorPtr &	operator= (const ResourcePtr &r)
	Operator used to convert a ResourcePtr to a CompositorPtr.
Compositor &	operator* () const
Compositor *	operator-> () const
Compositor *	get () const
void	bind (Compositor *rep, SharedPtrFreeMethod inFreeMethod=SPFM_DELETE)
	Binds rep to the SharedPtr.
bool	unique () const
unsigned int	useCount () const
unsigned int *	useCountPointer () const
Compositor *	getPointer () const
SharedPtrFreeMethod	freeMethod () const
bool	isNull (void) const
void	setNull (void)
Protected Member Functions
void	release (void)
virtual void	destroy (void)
virtual void	swap (SharedPtr< Compositor > &other)
Protected Attributes
Compositor *	pRep
unsigned int *	pUseCount
SharedPtrFreeMethod	useFreeMethod

---

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 182 of file OgreCompositor.h.

---

Constructor & Destructor Documentation

Ogre::CompositorPtr::CompositorPtr

(

)

Definition at line 185 of file OgreCompositor.h.

Ogre::CompositorPtr::CompositorPtr

(

Compositor *

rep

)

[explicit]

Definition at line 186 of file OgreCompositor.h.

Ogre::CompositorPtr::CompositorPtr

(

const CompositorPtr &

r

)

Definition at line 187 of file OgreCompositor.h.

Ogre::CompositorPtr::CompositorPtr

(

const ResourcePtr &

r

)

Definition at line 188 of file OgreCompositor.h.

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

---

Member Function Documentation

void Ogre::SharedPtr< Compositor >::bind	(	Compositor *	rep,
		SharedPtrFreeMethod	inFreeMethod = SPFM_DELETE
	)			[inherited]

Binds rep to the SharedPtr.

Remarks:

Assumes that the SharedPtr is uninitialised!

Definition at line 167 of file OgreSharedPtr.h.

virtual void Ogre::SharedPtr< Compositor >::destroy

(

void

)

[protected, virtual, inherited]

Definition at line 223 of file OgreSharedPtr.h.

SharedPtrFreeMethod Ogre::SharedPtr< Compositor >::freeMethod

(

)

const [inherited]

Definition at line 181 of file OgreSharedPtr.h.

Compositor * Ogre::SharedPtr< Compositor >::get

(

void

)

const [inherited]

Definition at line 161 of file OgreSharedPtr.h.

Compositor * Ogre::SharedPtr< Compositor >::getPointer

(

)

const [inherited]

Definition at line 180 of file OgreSharedPtr.h.

bool Ogre::SharedPtr< Compositor >::isNull

(

void

)

const [inherited]

Definition at line 183 of file OgreSharedPtr.h.

Compositor & Ogre::SharedPtr< Compositor >::operator*

(

)

const [inherited]

Definition at line 159 of file OgreSharedPtr.h.

Compositor * Ogre::SharedPtr< Compositor >::operator->

(

)

const [inherited]

Definition at line 160 of file OgreSharedPtr.h.

CompositorPtr& Ogre::CompositorPtr::operator=

(

const ResourcePtr &

r

)

Operator used to convert a ResourcePtr to a CompositorPtr.

Definition at line 205 of file OgreCompositor.h.

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

void Ogre::SharedPtr< Compositor >::release

(

void

)

[protected, inherited]

Definition at line 197 of file OgreSharedPtr.h.

void Ogre::SharedPtr< Compositor >::setNull

(

void

)

[inherited]

Definition at line 185 of file OgreSharedPtr.h.

virtual void Ogre::SharedPtr< Compositor >::swap

(

SharedPtr< Compositor > &

other

)

[protected, virtual, inherited]

Definition at line 247 of file OgreSharedPtr.h.

bool Ogre::SharedPtr< Compositor >::unique

(

)

const [inherited]

Definition at line 176 of file OgreSharedPtr.h.

unsigned int Ogre::SharedPtr< Compositor >::useCount

(

)

const [inherited]

Definition at line 177 of file OgreSharedPtr.h.

unsigned int* Ogre::SharedPtr< Compositor >::useCountPointer

(

)

const [inherited]

Definition at line 178 of file OgreSharedPtr.h.

---

Member Data Documentation

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

Definition at line 63 of file OgreSharedPtr.h.

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

Definition at line 64 of file OgreSharedPtr.h.

SharedPtrFreeMethod Ogre::SharedPtr< Compositor >::useFreeMethod [protected, inherited]

Definition at line 65 of file OgreSharedPtr.h.

---

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

• OgreCompositor.h