PLRenderer::TextureBuffer2D Class Reference

Abstract renderer 2D texture buffer resource. More...

#include <TextureBuffer2D.h>

Inheritance diagram for PLRenderer::TextureBuffer2D:

List of all members.

Public Member Functions
virtual PLRENDERER_API	~TextureBuffer2D ()
	Destructor.
PLRENDERER_API PLMath::Vector2i	GetSize (PLCore::uint32 nMipmap=0) const
	Returns the texture buffer size.
virtual PLRENDERER_API PLCore::uint32	GetNumOfPixels (PLCore::uint32 nMipmap=0) const override
	Returns the number of pixels of a certain mipmap level.
virtual PLRENDERER_API PLCore::uint32	GetNumOfBytes (PLCore::uint32 nMipmap=0, EPixelFormat nFormat=Unknown) const override
	Returns the number of bytes required to hold certain mipmap level texture buffer data.
Protected Member Functions
PLRENDERER_API	TextureBuffer2D (Renderer &cRenderer, PLCore::uint32 nFlags)
	Constructor.
Protected Attributes
PLMath::Vector2i	m_vSize

---

Detailed Description

Abstract renderer 2D texture buffer resource.

---

Constructor & Destructor Documentation

virtual PLRENDERER_API PLRenderer::TextureBuffer2D::~TextureBuffer2D

(

)

[virtual]

Destructor.

PLRENDERER_API PLRenderer::TextureBuffer2D::TextureBuffer2D	(	Renderer &	cRenderer,
		PLCore::uint32	nFlags
	)		[protected]

Constructor.

Parameters:

[in]	cRenderer	Owner renderer
[in]	nFlags	Texture buffer flags (see EFlags)

---

Member Function Documentation

PLRENDERER_API PLMath::Vector2i PLRenderer::TextureBuffer2D::GetSize

(

PLCore::uint32

nMipmap = 0

)

const

Returns the texture buffer size.

Parameters:

[in]

nMipmap

Mipmap level (0 - GetNumOfMipmaps())

Returns:

Texture buffer size

virtual PLRENDERER_API PLCore::uint32 PLRenderer::TextureBuffer2D::GetNumOfPixels

(

PLCore::uint32

nMipmap = 0

)

const [override, virtual]

Returns the number of pixels of a certain mipmap level.

Parameters:

[in]

nMipmap

Mipmap level (0 - GetNumOfMipmaps())

Returns:

The number of pixels of a certain mipmap level

Note:

• If this is a cube texture, the number of pixels of all faces together will be returned

Implements PLRenderer::TextureBuffer.

virtual PLRENDERER_API PLCore::uint32 PLRenderer::TextureBuffer2D::GetNumOfBytes	(	PLCore::uint32	nMipmap = 0,
		EPixelFormat	nFormat = Unknown
	)		const [override, virtual]

Returns the number of bytes required to hold certain mipmap level texture buffer data.

Parameters:

[in]	nMipmap	Mipmap level (0 - GetNumOfMipmaps())
[in]	nFormat	Target texture buffer pixel format, if Unknown, the format of THIS texture buffer is chosen automatically

Returns:

The number of bytes required to hold certain mipmap level texture buffer data

Note:

• If 'nFormat' is a compressed format, compression is also taken into account
• If this is a cube texture, the number of bytes of all faces together will be returned

Implements PLRenderer::TextureBuffer.

---

Member Data Documentation

PLMath::Vector2i PLRenderer::TextureBuffer2D::m_vSize [protected]

Texture buffer size

---

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

• TextureBuffer2D.h