abstracts an OpenGL texture object. More...

#include <vtkTextureObject.h>

Inheritance diagram for vtkTextureObject:

Collaboration diagram for vtkTextureObject:

Public Types
enum	{ Lequal = 0 , Gequal , Less , Greater , Equal , NotEqual , AlwaysTrue , Never , NumberOfDepthTextureCompareFunctions }

enum	{ ClampToEdge = 0 , Repeat , MirroredRepeat , ClampToBorder , NumberOfWrapModes }

enum	{ Nearest = 0 , Linear , NearestMipmapNearest , NearestMipmapLinear , LinearMipmapNearest , LinearMipmapLinear , NumberOfMinificationModes }

enum	{ Native = 0 , Fixed8 , Fixed16 , Fixed24 , Fixed32 , Float16 , Float32 , NumberOfDepthFormats }

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...

vtkTextureObject *	NewInstance () const

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

virtual int	GetNumberOfDimensions ()

virtual void	SetSamples (unsigned int)

int	GetTextureUnit ()
	Return the texture unit used for this texture. More...

virtual void	Activate ()
	Activate and Bind the texture. More...

void	Deactivate ()
	Deactivate and UnBind the texture. More...

virtual void	ReleaseGraphicsResources (vtkWindow *win)
	Deactivate and UnBind the texture. More...

bool	IsBound ()
	Tells if the texture object is bound to the active texture image unit. More...

void	SendParameters ()
	Send all the texture object parameters to the hardware if not done yet. More...

bool	Create2DFromRaw (unsigned int width, unsigned int height, int numComps, int dataType, void *data)
	Create a 2D texture from client memory numComps must be in [1-4]. More...

bool	CreateDepthFromRaw (unsigned int width, unsigned int height, int internalFormat, int rawType, void *raw)
	Create a 2D depth texture using a raw pointer. More...

bool	CreateTextureBuffer (unsigned int numValues, int numComps, int dataType, vtkOpenGLBufferObject *bo)
	Create a texture buffer basically a 1D texture that can be very large for passing data into the fragment shader. More...

bool	CreateCubeFromRaw (unsigned int width, unsigned int height, int numComps, int dataType, void *data[6])
	Create a cube texture from 6 buffers from client memory. More...

bool	Create1D (int numComps, vtkPixelBufferObject *pbo, bool shaderSupportsTextureInt)
	Create a 1D texture using the PBO. More...

bool	Create1DFromRaw (unsigned int width, int numComps, int dataType, void *data)
	Create 1D texture from client memory. More...

bool	Create2D (unsigned int width, unsigned int height, int numComps, vtkPixelBufferObject *pbo, bool shaderSupportsTextureInt)
	Create a 2D texture using the PBO. More...

bool	Create3D (unsigned int width, unsigned int height, unsigned int depth, int numComps, vtkPixelBufferObject *pbo, bool shaderSupportsTextureInt)
	Create a 3D texture using the PBO. More...

bool	Create3DFromRaw (unsigned int width, unsigned int height, unsigned int depth, int numComps, int dataType, void *data)
	Create a 3D texture from client memory numComps must be in [1-4]. More...

bool	AllocateProxyTexture3D (unsigned int const width, unsigned int const height, unsigned int const depth, int const numComps, int const dataType)
	Create a 3D texture using the GL_PROXY_TEXTURE_3D target. More...

vtkPixelBufferObject *	Download ()
	This is used to download raw data from the texture into a pixel buffer. More...

vtkPixelBufferObject *	Download (unsigned int target, unsigned int level)

bool	CreateDepth (unsigned int width, unsigned int height, int internalFormat, vtkPixelBufferObject *pbo)
	Create a 2D depth texture using a PBO. More...

bool	AllocateDepth (unsigned int width, unsigned int height, int internalFormat)
	Create a 2D depth texture but does not initialize its values. More...

bool	AllocateDepthStencil (unsigned int width, unsigned int height)
	Create a 2D septh stencil texture but does not initialize its values. More...

