allocate/free texture units. More...

#include <vtkTextureUnitManager.h>

Inheritance diagram for vtkTextureUnitManager:

Collaboration diagram for vtkTextureUnitManager:

Public Types
typedef vtkObject	Superclass

typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkTextureUnitManager *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	GetNumberOfTextureUnits ()

virtual int	Allocate ()

bool	IsAllocated (int textureUnitId)

virtual void	Free (int textureUnitId)

virtual int	IsA (const char *type)

vtkTextureUnitManager *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	GetNumberOfTextureUnits ()

virtual int	Allocate ()

virtual int	Allocate (int unit)

bool	IsAllocated (int textureUnitId)

virtual void	Free (int textureUnitId)


void	SetContext (vtkOpenGLRenderWindow *context)

virtual vtkOpenGLRenderWindow *	GetContext ()


void	SetContext (vtkOpenGLRenderWindow *context)

virtual vtkOpenGLRenderWindow *	GetContext ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkTextureUnitManager *	SafeDownCast (vtkObjectBase *o)

static vtkTextureUnitManager *	New ()

static int	IsTypeOf (const char *type)

static vtkTextureUnitManager *	SafeDownCast (vtkObjectBase *o)

static vtkTextureUnitManager *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTextureUnitManager ()

	~vtkTextureUnitManager ()

void	DeleteTable ()

virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTextureUnitManager ()

	~vtkTextureUnitManager ()

void	DeleteTable ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkOpenGLRenderWindow *	Context

int	NumberOfTextureUnits

bool *	TextureUnits

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

allocate/free texture units.

vtkTextureUnitManager is a central place used by shaders to reserve a texture unit ( Allocate() ) or release it ( Free() ).

Don't create a vtkTextureUnitManager, query it from the vtkOpenGLRenderWindow

See also: vtkOpenGLRenderWindow

Definition at line 37 of file vtkTextureUnitManager.h.

Member Typedef Documentation

typedef vtkObject vtkTextureUnitManager::Superclass

Definition at line 40 of file vtkTextureUnitManager.h.

typedef vtkObject vtkTextureUnitManager::Superclass

Definition at line 40 of file vtkTextureUnitManager.h.

Constructor & Destructor Documentation

vtkTextureUnitManager::vtkTextureUnitManager ( )

protected

Default constructor.

vtkTextureUnitManager::~vtkTextureUnitManager ( )

protected

Destructor.

vtkTextureUnitManager::vtkTextureUnitManager ( )

protected

Default constructor.

vtkTextureUnitManager::~vtkTextureUnitManager ( )

protected

Destructor.

Member Function Documentation

static int vtkTextureUnitManager::IsTypeOf ( const char * type )

static

virtual int vtkTextureUnitManager::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkTextureUnitManager* vtkTextureUnitManager::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkTextureUnitManager::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkTextureUnitManager* vtkTextureUnitManager::NewInstance ( ) const

void vtkTextureUnitManager::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static vtkTextureUnitManager* vtkTextureUnitManager::New ( )

static

void vtkTextureUnitManager::SetContext ( vtkOpenGLRenderWindow * context )

Get/Set the context. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions.

virtual vtkOpenGLRenderWindow* vtkTextureUnitManager::GetContext ( )

virtual

Get/Set the context. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions.

int vtkTextureUnitManager::GetNumberOfTextureUnits ( )

Number of texture units supported by the OpenGL context.

virtual int vtkTextureUnitManager::Allocate ( )

virtual

Reserve a texture unit. It returns its number. It returns -1 if the allocation failed (because there is no more texture unit left).

Postcondition: valid_result: result==-1 || result>=0 && result<this->GetNumberOfTextureUnits()); allocated: result==-1 || this->IsAllocated(result)

bool vtkTextureUnitManager::IsAllocated ( int textureUnitId )

Tell if texture unit `textureUnitId' is already allocated.

Precondition: valid_textureUnitId_range : textureUnitId>=0 && textureUnitId<this->GetNumberOfTextureUnits()

virtual void vtkTextureUnitManager::Free ( int textureUnitId )

virtual

Release a texture unit.

Precondition: valid_textureUnitId: textureUnitId>=0 && textureUnitId<this->GetNumberOfTextureUnits(); allocated_textureUnitId: this->IsAllocated(textureUnitId)

void vtkTextureUnitManager::DeleteTable ( )

protected

Delete the allocation table and check if it is not called before all the texture units have been released.

static int vtkTextureUnitManager::IsTypeOf ( const char * type )

static

virtual int vtkTextureUnitManager::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkTextureUnitManager* vtkTextureUnitManager::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkTextureUnitManager::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkTextureUnitManager* vtkTextureUnitManager::NewInstance ( ) const

void vtkTextureUnitManager::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static vtkTextureUnitManager* vtkTextureUnitManager::New ( )

static

void vtkTextureUnitManager::SetContext ( vtkOpenGLRenderWindow * context )

Get/Set the context. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions.

virtual vtkOpenGLRenderWindow* vtkTextureUnitManager::GetContext ( )

virtual

Get/Set the context. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions.

int vtkTextureUnitManager::GetNumberOfTextureUnits ( )

Number of texture units supported by the OpenGL context.

virtual int vtkTextureUnitManager::Allocate ( )

virtual

Reserve a texture unit. It returns its number. It returns -1 if the allocation failed (because there are no more texture units left).

Postcondition: valid_result: result==-1 || result>=0 && result<this->GetNumberOfTextureUnits()); allocated: result==-1 || this->IsAllocated(result)

virtual int vtkTextureUnitManager::Allocate ( int unit )

virtual

Reserve a specific texture unit if not already in use. This method should only be used when interacting with 3rd party code that is allocating and using textures. It allows someone to reserve a texture unit for that code and later release it. VTK will not use that texture unit until it is released. It returns -1 if the allocation failed (because there are no more texture units left).

Postcondition: valid_result: result==-1 || result>=0 && result<this->GetNumberOfTextureUnits()); allocated: result==-1 || this->IsAllocated(result)

bool vtkTextureUnitManager::IsAllocated ( int textureUnitId )

Tell if texture unit `textureUnitId' is already allocated.

Precondition: valid_textureUnitId_range : textureUnitId>=0 && textureUnitId<this->GetNumberOfTextureUnits()

virtual void vtkTextureUnitManager::Free ( int textureUnitId )

virtual

Release a texture unit.

Precondition: valid_textureUnitId: textureUnitId>=0 && textureUnitId<this->GetNumberOfTextureUnits(); allocated_textureUnitId: this->IsAllocated(textureUnitId)

void vtkTextureUnitManager::DeleteTable ( )

protected

Delete the allocation table and check if it is not called before all the texture units have been released.

Member Data Documentation

vtkOpenGLRenderWindow * vtkTextureUnitManager::Context

protected

Definition at line 86 of file vtkTextureUnitManager.h.

int vtkTextureUnitManager::NumberOfTextureUnits

protected

Definition at line 88 of file vtkTextureUnitManager.h.

bool * vtkTextureUnitManager::TextureUnits

protected

Definition at line 89 of file vtkTextureUnitManager.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkTextureUnitManager.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation