vtkTextureObject Class Reference

#include <vtkTextureObject.h>

Inheritance diagram for vtkTextureObject:

[legend]

Collaboration diagram for vtkTextureObject:

[legend]

List of all members.

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.

Warning:: DON'T PLAY WITH IT YET.

Definition at line 35 of file vtkTextureObject.h.


Public Types
enum	{ Lequal = 0, Gequal, Less, Greater, Equal, NotEqual, AlwaysTrue, Never, NumberOfDepthTextureCompareFunctions }
enum	{ Luminance = 0, Intensity, Alpha, NumberOfDepthTextureModes }
enum	{ Clamp = 0, ClampToEdge, Repeat, ClampToBorder, MirroredRepeat, NumberOfWrapModes }
enum	{ Nearest = 0, Linear, NearestMipmapNearest, NearestMipmapLinear, LinearMipmapNearest, LinearMipmapLinear, NumberOfMinificationModes }
enum	{ Native = 0, Fixed16, Fixed24, Fixed32, Float32, NumberOfDepthFormats }
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetNumberOfDimensions ()
bool	IsBound ()
void	SendParameters ()
bool	Allocate1D (unsigned int width, int numComps, int vtkType)
vtkPixelBufferObject *	Download ()
int	GetDataType ()
unsigned int	GetInternalFormat (int vtktype, int numComps, bool shaderSupportsTextureInt)
unsigned int	GetFormat (int vtktype, int numComps, bool shaderSupportsTextureInt)

void	SetContext (vtkRenderWindow *)
vtkRenderWindow *	GetContext ()

virtual unsigned int	GetWidth ()
virtual unsigned int	GetHeight ()
virtual unsigned int	GetDepth ()
virtual int	GetComponents ()

virtual unsigned int	GetTarget ()

virtual unsigned int	GetHandle ()

void	Bind ()
void	UnBind ()

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

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

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

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

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

bool	Allocate2D (unsigned int width, unsigned int height, int numComps, int vtkType)

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

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

bool	Create2D (unsigned int width, unsigned int height, int numComps, int vtktype, bool shaderSupportsTextureInt)
bool	Create3D (unsigned int width, unsigned int height, unsigned int depth, int numComps, int vtktype, bool shaderSupportsTextureInt)

virtual int	GetWrapS ()
virtual void	SetWrapS (int)

virtual int	GetWrapT ()
virtual void	SetWrapT (int)

virtual int	GetWrapR ()
virtual void	SetWrapR (int)

virtual int	GetMinificationFilter ()
virtual void	SetMinificationFilter (int)

virtual bool	GetLinearMagnification ()
virtual void	SetLinearMagnification (bool)

virtual void	SetBorderColor (float, float, float, float)
virtual void	SetBorderColor (float[4])
virtual float *	GetBorderColor ()
virtual void	GetBorderColor (float &, float &, float &, float &)
virtual void	GetBorderColor (float[4])

virtual void	SetPriority (float)
virtual float	GetPriority ()

virtual void	SetMinLOD (float)
virtual float	GetMinLOD ()

virtual void	SetMaxLOD (float)
virtual float	GetMaxLOD ()

virtual void	SetBaseLevel (int)
virtual int	GetBaseLevel ()

virtual void	SetMaxLevel (int)
virtual int	GetMaxLevel ()

virtual bool	GetDepthTextureCompare ()
virtual void	SetDepthTextureCompare (bool)

virtual int	GetDepthTextureCompareFunction ()
virtual void	SetDepthTextureCompareFunction (int)

virtual int	GetDepthTextureMode ()
virtual void	SetDepthTextureMode (int)

virtual bool	GetGenerateMipmap ()
virtual void	SetGenerateMipmap (bool)

void	CopyToFrameBuffer (int srcXmin, int srcYmin, int srcXmax, int srcYmax, int dstXmin, int dstYmin, int width, int height)

void	CopyFromFrameBuffer (int srcXmin, int srcYmin, int dstXmin, int dstYmin, int width, int height)
Static Public Member Functions
static vtkTextureObject *	New ()
static int	IsTypeOf (const char *type)
static vtkTextureObject *	SafeDownCast (vtkObject *o)
static bool	IsSupported (vtkRenderWindow *renWin)
Protected Member Functions
	vtkTextureObject ()
	~vtkTextureObject ()
bool	LoadRequiredExtensions (vtkOpenGLExtensionManager *)
void	CreateTexture ()
void	DestroyTexture ()
Protected Attributes
int	NumberOfDimensions
unsigned int	Width
unsigned int	Height
unsigned int	Depth
unsigned int	Target
unsigned int	Format
unsigned int	Type
int	Components
vtkWeakPointer< vtkRenderWindow >	Context
unsigned int	Handle
bool	SupportsTextureInteger
bool	SupportsTextureFloat
int	WrapS
int	WrapT
int	WrapR
int	MinificationFilter
bool	LinearMagnification
float	BorderColor [4]
float	Priority
float	MinLOD
float	MaxLOD
int	BaseLevel
int	MaxLevel
bool	DepthTextureCompare
int	DepthTextureCompareFunction
int	DepthTextureMode
bool	GenerateMipmap
vtkTimeStamp	SendParametersTime

Member Typedef Documentation

typedef vtkObject vtkTextureObject::Superclass

Reimplemented from vtkObject.

Definition at line 100 of file vtkTextureObject.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

Lequal
Gequal
Less
Greater
Equal
NotEqual
AlwaysTrue
Never
NumberOfDepthTextureCompareFunctions

Definition at line 41 of file vtkTextureObject.h.

anonymous enum

Enumerator:

Luminance
Intensity
Alpha
NumberOfDepthTextureModes

Definition at line 55 of file vtkTextureObject.h.

anonymous enum

