vtkOpenGLTextureNormalizationHelper Class Reference

GPU-based texture normalization for GLES 3.0 without GL_EXT_texture_norm16. More...

#include <vtkOpenGLTextureNormalizationHelper.h>

Inheritance diagram for vtkOpenGLTextureNormalizationHelper:

Collaboration diagram for vtkOpenGLTextureNormalizationHelper:

Public Types
enum class	ConversionMode { CPU , ComputeShader , CopyTexImage , Unsupported }

Public Member Functions
	vtkAbstractTypeMacro (vtkOpenGLTextureNormalizationHelper, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
ConversionMode	GetConversionMode () const
	Get the preferred conversion mode for this context.
bool	IsGPUConversionAvailable () const
	Check if GPU-assisted conversion is available.
virtual bool	ConvertUShortToFloat (const void *sourceData, size_t numValues, int numComps, unsigned int targetTexture, unsigned int width, unsigned int height)=0
	Convert unsigned short texture data to float in GPU memory.
virtual bool	ConvertShortToFloat (const void *sourceData, size_t numValues, int numComps, unsigned int targetTexture, unsigned int width, unsigned int height)=0
	Convert signed short texture data to float in GPU memory.
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	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 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 vtkSmartPointer< vtkOpenGLTextureNormalizationHelper >	Create (vtkOpenGLRenderWindow *context)
	Create a helper instance appropriate for the given OpenGL context.
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
	vtkOpenGLTextureNormalizationHelper ()=default
	~vtkOpenGLTextureNormalizationHelper () override=default
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	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
ConversionMode	Mode = ConversionMode::CPU
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

GPU-based texture normalization for GLES 3.0 without GL_EXT_texture_norm16.

This helper provides zero-copy conversion of 16-bit integer texture data to normalized float format using GPU-assisted operations on GLES 3.0.

When GL_EXT_texture_norm16 is unavailable on GLES 3.0, this helper converts 16-bit integer texture data to normalized 32-bit float format using GPU operations instead of CPU conversion, eliminating the memory overhead of temporary float vectors.

Supported conversions:

• VTK_UNSIGNED_SHORT -> GL_R32F (dividing by 65535.0)
• VTK_SHORT -> GL_R32F (dividing by 32767.0)
• Multi-channel variants (RG32F, RGB32F, RGBA32F)

Use Create() to obtain a concrete subclass appropriate for the current OpenGL context. Concrete implementations are:

• vtkOpenGLTextureCPUNormalization: CPU-based fallback
• vtkOpenGLTextureComputeShaderNormalization: GPU compute shader (GL 4.3+)
• vtkOpenGLTextureFramebufferNormalization: Framebuffer-based shader conversion

Definition at line 37 of file vtkOpenGLTextureNormalizationHelper.h.

Member Enumeration Documentation

ConversionMode

enum class vtkOpenGLTextureNormalizationHelper::ConversionMode

strong

Enumerator
CPU
ComputeShader
CopyTexImage
Unsupported

Definition at line 44 of file vtkOpenGLTextureNormalizationHelper.h.

Constructor & Destructor Documentation

vtkOpenGLTextureNormalizationHelper()

vtkOpenGLTextureNormalizationHelper::vtkOpenGLTextureNormalizationHelper ( )

protecteddefault

~vtkOpenGLTextureNormalizationHelper()

vtkOpenGLTextureNormalizationHelper::~vtkOpenGLTextureNormalizationHelper ( )

overrideprotecteddefault

Member Function Documentation

vtkAbstractTypeMacro()

vtkOpenGLTextureNormalizationHelper::vtkAbstractTypeMacro	(	vtkOpenGLTextureNormalizationHelper	,
		vtkObject	)

PrintSelf()

void vtkOpenGLTextureNormalizationHelper::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.

Create()

static vtkSmartPointer< vtkOpenGLTextureNormalizationHelper > vtkOpenGLTextureNormalizationHelper::Create ( vtkOpenGLRenderWindow * context )

static

Create a helper instance appropriate for the given OpenGL context.

Selects the best available implementation based on OpenGL capabilities.

GetConversionMode()

ConversionMode vtkOpenGLTextureNormalizationHelper::GetConversionMode ( ) const

inline

Get the preferred conversion mode for this context.

Definition at line 62 of file vtkOpenGLTextureNormalizationHelper.h.

IsGPUConversionAvailable()

bool vtkOpenGLTextureNormalizationHelper::IsGPUConversionAvailable ( ) const

inline

Check if GPU-assisted conversion is available.

Definition at line 67 of file vtkOpenGLTextureNormalizationHelper.h.

ConvertUShortToFloat()

virtual bool vtkOpenGLTextureNormalizationHelper::ConvertUShortToFloat ( const void * sourceData, size_t numValues, int numComps, unsigned int targetTexture, unsigned int width, unsigned int height )

pure virtual

Convert unsigned short texture data to float in GPU memory.

Parameters

sourceData	Pointer to VTK_UNSIGNED_SHORT data
numValues	Total number of short values
numComps	Number of components (1, 2, 3, or 4)
targetTexture	Handle to target GL_R32F/GL_RG32F/etc texture
width	Texture width
height	Texture height

Returns

true if conversion succeeded

Implemented in vtkOpenGLTextureCPUNormalization, and vtkOpenGLTextureFramebufferNormalization.

ConvertShortToFloat()

virtual bool vtkOpenGLTextureNormalizationHelper::ConvertShortToFloat ( const void * sourceData, size_t numValues, int numComps, unsigned int targetTexture, unsigned int width, unsigned int height )

pure virtual

Convert signed short texture data to float in GPU memory.

Parameters

sourceData	Pointer to VTK_SHORT data
numValues	Total number of short values
numComps	Number of components (1, 2, 3, or 4)
targetTexture	Handle to target GL_R32F/GL_RG32F/etc texture
width	Texture width
height	Texture height

Returns

true if conversion succeeded

Implemented in vtkOpenGLTextureCPUNormalization, and vtkOpenGLTextureFramebufferNormalization.

Member Data Documentation

Mode

ConversionMode vtkOpenGLTextureNormalizationHelper::Mode = ConversionMode::CPU

protected

Definition at line 104 of file vtkOpenGLTextureNormalizationHelper.h.

---

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

• Rendering/OpenGL2/vtkOpenGLTextureNormalizationHelper.h