bool	Allocate1D (unsigned int width, int numComps, int vtkType)
	Create a 1D color texture but does not initialize its values. More...

bool	Allocate2D (unsigned int width, unsigned int height, int numComps, int vtkType, int level=0)
	Create a 2D color texture but does not initialize its values. More...

bool	Allocate3D (unsigned int width, unsigned int height, unsigned int depth, int numComps, int vtkType)
	Create a 3D color texture but does not initialize its values. More...

int	GetVTKDataType ()
	Get the data type for the texture as a vtk type int i.e. More...

void	ResetFormatAndType ()
	Reset format, internal format, and type of the texture. More...

unsigned int	GetMinificationFilterMode (int vtktype)

unsigned int	GetMagnificationFilterMode (int vtktype)

unsigned int	GetWrapSMode (int vtktype)

unsigned int	GetWrapTMode (int vtktype)

unsigned int	GetWrapRMode (int vtktype)

void	SetLinearMagnification (bool val)
	Tells if the magnification mode is linear (true) or nearest (false). More...

bool	GetLinearMagnification ()

void	CopyFromFrameBuffer (int srcXmin, int srcYmin, int dstXmin, int dstYmin, int width, int height)
	Copy a sub-part of a logical buffer of the framebuffer (color or depth) to the texture object. More...

void	GetShiftAndScale (float &shift, float &scale)
	Get the shift and scale required in the shader to return the texture values to their original range. More...

void	Resize (unsigned int width, unsigned int height)

void	AssignToExistingTexture (unsigned int handle, unsigned int target)
	Assign the TextureObject to a externally provided Handle and Target. More...


void	SetContext (vtkOpenGLRenderWindow *)
	Get/Set the context. More...

vtkOpenGLRenderWindow *	GetContext ()
	Get/Set the context. More...


virtual unsigned int	GetWidth ()
	Get the texture dimensions. More...

virtual unsigned int	GetHeight ()
	Get the texture dimensions. More...

virtual unsigned int	GetDepth ()
	Get the texture dimensions. More...

virtual unsigned int	GetSamples ()
	Get the texture dimensions. More...

virtual int	GetComponents ()
	Get the texture dimensions. More...

unsigned int	GetTuples ()
	Get the texture dimensions. More...


virtual unsigned int	GetTarget ()
	Returns OpenGL texture target to which the texture is/can be bound. More...


virtual unsigned int	GetHandle ()
	Returns the OpenGL handle. More...


void	Bind ()
	Bind the texture, must have been created using Create(). More...


virtual void	SetAutoParameters (int)
	Get/Set AutoParameters flag. More...

virtual int	GetAutoParameters ()
	Get/Set AutoParameters flag. More...

virtual void	AutoParametersOn ()
	Get/Set AutoParameters flag. More...

virtual void	AutoParametersOff ()
	Get/Set AutoParameters flag. More...


bool	Create2D (unsigned int width, unsigned int height, int numComps, int vtktype, bool)
	Create texture without uploading any data. More...

bool	Create3D (unsigned int width, unsigned int height, unsigned int depth, int numComps, int vtktype, bool)
	Create texture without uploading any data. More...


int	GetDataType (int vtk_scalar_type)
	Get the data type for the texture as GLenum type. More...

void	SetDataType (unsigned int glType)
	Get the data type for the texture as GLenum type. More...

int	GetDefaultDataType (int vtk_scalar_type)
	Get the data type for the texture as GLenum type. More...


unsigned int	GetInternalFormat (int vtktype, int numComps, bool shaderSupportsTextureInt)
	Get/Set internal format (OpenGL internal format) that should be used. More...

void	SetInternalFormat (unsigned int glInternalFormat)
	Get/Set internal format (OpenGL internal format) that should be used. More...

unsigned int	GetDefaultInternalFormat (int vtktype, int numComps, bool shaderSupportsTextureInt)
	Get/Set internal format (OpenGL internal format) that should be used. More...


