PixelLightAPI  .
Public Member Functions | Protected Member Functions | Protected Attributes
PLRenderer::TextureBuffer1D Class Reference

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

#include <TextureBuffer1D.h>

Inheritance diagram for PLRenderer::TextureBuffer1D:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual PLRENDERER_API ~TextureBuffer1D ()
 Destructor.
PLRENDERER_API PLCore::uint32 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 TextureBuffer1D (Renderer &cRenderer, PLCore::uint32 nFlags)
 Constructor.

Protected Attributes

PLCore::uint32 m_nSize

Detailed Description

Abstract renderer 1D texture buffer resource.


Constructor & Destructor Documentation

virtual PLRENDERER_API PLRenderer::TextureBuffer1D::~TextureBuffer1D ( ) [virtual]

Destructor.

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

Constructor.

Parameters:
[in]cRendererOwner renderer
[in]nFlagsTexture buffer flags (see EFlags)

Member Function Documentation

PLRENDERER_API PLCore::uint32 PLRenderer::TextureBuffer1D::GetSize ( PLCore::uint32  nMipmap = 0) const

Returns the texture buffer size.

Parameters:
[in]nMipmapMipmap level (0 - GetNumOfMipmaps())
Returns:
Texture buffer size
virtual PLRENDERER_API PLCore::uint32 PLRenderer::TextureBuffer1D::GetNumOfPixels ( PLCore::uint32  nMipmap = 0) const [override, virtual]

Returns the number of pixels of a certain mipmap level.

Parameters:
[in]nMipmapMipmap 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::TextureBuffer1D::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]nMipmapMipmap level (0 - GetNumOfMipmaps())
[in]nFormatTarget 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

PLCore::uint32 PLRenderer::TextureBuffer1D::m_nSize [protected]

Texture buffer size


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


PixelLight PixelLight 0.9.10-R1
Copyright (C) 2002-2011 by The PixelLight Team
Last modified Fri Dec 23 2011 15:51:23
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported