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. More... | |
| vtkTextureUnitManager * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Methods invoked by print to print information about the object including superclasses. More... | |
| int | GetNumberOfTextureUnits () |
| Number of texture units supported by the OpenGL context. More... | |
| virtual int | Allocate () |
| Reserve a texture unit. More... | |
| virtual int | Allocate (int unit) |
| Reserve a specific texture unit if not already in use. More... | |
| bool | IsAllocated (int textureUnitId) |
| Tell if texture unit `textureUnitId' is already allocated. More... | |
| virtual void | Free (int textureUnitId) |
| Release a texture unit. More... | |
| void | SetContext (vtkOpenGLRenderWindow *context) |
| Get/Set the context. More... | |
| virtual vtkOpenGLRenderWindow * | GetContext () |
| Get/Set the context. More... | |
 Public Member Functions inherited from vtkObject | |
| vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
| virtual void | DebugOn () |
| Turn debugging output on. More... | |
| virtual void | DebugOff () |
| Turn debugging output off. More... | |
| bool | GetDebug () |
| Get the value of the debug flag. More... | |
| void | SetDebug (bool debugFlag) |
| Set the value of the debug flag. More... | |
| virtual void | Modified () |
| Update the modification time for this object. More... | |
| virtual vtkMTimeType | GetMTime () |
| Return this object's modified time. More... | |
| 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) |
| int | InvokeEvent (unsigned long event) |
| int | InvokeEvent (const char *event) |
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkCommand * | GetCommand (unsigned long tag) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObserver (vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| void | RemoveObservers (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| int | InvokeEvent (unsigned long event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| int | InvokeEvent (const char *event, void *callData) |
| This method invokes an event and return whether the event was aborted or not. More... | |
| Public Member Functions inherited from vtkObjectBase | |
| const char * | GetClassName () const |
| Return the class name as a string. More... | |
| virtual void | Delete () |
| Delete a VTK object. More... | |
| virtual void | FastDelete () |
| Delete a reference to this object. More... | |
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| Print an object to an ostream. More... | |
| virtual void | Register (vtkObjectBase *o) |
| Increase the reference count (mark as used by another object). More... | |
| virtual void | UnRegister (vtkObjectBase *o) |
| Decrease the reference count (release by another object). More... | |
| int | GetReferenceCount () |
| Return the current reference count of this object. More... | |
| void | SetReferenceCount (int) |
| Sets the reference count. More... | |
| void | PrintRevisions (ostream &) |
| Legacy. More... | |
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| Methods invoked by print to print information about the object including superclasses. More... | |
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. More... | |
| static void | BreakOnError () |
| This method is called when vtkErrorMacro executes. More... | |
| static void | SetGlobalWarningDisplay (int val) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOn () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static void | GlobalWarningDisplayOff () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| static int | GetGlobalWarningDisplay () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
| 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. More... | |
| static vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkTextureUnitManager () | |
| Default constructor. More... | |
| ~vtkTextureUnitManager () override | |
| Destructor. More... | |
| void | DeleteTable () |
| Delete the allocation table and check if it is not called before all the texture units have been released. More... | |
| 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. More... | |
| void | InternalReleaseFocus () |
| These methods allow a command to exclusively grab all events. More... | |
| 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 38 of file vtkTextureUnitManager.h.
Member Typedef Documentation
Definition at line 41 of file vtkTextureUnitManager.h.
Constructor & Destructor Documentation
|
protected |
Default constructor.
|
overrideprotected |
Destructor.
Member Function Documentation
|
static |
|
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.
|
static |
|
protectedvirtual |
| vtkTextureUnitManager* vtkTextureUnitManager::NewInstance | ( | ) | const |
|
overridevirtual |
|
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 |
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 |
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)
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 |
Release a texture unit.
- Precondition
- valid_textureUnitId: textureUnitId>=0 && textureUnitId<this->GetNumberOfTextureUnits()
- allocated_textureUnitId: this->IsAllocated(textureUnitId)
|
protected |
Delete the allocation table and check if it is not called before all the texture units have been released.
Member Data Documentation
|
protected |
Definition at line 115 of file vtkTextureUnitManager.h.
|
protected |
Definition at line 117 of file vtkTextureUnitManager.h.
|
protected |
Definition at line 118 of file vtkTextureUnitManager.h.
The documentation for this class was generated from the following file:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkTextureUnitManager.h