unsigned int	GetFormat (int vtktype, int numComps, bool shaderSupportsTextureInt)
	Get/Set format (OpenGL internal format) that should be used. More...

void	SetFormat (unsigned int glFormat)
	Get/Set format (OpenGL internal format) that should be used. More...

unsigned int	GetDefaultFormat (int vtktype, int numComps, bool shaderSupportsTextureInt)
	Get/Set format (OpenGL internal format) that should be used. More...


virtual void	SetRequireDepthBufferFloat (bool)
	Optional, require support for floating point depth buffer formats. More...

virtual bool	GetRequireDepthBufferFloat ()
	Optional, require support for floating point depth buffer formats. More...

virtual bool	GetSupportsDepthBufferFloat ()
	Optional, require support for floating point depth buffer formats. More...


virtual void	SetRequireTextureFloat (bool)
	Optional, require support for floating point texture formats. More...

virtual bool	GetRequireTextureFloat ()
	Optional, require support for floating point texture formats. More...

virtual bool	GetSupportsTextureFloat ()
	Optional, require support for floating point texture formats. More...


virtual void	SetRequireTextureInteger (bool)
	Optional, require support for integer texture formats. More...

virtual bool	GetRequireTextureInteger ()
	Optional, require support for integer texture formats. More...

virtual bool	GetSupportsTextureInteger ()
	Optional, require support for integer texture formats. More...


virtual int	GetWrapS ()
	Wrap mode for the first texture coordinate "s" Valid values are: More...

virtual void	SetWrapS (int)
	Wrap mode for the first texture coordinate "s" Valid values are: More...


virtual int	GetWrapT ()
	Wrap mode for the first texture coordinate "t" Valid values are: More...

virtual void	SetWrapT (int)
	Wrap mode for the first texture coordinate "t" Valid values are: More...


virtual int	GetWrapR ()
	Wrap mode for the first texture coordinate "r" Valid values are: More...

virtual void	SetWrapR (int)
	Wrap mode for the first texture coordinate "r" Valid values are: More...


virtual int	GetMinificationFilter ()
	Minification filter mode. More...

virtual void	SetMinificationFilter (int)
	Minification filter mode. More...


virtual int	GetMagnificationFilter ()
	Magnification filter mode. More...

virtual void	SetMagnificationFilter (int)
	Magnification filter mode. More...


virtual void	SetBorderColor (float, float, float, float)
	Border Color (RGBA). More...

virtual void	SetBorderColor (float[4])
	Border Color (RGBA). More...

virtual float *	GetBorderColor ()
	Border Color (RGBA). More...

virtual void	GetBorderColor (float &, float &, float &, float &)
	Border Color (RGBA). More...

virtual void	GetBorderColor (float[4])
	Border Color (RGBA). More...


virtual void	SetMinLOD (float)
	Lower-clamp the computed LOD against this value. More...

virtual float	GetMinLOD ()
	Lower-clamp the computed LOD against this value. More...


virtual void	SetMaxLOD (float)
	Upper-clamp the computed LOD against this value. More...

virtual float	GetMaxLOD ()
	Upper-clamp the computed LOD against this value. More...


virtual void	SetBaseLevel (int)
	Level of detail of the first texture image. More...

virtual int	GetBaseLevel ()
	Level of detail of the first texture image. More...


virtual void	SetMaxLevel (int)
	Level of detail of the first texture image. More...

virtual int	GetMaxLevel ()
	Level of detail of the first texture image. More...


virtual bool	GetDepthTextureCompare ()
	Tells if the output of a texture unit with a depth texture uses comparison or not. More...

virtual void	SetDepthTextureCompare (bool)
	Tells if the output of a texture unit with a depth texture uses comparison or not. More...


virtual int	GetDepthTextureCompareFunction ()
	In case DepthTextureCompare is true, specify the comparison function in use. More...

virtual void	SetDepthTextureCompareFunction (int)
	In case DepthTextureCompare is true, specify the comparison function in use. More...


virtual bool	GetGenerateMipmap ()
	Tells the hardware to generate mipmap textures from the first texture image at BaseLevel. More...

