Texture2D Class Reference

A class for creating 2D textures. More...

#include <Texture2D.h>

Inheritance diagram for Texture2D:

List of all members.

Public Member Functions
	Texture2D (GLenum _target, int _width, int _height, GLint _internalFormat, GLenum _format, GLenum _dataType, GLenum _minFilter, GLenum _magFilter, GLenum _wrapMode, int _samplerIndex, GLint _mipLevel=0, void *_data=0)
	Constructor.
bool	write (GLint _mipLevel, GLint _xOffset, GLint _yOffset, GLsizei _width, GLsizei _height, GLenum _format, GLenum _type, void *_data)
	Loads data to the texture.
bool	writeFromPBO (GLint _mipLevel, GLint _xOffset, GLint _yOffset, GLsizei _width, GLsizei _height, GLenum _format, GLenum _type, GLuint _pboHandle)
	Loads data to the texture.
bool	loadImage (const std::string &_fileName, GLint _mipLevel)
	Loads an image to the texture.
GLsizei	getWidth () const
	Accessor for the texture's width.
GLsizei	getHeight () const
	Accessor for the texture's height.

---

Detailed Description

A class for creating 2D textures.

Author:

Nikolaos Verigakis

Version:

1.0

Date:

14/07/11 Revision History : Initial Version 14/07/11

---

Constructor & Destructor Documentation

Texture2D::Texture2D	(	GLenum	_target,
		int	_width,
		int	_height,
		GLint	_internalFormat,
		GLenum	_format,
		GLenum	_dataType,
		GLenum	_minFilter,
		GLenum	_magFilter,
		GLenum	_wrapMode,
		int	_samplerIndex,
		GLint	_mipLevel = 0,
		void *	_data = 0
	)

Constructor.

Parameters:

[in]	_target	the target texture (must be GL_TEXTURE_2D, GL_PROXY_TEXTURE_2D)
[in]	_width	the texture's width
[in]	_height	the texture's height
[in]	_internalFormat	the number of colour components in the texture
[in]	_format	the format of the pixel data
[in]	_dataType	the data type of the pixel data
[in]	_minFilter	the minification filter
[in]	_magFilter	the magnification filter
[in]	_wrapMode	the texture wrapping mode
[in]	_samplerIndex	the texture image unit to assign the texture sampler
[in]	_mipLevel	the texture's mipmap level
[in]	_data	a pointer to the texture data in memory

---

Member Function Documentation

bool Texture2D::loadImage	(	const std::string &	_fileName,
		GLint	_mipLevel
	)

Loads an image to the texture.

Parameters:

[in]	_fileName	the image's file name
[in]	_mipLevel	the mimap level to assign the image

bool Texture2D::write	(	GLint	_mipLevel,
		GLint	_xOffset,
		GLint	_yOffset,
		GLsizei	_width,
		GLsizei	_height,
		GLenum	_format,
		GLenum	_type,
		void *	_data
	)

Loads data to the texture.

Parameters:

[in]	_mipLevel	the mipmap level of the texture sub-image
[in]	_xOffset	a texel offset in the x direction within the texture array
[in]	_yOffset	a texel offset in the y direction within the texture array
[in]	_width	the width of the texture sub-image
[in]	_height	the height of the texture sub-image
[in]	_format	the format of the texture sub-image
[in]	_type	the type of the texture sub-image
[in]	_data	the data to load

bool Texture2D::writeFromPBO	(	GLint	_mipLevel,
		GLint	_xOffset,
		GLint	_yOffset,
		GLsizei	_width,
		GLsizei	_height,
		GLenum	_format,
		GLenum	_type,
		GLuint	_pboHandle
	)

Loads data to the texture.

Parameters:

[in]	_mipLevel	the mipmap level of the texture sub-image
[in]	_xOffset	a texel offset in the x direction within the texture array
[in]	_yOffset	a texel offset in the y direction within the texture array
[in]	_width	the width of the texture sub-image
[in]	_height	the height of the texture sub-image
[in]	_format	the format of the texture sub-image
[in]	_type	the type of the texture sub-image
[in]	_pboHandle	the PBO's handle

---

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

• include/Texture2D.h
• src/Texture2D.cpp