vtkTextureUnitManager Class Reference

allocate/free texture units. More...

#include <vtkTextureUnitManager.h>

Inheritance diagram for vtkTextureUnitManager:

Collaboration diagram for vtkTextureUnitManager:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkTextureUnitManager *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Initialize ()
	Update the number of hardware texture units for the current context.
int	GetNumberOfTextureUnits ()
	Number of texture units supported by the OpenGL context.
virtual int	Allocate ()
	Reserve a texture unit.
virtual int	Allocate (int unit)
	Reserve a specific texture unit if not already in use.
bool	IsAllocated (int textureUnitId)
	Tell if texture unit ‘textureUnitId’ is already allocated.
virtual void	Free (int textureUnitId)
	Release a texture unit.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkTextureUnitManager *	SafeDownCast (vtkObjectBase *o)
static vtkTextureUnitManager *	New ()
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTextureUnitManager ()
	Default constructor.
	~vtkTextureUnitManager () override
	Destructor.
void	DeleteTable ()
	Delete the allocation table and check if it is not called before all the texture units have been released.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	NumberOfTextureUnits
bool *	TextureUnits
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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 27 of file vtkTextureUnitManager.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkTextureUnitManager::Superclass

Definition at line 30 of file vtkTextureUnitManager.h.

Constructor & Destructor Documentation

vtkTextureUnitManager()

vtkTextureUnitManager::vtkTextureUnitManager ( )

protected

Default constructor.

~vtkTextureUnitManager()

vtkTextureUnitManager::~vtkTextureUnitManager ( )

overrideprotected

Destructor.

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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 vtkObjectBase.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkTextureUnitManager::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkTextureUnitManager * vtkTextureUnitManager::NewInstance

(

)

const

PrintSelf()

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

overridevirtual

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.

New()

static vtkTextureUnitManager * vtkTextureUnitManager::New ( )

static

Initialize()

void vtkTextureUnitManager::Initialize

(

)

Update the number of hardware texture units for the current context.

GetNumberOfTextureUnits()

int vtkTextureUnitManager::GetNumberOfTextureUnits

(

)

Number of texture units supported by the OpenGL context.

Allocate() [1/2]

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)

Allocate() [2/2]

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)

IsAllocated()

bool vtkTextureUnitManager::IsAllocated

(

int

textureUnitId

)

Tell if texture unit ‘textureUnitId’ is already allocated.

Precondition

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

Free()

virtual void vtkTextureUnitManager::Free ( int  textureUnitId )

virtual

Release a texture unit.

Precondition

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

allocated_textureUnitId: this->IsAllocated(textureUnitId)

DeleteTable()

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

NumberOfTextureUnits

int vtkTextureUnitManager::NumberOfTextureUnits

protected

Definition at line 99 of file vtkTextureUnitManager.h.

TextureUnits

bool* vtkTextureUnitManager::TextureUnits

protected

Definition at line 100 of file vtkTextureUnitManager.h.

---

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

• Rendering/OpenGL2/vtkTextureUnitManager.h