virtual void	SetGenerateMipmap (bool)
	Tells the hardware to generate mipmap textures from the first texture image at BaseLevel. More...


virtual void	SetMaximumAnisotropicFiltering (float)
	Set/Get the maximum anisotropic filtering to use. More...

virtual float	GetMaximumAnisotropicFiltering ()
	Set/Get the maximum anisotropic filtering to use. More...


void	CopyToFrameBuffer (vtkShaderProgram program, vtkOpenGLVertexArrayObject vao)
	Copy the texture (src) in the current framebuffer. More...

void	CopyToFrameBuffer (int srcXmin, int srcYmin, int srcXmax, int srcYmax, int dstXmin, int dstYmin, int dstXmax, int dstYmax, int dstSizeX, int dstSizeY, vtkShaderProgram program, vtkOpenGLVertexArrayObject vao)
	Copy the texture (src) in the current framebuffer. More...

void	CopyToFrameBuffer (int srcXmin, int srcYmin, int srcXmax, int srcYmax, int dstXmin, int dstYmin, int dstSizeX, int dstSizeY, vtkShaderProgram program, vtkOpenGLVertexArrayObject vao)
	Copy the texture (src) in the current framebuffer. More...

void	CopyToFrameBuffer (float tcoords, float verts, vtkShaderProgram program, vtkOpenGLVertexArrayObject vao)
	Copy the texture (src) in the current framebuffer. More...


virtual bool	GetUseSRGBColorSpace ()
	Is this texture using the sRGB color space. More...

virtual void	SetUseSRGBColorSpace (bool)
	Is this texture using the sRGB color space. More...

virtual void	UseSRGBColorSpaceOn ()
	Is this texture using the sRGB color space. More...

virtual void	UseSRGBColorSpaceOff ()
	Is this texture using the sRGB color space. 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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. 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 vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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). 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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkTextureObject *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkTextureObject *	SafeDownCast (vtkObjectBase *o)

static bool	IsSupported (vtkOpenGLRenderWindow *, bool, bool, bool)
	Returns if the context supports the required extensions. More...

static bool	IsSupported (vtkOpenGLRenderWindow *)
	Check for feature support, without any optional features. More...

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 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). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTextureObject ()

	~vtkTextureObject () override

void	CreateTexture ()
	Creates a texture handle if not already created. More...

void	DestroyTexture ()
	Destroy the texture. 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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkGenericOpenGLResourceFreeCallback *	ResourceCallback

int	NumberOfDimensions

unsigned int	Width

unsigned int	Height

unsigned int	Depth

unsigned int	Samples

bool	UseSRGBColorSpace

float	MaximumAnisotropicFiltering

unsigned int	Target

unsigned int	Format

unsigned int	InternalFormat

unsigned int	Type

int	Components

vtkWeakPointer< vtkOpenGLRenderWindow >	Context

unsigned int	Handle

bool	OwnHandle

bool	RequireTextureInteger

bool	SupportsTextureInteger

bool	RequireTextureFloat

bool	SupportsTextureFloat

bool	RequireDepthBufferFloat

bool	SupportsDepthBufferFloat

int	WrapS

int	WrapT

int	WrapR

int	MinificationFilter

int	MagnificationFilter

float	MinLOD

float	MaxLOD

int	BaseLevel

int	MaxLevel

float	BorderColor [4]

bool	DepthTextureCompare

int	DepthTextureCompareFunction

bool	GenerateMipmap

int	AutoParameters

vtkTimeStamp	SendParametersTime

vtkOpenGLHelper *	ShaderProgram

vtkOpenGLBufferObject *	BufferObject

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

static int	GetMaximumTextureSize (vtkOpenGLRenderWindow *context)
	Query and return maximum texture size (dimension) supported by the OpenGL driver for a particular context. More...

static int	GetMaximumTextureSize3D (vtkOpenGLRenderWindow *context)
	Query and return maximum texture size (dimension) supported by the OpenGL driver for a particular context. More...

