Framebuffer-based shader conversion for 16-bit to float texture normalization. More...

#include <vtkOpenGLTextureFramebufferNormalization.h>

Inheritance diagram for vtkOpenGLTextureFramebufferNormalization:

Collaboration diagram for vtkOpenGLTextureFramebufferNormalization:

Public Types
typedef vtkOpenGLTextureNormalizationHelper	Superclass

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

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.

vtkOpenGLTextureFramebufferNormalization *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	Initialize (vtkOpenGLRenderWindow *context)
	Initialize the framebuffer conversion helper with the given render window context.

bool	ConvertUShortToFloat (const void *sourceData, size_t numValues, int numComps, unsigned int targetTexture, unsigned int width, unsigned int height) override
	Convert unsigned short texture data to float in GPU memory.

bool	ConvertShortToFloat (const void *sourceData, size_t numValues, int numComps, unsigned int targetTexture, unsigned int width, unsigned int height) override
	Convert signed short texture data to float in GPU memory.

Public Member Functions inherited from vtkOpenGLTextureNormalizationHelper
	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.

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 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 vtkOpenGLTextureFramebufferNormalization *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOpenGLTextureFramebufferNormalization *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkOpenGLTextureNormalizationHelper
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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOpenGLTextureFramebufferNormalization ()

	~vtkOpenGLTextureFramebufferNormalization () override

bool	InitializeConversionShader ()

bool	UploadToIntermediateTexture (const void *sourceData, size_t numValues, int numComps, unsigned int width, unsigned int height, GLenum internalFormat, GLenum dataFormat)

bool	PerformFramebufferConversion (unsigned int targetTexture, int numComps, unsigned int width, unsigned int height, float scaleFactor)

Protected Member Functions inherited from vtkOpenGLTextureNormalizationHelper
	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
vtkOpenGLRenderWindow *	Context = nullptr

GLuint	ConversionProgram = 0

GLuint	IntermediateTexture = 0

GLuint	ConversionFramebuffer = 0

GLuint	ConversionVAO = 0

Protected Attributes inherited from vtkOpenGLTextureNormalizationHelper
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

Framebuffer-based shader conversion for 16-bit to float texture normalization.

Uses a framebuffer with a fragment shader to convert 16-bit integer texture data to normalized 32-bit float. This is the preferred GPU path when compute shaders are unavailable (e.g., on GLES 3.0 without GL_ARB_compute_shader).

Strategy:

Upload integer data to a temporary R16UI/R16I texture
Use a shader program that samples from R16UI and writes to R32F
Render a fullscreen quad to perform the conversion

Call Initialize() after New() to bind the helper to an OpenGL context. If initialization fails, GetConversionMode() returns Unsupported.

See also: vtkOpenGLTextureNormalizationHelper, vtkOpenGLTextureCPUNormalization, vtkOpenGLTextureComputeShaderNormalization

Definition at line 34 of file vtkOpenGLTextureFramebufferNormalization.h.

Member Typedef Documentation

◆ Superclass

typedef vtkOpenGLTextureNormalizationHelper vtkOpenGLTextureFramebufferNormalization::Superclass

Definition at line 39 of file vtkOpenGLTextureFramebufferNormalization.h.

Constructor & Destructor Documentation

◆ vtkOpenGLTextureFramebufferNormalization()

vtkOpenGLTextureFramebufferNormalization::vtkOpenGLTextureFramebufferNormalization ( )

protected

◆ ~vtkOpenGLTextureFramebufferNormalization()

vtkOpenGLTextureFramebufferNormalization::~vtkOpenGLTextureFramebufferNormalization ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkOpenGLTextureFramebufferNormalization * vtkOpenGLTextureFramebufferNormalization::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkOpenGLTextureFramebufferNormalization::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 vtkOpenGLTextureFramebufferNormalization * vtkOpenGLTextureFramebufferNormalization::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOpenGLTextureFramebufferNormalization::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkOpenGLTextureFramebufferNormalization * vtkOpenGLTextureFramebufferNormalization::NewInstance ( ) const

◆ PrintSelf()

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

◆ Initialize()

void vtkOpenGLTextureFramebufferNormalization::Initialize ( vtkOpenGLRenderWindow * context )

Initialize the framebuffer conversion helper with the given render window context.

Must be called after New() before using the helper. Sets Mode to Unsupported if initialization fails.

◆ ConvertUShortToFloat()

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

overridevirtual

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

Implements vtkOpenGLTextureNormalizationHelper.

◆ ConvertShortToFloat()

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

overridevirtual

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

Implements vtkOpenGLTextureNormalizationHelper.

◆ InitializeConversionShader()

bool vtkOpenGLTextureFramebufferNormalization::InitializeConversionShader ( )

protected

◆ UploadToIntermediateTexture()

bool vtkOpenGLTextureFramebufferNormalization::UploadToIntermediateTexture	(	const void *	sourceData,
		size_t	numValues,
		int	numComps,
		unsigned int	width,
		unsigned int	height,
		GLenum	internalFormat,
		GLenum	dataFormat )

protected

◆ PerformFramebufferConversion()

bool vtkOpenGLTextureFramebufferNormalization::PerformFramebufferConversion	(	unsigned int	targetTexture,
		int	numComps,
		unsigned int	width,
		unsigned int	height,
		float	scaleFactor )

protected

Member Data Documentation

◆ Context

vtkOpenGLRenderWindow* vtkOpenGLTextureFramebufferNormalization::Context = nullptr

protected

Definition at line 59 of file vtkOpenGLTextureFramebufferNormalization.h.

◆ ConversionProgram

GLuint vtkOpenGLTextureFramebufferNormalization::ConversionProgram = 0

protected

Definition at line 60 of file vtkOpenGLTextureFramebufferNormalization.h.

◆ IntermediateTexture

GLuint vtkOpenGLTextureFramebufferNormalization::IntermediateTexture = 0

protected

Definition at line 61 of file vtkOpenGLTextureFramebufferNormalization.h.

◆ ConversionFramebuffer

GLuint vtkOpenGLTextureFramebufferNormalization::ConversionFramebuffer = 0

protected

Definition at line 62 of file vtkOpenGLTextureFramebufferNormalization.h.

◆ ConversionVAO

GLuint vtkOpenGLTextureFramebufferNormalization::ConversionVAO = 0

protected

Definition at line 63 of file vtkOpenGLTextureFramebufferNormalization.h.

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

Rendering/OpenGL2/vtkOpenGLTextureFramebufferNormalization.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOpenGLTextureFramebufferNormalization()

◆ ~vtkOpenGLTextureFramebufferNormalization()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Initialize()

◆ ConvertUShortToFloat()

◆ ConvertShortToFloat()

◆ InitializeConversionShader()

◆ UploadToIntermediateTexture()

◆ PerformFramebufferConversion()

Member Data Documentation

◆ Context

◆ ConversionProgram

◆ IntermediateTexture

◆ ConversionFramebuffer

◆ ConversionVAO