Interface of a Video Driver dependent Texture.
More...
#include <nirtcpp/core/engine/ITexture.hpp>
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.
◆ getColorFormat()
Get the color format of texture.
- Returns
- The color format of texture.
◆ getDriverType()
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.
◆ getOriginalColorFormat()
| ECOLOR_FORMAT nirt::video::ITexture::getOriginalColorFormat |
( |
| ) |
const |
|
inline |
Get the original color format.
When create textures from image data we will often use different color formats. For example depending on driver TextureCreationFlag's. This can give you the original format which the image used to create the texture had
◆ getOriginalSize()
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 nirt::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()
Get dimension (=size) of the texture.
- Returns
- The size of the texture.
◆ getTextureFormatFromFlags()
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 nirt::video::ITexture::hasMipMaps |
( |
| ) |
const |
|
inline |
Check whether the texture has MipMaps.
- Returns
- True if texture has MipMaps, else false.
◆ isRenderTarget()
| bool nirt::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()
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 in between, 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 | NOTE: Currently broken, sorry, we try if we can repair it for 1.9 release. Number of the mipmapLevel to lock. 0 is main texture. Non-existing levels will silently fail and return 0. |
| layer | It determines which cubemap face or texture array layer should be locked. |
| lockFlags | See E_TEXTURE_LOCK_FLAGS documentation. |
- 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 nirt::video::ITexture::regenerateMipMapLevels |
( |
void * |
data = 0, |
|
|
u32 |
layer = 0 |
|
) |
| |
|
pure virtual |
Regenerates the mip map levels of the texture.
Required after modifying the texture, usually after calling unlock().
- Parameters
-
| data | 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. |
| layer | It informs a texture about which cubemap or texture array layer needs mipmap regeneration. |
◆ unlock()
| virtual void nirt::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. You may want to call regenerateMipMapLevels() after this when you changed any data.
The documentation for this class was generated from the following file:
Public Member Functions inherited from nirt::IReferenceCounted