int	GetMaximumTextureSize3D ()
	Overload which uses the internal context to query the maximum 3D texture size. More...

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

abstracts an OpenGL texture object.

vtkTextureObject represents an OpenGL texture object. It provides API to create textures using data already loaded into pixel buffer objects. It can also be used to create textures without uploading any data.

Online Examples:

MotionBlur

Definition at line 59 of file vtkTextureObject.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkTextureObject::Superclass

Definition at line 116 of file vtkTextureObject.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
Lequal
Gequal
Less
Greater
Equal
NotEqual
AlwaysTrue
Never
NumberOfDepthTextureCompareFunctions

Definition at line 63 of file vtkTextureObject.h.

◆ anonymous enum

anonymous enum

Enumerator
ClampToEdge
Repeat
MirroredRepeat
ClampToBorder
NumberOfWrapModes

Definition at line 79 of file vtkTextureObject.h.

◆ anonymous enum

anonymous enum

Enumerator
Nearest
Linear
NearestMipmapNearest
NearestMipmapLinear
LinearMipmapNearest
LinearMipmapLinear
NumberOfMinificationModes

Definition at line 91 of file vtkTextureObject.h.

◆ anonymous enum

anonymous enum

Enumerator
Native
Fixed8
Fixed16
Fixed24
Fixed32
Float16
Float32
NumberOfDepthFormats

Definition at line 103 of file vtkTextureObject.h.

Constructor & Destructor Documentation

◆ vtkTextureObject()

vtkTextureObject::vtkTextureObject ( )

protected

◆ ~vtkTextureObject()

vtkTextureObject::~vtkTextureObject ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkTextureObject * vtkTextureObject::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkTextureObject::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.

Reimplemented in vtkQWidgetTexture.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkTextureObject::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkQWidgetTexture.

◆ NewInstance()

vtkTextureObject * vtkTextureObject::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetContext()

void vtkTextureObject::SetContext ( vtkOpenGLRenderWindow * )

Get/Set the context.

This does not increase the reference count of the context to avoid reference loops.

{ this->TextureObject = vtkTextureObject::New(); }SetContext() may raise an error if the OpenGL context does not support the required OpenGL extensions.

◆ GetContext()

vtkOpenGLRenderWindow * vtkTextureObject::GetContext ( )

Get/Set the context.

This does not increase the reference count of the context to avoid reference loops.

{ this->TextureObject = vtkTextureObject::New(); }SetContext() may raise an error if the OpenGL context does not support the required OpenGL extensions.

◆ GetWidth()

virtual unsigned int vtkTextureObject::GetWidth ( )

virtual

Get the texture dimensions.

These are the properties of the OpenGL texture this instance represents.

◆ GetHeight()

virtual unsigned int vtkTextureObject::GetHeight ( )

virtual

Get the texture dimensions.

These are the properties of the OpenGL texture this instance represents.

◆ GetDepth()

virtual unsigned int vtkTextureObject::GetDepth ( )

virtual

Get the texture dimensions.

These are the properties of the OpenGL texture this instance represents.

◆ GetSamples()

virtual unsigned int vtkTextureObject::GetSamples ( )

virtual

Get the texture dimensions.

These are the properties of the OpenGL texture this instance represents.

◆ GetComponents()

virtual int vtkTextureObject::GetComponents ( )

virtual

Get the texture dimensions.

These are the properties of the OpenGL texture this instance represents.

◆ GetTuples()

unsigned int vtkTextureObject::GetTuples ( )

inline

Get the texture dimensions.

These are the properties of the OpenGL texture this instance represents.

Definition at line 143 of file vtkTextureObject.h.

◆ GetNumberOfDimensions()

virtual int vtkTextureObject::GetNumberOfDimensions ( )

virtual

◆ SetSamples()

virtual void vtkTextureObject::SetSamples ( unsigned int )

virtual

◆ GetTarget()

virtual unsigned int vtkTextureObject::GetTarget ( )

virtual

Returns OpenGL texture target to which the texture is/can be bound.

◆ GetHandle()

virtual unsigned int vtkTextureObject::GetHandle ( )

virtual

Returns the OpenGL handle.

◆ GetTextureUnit()

int vtkTextureObject::GetTextureUnit ( )

Return the texture unit used for this texture.

◆ Bind()

void vtkTextureObject::Bind ( )

Bind the texture, must have been created using Create().

A side affect is that tex parameters are sent. RenderWindow must be set before calling this.

◆ Activate()

virtual void vtkTextureObject::Activate ( )

virtual

Activate and Bind the texture.

Reimplemented in vtkQWidgetTexture.

◆ Deactivate()

void vtkTextureObject::Deactivate ( )

Deactivate and UnBind the texture.

◆ ReleaseGraphicsResources()

virtual void vtkTextureObject::ReleaseGraphicsResources ( vtkWindow * win )

virtual

Deactivate and UnBind the texture.

Reimplemented in vtkQWidgetTexture.

◆ IsBound()

bool vtkTextureObject::IsBound ( )

Tells if the texture object is bound to the active texture image unit.

(a texture object can be bound to multiple texture image unit).

◆ SendParameters()

void vtkTextureObject::SendParameters ( )

Send all the texture object parameters to the hardware if not done yet.

Parameters are automatically sent as a side affect of Bind. Disable this by setting AutoParameters 0.

Precondition: is_bound: IsBound()

◆ SetAutoParameters()

virtual void vtkTextureObject::SetAutoParameters ( int )

virtual

Get/Set AutoParameters flag.

When enabled, SendParameters method is called automatically when the texture is bound.

◆ GetAutoParameters()

virtual int vtkTextureObject::GetAutoParameters ( )

virtual

Get/Set AutoParameters flag.

When enabled, SendParameters method is called automatically when the texture is bound.

◆ AutoParametersOn()

virtual void vtkTextureObject::AutoParametersOn ( )

virtual

Get/Set AutoParameters flag.

When enabled, SendParameters method is called automatically when the texture is bound.

◆ AutoParametersOff()

virtual void vtkTextureObject::AutoParametersOff ( )

virtual

Get/Set AutoParameters flag.

When enabled, SendParameters method is called automatically when the texture is bound.

◆ Create2DFromRaw()

bool vtkTextureObject::Create2DFromRaw	(	unsigned int	width,
		unsigned int	height,
		int	numComps,
		int	dataType,
		void *	data
	)

Create a 2D texture from client memory numComps must be in [1-4].

◆ CreateDepthFromRaw()

bool vtkTextureObject::CreateDepthFromRaw	(	unsigned int	width,
		unsigned int	height,
		int	internalFormat,
		int	rawType,
		void *	raw
	)

Create a 2D depth texture using a raw pointer.

This is a blocking call. If you can, use PBO instead. raw can be null in order to allocate texture without initialization.

◆ CreateTextureBuffer()

bool vtkTextureObject::CreateTextureBuffer	(	unsigned int	numValues,
		int	numComps,
		int	dataType,
		vtkOpenGLBufferObject *	bo
	)

Create a texture buffer basically a 1D texture that can be very large for passing data into the fragment shader.

◆ CreateCubeFromRaw()

bool vtkTextureObject::CreateCubeFromRaw	(	unsigned int	width,
		unsigned int	height,
		int	numComps,
		int	dataType,
		void *	data[6]
	)

Create a cube texture from 6 buffers from client memory.

Image data must be provided in the following order: +X -X +Y -Y +Z -Z. numComps must be in [1-4].

◆ Create1D()

bool vtkTextureObject::Create1D	(	int	numComps,
		vtkPixelBufferObject *	pbo,
		bool	shaderSupportsTextureInt
	)

Create a 1D texture using the PBO.

Eventually we may start supporting creating a texture from subset of data in the PBO, but for simplicity we'll begin with entire PBO data. numComps must be in [1-4]. shaderSupportsTextureInt is true if the shader has an alternate implementation supporting sampler with integer values. Even if the card supports texture int, it does not mean that the implementor of the shader made a version that supports texture int.

