irr::video::ITexture Class Reference

Interface of a Video Driver dependent Texture. More...

#include <C:/Projects/skylicht-engine/Projects/Irrlicht/Include/ITexture.h>

Inheritance diagram for irr::video::ITexture:

Public Member Functions
	ITexture (const io::path &name)
	constructor
virtual void *	lock (E_TEXTURE_LOCK_MODE mode=ETLM_READ_WRITE, u32 mipmapLevel=0)=0
	Lock function.
virtual void	unlock ()=0
	Unlock function. Must be called after a lock() to the texture.
virtual void	regenerateMipMapLevels (void *mipmapData=0)=0
	Regenerates the mip map levels of the texture.
const core::dimension2d< u32 > &	getOriginalSize () const
	Get original size of the texture.
const core::dimension2d< u32 > &	getSize () const
	Get dimension (=size) of the texture.
E_DRIVER_TYPE	getDriverType () const
	Get driver type of texture.
ECOLOR_FORMAT	getColorFormat () const
	Get the color format of texture.
u32	getPitch () const
	Get pitch of the main texture (in bytes).
bool	hasMipMaps () const
	Check whether the texture has MipMaps.
bool	hasAlpha () const
	Returns if the texture has an alpha channel.
bool	isRenderTarget () const
	Check whether the texture is a render target.
const io::SNamedPath &	getName () const
	Get name of texture (in most cases this is the filename).
E_TEXTURE_SOURCE	getSource () const
	Check where the last IVideoDriver::getTexture found this texture.
void	updateSource (E_TEXTURE_SOURCE source)
	Used internally by the engine to update Source status on IVideoDriver::getTexture calls.
const E_TEXTURE_TYPE &	getTextureType () const
Public Member Functions inherited from irr::IReferenceCounted
	IReferenceCounted ()
	Constructor.
virtual	~IReferenceCounted ()
	Destructor.
void	grab () const
	Grabs the object. Increments the reference counter by one.
bool	drop () const
	Drops the object. Decrements the reference counter by one.
s32	getReferenceCount () const
	Get the reference count.
const c8 *	getDebugName () const
	Returns the debug name of the object.

Protected Member Functions
E_TEXTURE_CREATION_FLAG	getTextureFormatFromFlags (u32 flags)
	Helper function, helps to get the desired texture creation format from the flags.
Protected Member Functions inherited from irr::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Protected Attributes
io::SNamedPath	NamedPath
core::dimension2d< u32 >	OriginalSize
core::dimension2d< u32 >	Size
E_DRIVER_TYPE	DriverType
ECOLOR_FORMAT	ColorFormat
u32	Pitch
bool	HasMipMaps
bool	HasAlpha
bool	IsRenderTarget
E_TEXTURE_SOURCE	Source
E_TEXTURE_TYPE	TextureType

Detailed Description

Interface of a Video Driver dependent Texture.

An ITexture is created by an IVideoDriver by using IVideoDriver::addTexture or IVideoDriver::getTexture. After that, the texture may only be used by this VideoDriver. As you can imagine, textures of the DirectX and the OpenGL device will, e.g., not be compatible. An exception is the Software device and the NULL device, their textures are compatible. If you try to use a texture created by one device with an other device, the device will refuse to do that and write a warning or an error message to the output buffer.

Member Function Documentation

getColorFormat()

ECOLOR_FORMAT irr::video::ITexture::getColorFormat ( ) const

inline

Get the color format of texture.

Returns

The color format of texture.

getDriverType()

E_DRIVER_TYPE irr::video::ITexture::getDriverType ( ) const

inline

Get driver type of texture.

This is the driver, which created the texture. This method is used internally by the video devices, to check, if they may use a texture because textures may be incompatible between different devices.

Returns

Driver type of texture.

getOriginalSize()

const core::dimension2d< u32 > & irr::video::ITexture::getOriginalSize ( ) const

inline

Get original size of the texture.

The texture is usually scaled, if it was created with an unoptimal size. For example if the size was not a power of two. This method returns the size of the texture it had before it was scaled. Can be useful when drawing 2d images on the screen, which should have the exact size of the original texture. Use ITexture::getSize() if you want to know the real size it has now stored in the system.

Returns

The original size of the texture.

getPitch()

u32 irr::video::ITexture::getPitch ( ) const

inline

Get pitch of the main texture (in bytes).

The pitch is the amount of bytes used for a row of pixels in a texture.

Returns

Pitch of texture in bytes.

getSize()

const core::dimension2d< u32 > & irr::video::ITexture::getSize ( ) const

inline

Get dimension (=size) of the texture.

Returns

The size of the texture.

getTextureFormatFromFlags()

E_TEXTURE_CREATION_FLAG irr::video::ITexture::getTextureFormatFromFlags ( u32 flags )

inlineprotected

Helper function, helps to get the desired texture creation format from the flags.

Returns

Either ETCF_ALWAYS_32_BIT, ETCF_ALWAYS_16_BIT, ETCF_OPTIMIZED_FOR_QUALITY, or ETCF_OPTIMIZED_FOR_SPEED.

hasMipMaps()

bool irr::video::ITexture::hasMipMaps ( ) const

inline

Check whether the texture has MipMaps.

Returns

True if texture has MipMaps, else false.

isRenderTarget()

bool irr::video::ITexture::isRenderTarget ( ) const

inline

Check whether the texture is a render target.

Render targets can be set as such in the video driver, in order to render a scene into the texture. Once unbound as render target, they can be used just as usual textures again.

Returns

True if this is a render target, otherwise false.

lock()

virtual void * irr::video::ITexture::lock ( E_TEXTURE_LOCK_MODE mode = ETLM_READ_WRITE, u32 mipmapLevel = 0 )

pure virtual

Lock function.

Locks the Texture and returns a pointer to access the pixels. After lock() has been called and all operations on the pixels are done, you must call unlock(). Locks are not accumulating, hence one unlock will do for an arbitrary number of previous locks. You should avoid locking different levels without unlocking inbetween, though, because only the last level locked will be unlocked. The size of the i-th mipmap level is defined as max(getSize().Width>>i,1) and max(getSize().Height>>i,1)

Parameters

mode	Specifies what kind of changes to the locked texture are allowed. Unspecified behavior will arise if texture is written in read only mode or read from in write only mode. Support for this feature depends on the driver, so don't rely on the texture being write-protected when locking with read-only, etc.
mipmapLevel	Number of the mipmapLevel to lock. 0 is main texture. Non-existing levels will silently fail and return 0.

Returns

Returns a pointer to the pixel data. The format of the pixel can be determined by using getColorFormat(). 0 is returned, if the texture cannot be locked.

regenerateMipMapLevels()

virtual void irr::video::ITexture::regenerateMipMapLevels ( void * mipmapData = 0 )

pure virtual

Regenerates the mip map levels of the texture.

Required after modifying the texture, usually after calling unlock().

Parameters

mipmapData

Optional parameter to pass in image data which will be used instead of the previously stored or automatically generated mipmap data. The data has to be a continuous pixel data for all mipmaps until 1x1 pixel. Each mipmap has to be half the width and height of the previous level. At least one pixel will be always kept.

unlock()

virtual void irr::video::ITexture::unlock ( )

pure virtual

Unlock function. Must be called after a lock() to the texture.

One should avoid to call unlock more than once before another lock. The last locked mip level will be unlocked.

---

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

• C:/Projects/skylicht-engine/Projects/Irrlicht/Include/ITexture.h