Enumerator:

Clamp
ClampToEdge
Repeat
ClampToBorder
MirroredRepeat
NumberOfWrapModes

Definition at line 64 of file vtkTextureObject.h.

anonymous enum

Enumerator:

Nearest
Linear
NearestMipmapNearest
NearestMipmapLinear
LinearMipmapNearest
LinearMipmapLinear
NumberOfMinificationModes

Definition at line 75 of file vtkTextureObject.h.

anonymous enum

Enumerator:

Native
Fixed16
Fixed24
Fixed32
Float32
NumberOfDepthFormats

Definition at line 87 of file vtkTextureObject.h.

Constructor & Destructor Documentation

vtkTextureObject::vtkTextureObject ( ) [protected]

vtkTextureObject::~vtkTextureObject ( ) [protected]

Member Function Documentation

static vtkTextureObject* vtkTextureObject::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkTextureObject::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

static int vtkTextureObject::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkObject.

virtual int 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 vtkObject.

static vtkTextureObject* vtkTextureObject::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

void vtkTextureObject::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

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.

void vtkTextureObject::SetContext ( vtkRenderWindow * )

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.

vtkRenderWindow* vtkTextureObject::GetContext ( )

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 unsigned int vtkTextureObject::GetWidth ( ) [virtual]

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

virtual unsigned int vtkTextureObject::GetHeight ( ) [virtual]

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

virtual unsigned int vtkTextureObject::GetDepth ( ) [virtual]

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

virtual int vtkTextureObject::GetComponents ( ) [virtual]

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

virtual int vtkTextureObject::GetNumberOfDimensions ( ) [virtual]

virtual unsigned int vtkTextureObject::GetTarget ( ) [virtual]

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

virtual unsigned int vtkTextureObject::GetHandle ( ) [virtual]

Returns the OpenGL handle.

void vtkTextureObject::Bind ( )

Activate the texture. The texture must have been created using Create(). RenderWindow must be set before calling this.

void vtkTextureObject::UnBind ( )

Activate the texture. The texture must have been created using Create(). RenderWindow must be set before calling this.

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

void vtkTextureObject::SendParameters ( )

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

Precondition:: is_bound: IsBound()

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.

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

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

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.

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

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

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.

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

Create a 2D color texture but does not initialize its values. Internal format is deduced from numComps and vtkType.

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.

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

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

Create texture without uploading any data. To create a DEPTH_COMPONENT texture, vtktype must be set to VTK_VOID and numComps must be 1.

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

Create texture without uploading any data. To create a DEPTH_COMPONENT texture, vtktype must be set to VTK_VOID and numComps must be 1.

vtkPixelBufferObject* vtkTextureObject::Download ( )

This is used to download raw data from the texture into a pixel bufer. 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.

int vtkTextureObject::GetDataType ( )

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

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

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

virtual int vtkTextureObject::GetWrapS ( ) [virtual]

Wrap mode for the first texture coordinate "s" Valid values are: - Clamp - ClampToEdge - Repeat - ClampToBorder - MirroredRepeat Initial value is Repeat (as in OpenGL spec)

virtual void vtkTextureObject::SetWrapS ( int ) [virtual]

Wrap mode for the first texture coordinate "s" Valid values are: - Clamp - ClampToEdge - Repeat - ClampToBorder - MirroredRepeat Initial value is Repeat (as in OpenGL spec)

virtual int vtkTextureObject::GetWrapT ( ) [virtual]

Wrap mode for the first texture coordinate "t" Valid values are: - Clamp - ClampToEdge - Repeat - ClampToBorder - MirroredRepeat Initial value is Repeat (as in OpenGL spec)

virtual void vtkTextureObject::SetWrapT ( int ) [virtual]

Wrap mode for the first texture coordinate "t" Valid values are: - Clamp - ClampToEdge - Repeat - ClampToBorder - MirroredRepeat Initial value is Repeat (as in OpenGL spec)

virtual int vtkTextureObject::GetWrapR ( ) [virtual]

Wrap mode for the first texture coordinate "r" Valid values are: - Clamp - ClampToEdge - Repeat - ClampToBorder - MirroredRepeat Initial value is Repeat (as in OpenGL spec)

virtual void vtkTextureObject::SetWrapR ( int ) [virtual]

Wrap mode for the first texture coordinate "r" Valid values are: - Clamp - ClampToEdge - Repeat - ClampToBorder - MirroredRepeat Initial value is Repeat (as in OpenGL spec)

virtual int vtkTextureObject::GetMinificationFilter ( ) [virtual]

Minification filter mode. Valid values are: - Nearest - Linear - NearestMipmapNearest - NearestMipmapLinear - LinearMipmapNearest - LinearMipmapLinear Initial value is Nearest (note initial value in OpenGL spec is NearestMipMapLinear but this is error-prone because it makes the texture object incomplete. ).

virtual void vtkTextureObject::SetMinificationFilter ( int ) [virtual]

Minification filter mode. Valid values are: - Nearest - Linear - NearestMipmapNearest - NearestMipmapLinear - LinearMipmapNearest - LinearMipmapLinear Initial value is Nearest (note initial value in OpenGL spec is NearestMipMapLinear but this is error-prone because it makes the texture object incomplete. ).

virtual bool vtkTextureObject::GetLinearMagnification ( ) [virtual]

Tells if the magnification mode is linear (true) or nearest (false). Initial value is false (initial value in OpenGL spec is true).

virtual void vtkTextureObject::SetLinearMagnification ( bool ) [virtual]

Tells if the magnification mode is linear (true) or nearest (false). Initial value is false (initial value in OpenGL spec is true).

virtual void vtkTextureObject::SetBorderColor	(	float	,
		float	,
		float	,
		float
	)			`[virtual]`