◆ Create1DFromRaw()

bool vtkTextureObject::Create1DFromRaw	(	unsigned int	width,
		int	numComps,
		int	dataType,
		void *	data
	)

Create 1D texture from client memory.

◆ Create2D() [1/2]

bool vtkTextureObject::Create2D	(	unsigned int	width,
		unsigned int	height,
		int	numComps,
		vtkPixelBufferObject *	pbo,
		bool	shaderSupportsTextureInt
	)

Create a 2D texture using the PBO.

Eventually we may start supporting creating a texture from subset of data in the PBO, but for simplicity we'll begin with entire PBO data. numComps must be in [1-4].

◆ Create3D() [1/2]

bool vtkTextureObject::Create3D	(	unsigned int	width,
		unsigned int	height,
		unsigned int	depth,
		int	numComps,
		vtkPixelBufferObject *	pbo,
		bool	shaderSupportsTextureInt
	)

Create a 3D texture using the PBO.

Eventually we may start supporting creating a texture from subset of data in the PBO, but for simplicity we'll begin with entire PBO data. numComps must be in [1-4].

◆ Create3DFromRaw()

bool vtkTextureObject::Create3DFromRaw	(	unsigned int	width,
		unsigned int	height,
		unsigned int	depth,
		int	numComps,
		int	dataType,
		void *	data
	)

Create a 3D texture from client memory numComps must be in [1-4].

◆ AllocateProxyTexture3D()

bool vtkTextureObject::AllocateProxyTexture3D	(	unsigned int const	width,
		unsigned int const	height,
		unsigned int const	depth,
		int const	numComps,
		int const	dataType
	)

Create a 3D texture using the GL_PROXY_TEXTURE_3D target.

This serves as a pre-allocation step which assists in verifying that the size of the texture to be created is supported by the implementation and that there is sufficient texture memory available for it.

◆ Download() [1/2]

vtkPixelBufferObject * vtkTextureObject::Download ( )

This is used to download raw data from the texture into a pixel buffer.

The pixel buffer API can then be used to download the pixel buffer data to CPU arrays. The caller takes on the responsibility of deleting the returns vtkPixelBufferObject once it done with it.

◆ Download() [2/2]

vtkPixelBufferObject * vtkTextureObject::Download	(	unsigned int	target,
		unsigned int	level
	)

◆ CreateDepth()

bool vtkTextureObject::CreateDepth	(	unsigned int	width,
		unsigned int	height,
		int	internalFormat,
		vtkPixelBufferObject *	pbo
	)

Create a 2D depth texture using a PBO.

Precondition: : valid_internalFormat: internalFormat>=0 && internalFormat<NumberOfDepthFormats

◆ AllocateDepth()

bool vtkTextureObject::AllocateDepth	(	unsigned int	width,
		unsigned int	height,
		int	internalFormat
	)

Create a 2D depth texture but does not initialize its values.

◆ AllocateDepthStencil()

bool vtkTextureObject::AllocateDepthStencil	(	unsigned int	width,
		unsigned int	height
	)

Create a 2D septh stencil texture but does not initialize its values.

◆ Allocate1D()

bool vtkTextureObject::Allocate1D	(	unsigned int	width,
		int	numComps,
		int	vtkType
	)

Create a 1D color texture but does not initialize its values.

Internal format is deduced from numComps and vtkType.

◆ Allocate2D()

bool vtkTextureObject::Allocate2D	(	unsigned int	width,
		unsigned int	height,
		int	numComps,
		int	vtkType,
		int	level = `0`
	)

Create a 2D color texture but does not initialize its values.

Internal format is deduced from numComps and vtkType.

◆ Allocate3D()

bool vtkTextureObject::Allocate3D	(	unsigned int	width,
		unsigned int	height,
		unsigned int	depth,
		int	numComps,
		int	vtkType
	)

Create a 3D color texture but does not initialize its values.

Internal format is deduced from numComps and vtkType.

◆ Create2D() [2/2]

bool vtkTextureObject::Create2D	(	unsigned int	width,
		unsigned int	height,
		int	numComps,
		int	vtktype,
		bool
	)

inline

Create texture without uploading any data.

Definition at line 349 of file vtkTextureObject.h.

◆ Create3D() [2/2]

bool vtkTextureObject::Create3D	(	unsigned int	width,
		unsigned int	height,
		unsigned int	depth,
		int	numComps,
		int	vtktype,
		bool
	)

inline

Create texture without uploading any data.

Definition at line 353 of file vtkTextureObject.h.

◆ GetVTKDataType()

int vtkTextureObject::GetVTKDataType ( )

Get the data type for the texture as a vtk type int i.e.

VTK_INT etc.

◆ GetDataType()

int vtkTextureObject::GetDataType ( int vtk_scalar_type )

Get the data type for the texture as GLenum type.

◆ SetDataType()

void vtkTextureObject::SetDataType ( unsigned int glType )

Get the data type for the texture as GLenum type.

◆ GetDefaultDataType()

int vtkTextureObject::GetDefaultDataType ( int vtk_scalar_type )

Get the data type for the texture as GLenum type.

◆ GetInternalFormat()

unsigned int vtkTextureObject::GetInternalFormat	(	int	vtktype,
		int	numComps,
		bool	shaderSupportsTextureInt
	)

Get/Set internal format (OpenGL internal format) that should be used.

(https://www.opengl.org/sdk/docs/man2/xhtml/glTexImage2D.xml)

◆ SetInternalFormat()

void vtkTextureObject::SetInternalFormat ( unsigned int glInternalFormat )

Get/Set internal format (OpenGL internal format) that should be used.

(https://www.opengl.org/sdk/docs/man2/xhtml/glTexImage2D.xml)

◆ GetDefaultInternalFormat()

unsigned int vtkTextureObject::GetDefaultInternalFormat	(	int	vtktype,
		int	numComps,
		bool	shaderSupportsTextureInt
	)

Get/Set internal format (OpenGL internal format) that should be used.

(https://www.opengl.org/sdk/docs/man2/xhtml/glTexImage2D.xml)

◆ GetFormat()

unsigned int vtkTextureObject::GetFormat	(	int	vtktype,
		int	numComps,
		bool	shaderSupportsTextureInt
	)

Get/Set format (OpenGL internal format) that should be used.

(https://www.opengl.org/sdk/docs/man2/xhtml/glTexImage2D.xml)

◆ SetFormat()

void vtkTextureObject::SetFormat ( unsigned int glFormat )

Get/Set format (OpenGL internal format) that should be used.

(https://www.opengl.org/sdk/docs/man2/xhtml/glTexImage2D.xml)

◆ GetDefaultFormat()

unsigned int vtkTextureObject::GetDefaultFormat	(	int	vtktype,
		int	numComps,
		bool	shaderSupportsTextureInt
	)

Get/Set format (OpenGL internal format) that should be used.

(https://www.opengl.org/sdk/docs/man2/xhtml/glTexImage2D.xml)

◆ ResetFormatAndType()

void vtkTextureObject::ResetFormatAndType ( )

Reset format, internal format, and type of the texture.

This method is useful when a texture is reused in a context same as the previous render call. In such cases, texture destruction does not happen and therefore previous set values are used.

◆ GetMinificationFilterMode()

unsigned int vtkTextureObject::GetMinificationFilterMode ( int vtktype )

◆ GetMagnificationFilterMode()

unsigned int vtkTextureObject::GetMagnificationFilterMode ( int vtktype )

◆ GetWrapSMode()

unsigned int vtkTextureObject::GetWrapSMode ( int vtktype )

◆ GetWrapTMode()

unsigned int vtkTextureObject::GetWrapTMode ( int vtktype )

◆ GetWrapRMode()

unsigned int vtkTextureObject::GetWrapRMode ( int vtktype )