Beatmup::GL::TextureHandler Class Reference

#include <texture_handler.h>

Inheritance diagram for Beatmup::GL::TextureHandler:

Public Types
enum	TextureFormat {   Rx8 , RGBx8 , RGBAx8 , Rx32f ,   RGBx32f , RGBAx32f , OES_Ext }
	Texture format, specifies how the texture should be interpreted on the shader side. More...

Public Member Functions
	~TextureHandler ()
virtual const int	getWidth () const =0
	Width of the texture in pixels. More...
virtual const int	getHeight () const =0
	Height of the texture in pixels. More...
virtual const int	getDepth () const =0
	Depth of the texture in pixels. More...
float	getAspectRatio () const
	Aspect ratio of the texture. More...
float	getInvAspectRatio () const
	Inverse of the aspect ratio of the texture. More...
virtual const TextureFormat	getTextureFormat () const =0
	Returns the texture format specifying how the shader must interpret the data. More...
const bool	isFloatingPoint () const
const int	getNumberOfChannels () const
	Returns number of channels containing in the texture. More...
bool	hasValidHandle () const
	Returns true if the texture handle points to a valid texture. More...
Public Member Functions inherited from Beatmup::Object
virtual	~Object ()

Static Public Member Functions
static const char *	textureFormatToString (const TextureFormat &)

Static Public Attributes
static const int	TEXTURE_FORMAT_BYTES_PER_PIXEL []
	size of a texel in bytes for different texture formats More...

Protected Member Functions
	TextureHandler ()
virtual void	prepare (GraphicPipeline &gpu)
	Prepares (eventually uploads) texture data on GPU. More...
void	invalidate (RecycleBin &)
	Forces disposing the texture data, e.g. More...

Protected Attributes
handle_t	textureHandle

Friends
class	::Beatmup::GraphicPipeline

Detailed Description

Definition at line 37 of file texture_handler.h.

Member Enumeration Documentation

TextureFormat

enum Beatmup::GL::TextureHandler::TextureFormat

Texture format, specifies how the texture should be interpreted on the shader side.

Enumerator
Rx8
RGBx8
RGBAx8
Rx32f
RGBx32f
RGBAx32f
OES_Ext	external EGL image

Definition at line 44 of file texture_handler.h.

                               {
                Rx8,
                RGBx8,
                RGBAx8,
                Rx32f,
                RGBx32f,
                RGBAx32f,
                OES_Ext         //!< external EGL image
            };

Constructor & Destructor Documentation

TextureHandler()

TextureHandler::TextureHandler ( )

protected

Definition at line 58 of file texture_handler.cpp.

                               :
    textureHandle(0)
{}

~TextureHandler()

TextureHandler::~TextureHandler

(

)

Definition at line 63 of file texture_handler.cpp.

                                {
    if (hasValidHandle())
        BEATMUP_DEBUG_E("Destroying texture handler still having a valid handle");
}

Member Function Documentation

textureFormatToString()

const char * TextureHandler::textureFormatToString ( const TextureFormat &  format )

static

Definition at line 35 of file texture_handler.cpp.

                                                                             {
    switch (format) {
    case GL::TextureHandler::TextureFormat::Rx8:
        return "Rx8";
    case GL::TextureHandler::TextureFormat::RGBx8:
        return "RGBx8";
    case GL::TextureHandler::TextureFormat::RGBAx8:
        return "RGBAx8";
 
    case GL::TextureHandler::TextureFormat::Rx32f:
        return "Rx32f";
    case GL::TextureHandler::TextureFormat::RGBx32f:
        return "RGBx32f";
    case GL::TextureHandler::TextureFormat::RGBAx32f:
        return "RGBAx32f";
    
    case OES_Ext:
        return "OES extension";
    }
    return "invalid format";
}

prepare()

void TextureHandler::prepare ( GraphicPipeline &  gpu )

protectedvirtual

Prepares (eventually uploads) texture data on GPU.

Called only by the context managing thread.

Parameters

[in]

gpu

Graphic pipeline instance

Reimplemented in Beatmup::Android::ExternalBitmap, Beatmup::NNets::Storage::TextureHandler, Beatmup::GL::Vector, and Beatmup::AbstractBitmap.

Definition at line 69 of file texture_handler.cpp.

                                                 {
    if (!hasValidHandle())
        glGenTextures(1, &textureHandle);
}

invalidate()

void TextureHandler::invalidate ( GL::RecycleBin &  bin )

protected

Forces disposing the texture data, e.g.

when it is not used any more

Definition at line 96 of file texture_handler.cpp.

                                                 {
    if (hasValidHandle()) {
        class Deleter : public GL::RecycleBin::Item {
            handle_t handle;
        public:
            Deleter(handle_t handle) : handle(handle) {}
            ~Deleter() {
                glDeleteTextures(1, &handle);
            }
        };
        bin.put(new Deleter(textureHandle));
 
        textureHandle = 0;
    }
}

getWidth()

virtual const int Beatmup::GL::TextureHandler::getWidth ( ) const

pure virtual

Width of the texture in pixels.

Implemented in Beatmup::Python::Bitmap, Beatmup::Android::ExternalBitmap, Beatmup::Android::Bitmap, Beatmup::NNets::Storage::TextureHandler, Beatmup::GL::Vector, Beatmup::GL::LinearMapping::Matrix, Beatmup::GDIBitmap, and Beatmup::InternalBitmap.

getHeight()

virtual const int Beatmup::GL::TextureHandler::getHeight ( ) const

pure virtual

Height of the texture in pixels.

Implemented in Beatmup::Python::Bitmap, Beatmup::Android::ExternalBitmap, Beatmup::Android::Bitmap, Beatmup::NNets::Storage::TextureHandler, Beatmup::GL::Vector, Beatmup::GL::LinearMapping::Matrix, Beatmup::GDIBitmap, and Beatmup::InternalBitmap.

getDepth()

virtual const int Beatmup::GL::TextureHandler::getDepth ( ) const

pure virtual

Depth of the texture in pixels.

Implemented in Beatmup::Android::ExternalBitmap, Beatmup::NNets::Storage::TextureHandler, Beatmup::GL::Vector, Beatmup::GL::LinearMapping::Matrix, and Beatmup::AbstractBitmap.

getAspectRatio()

float Beatmup::GL::TextureHandler::getAspectRatio ( ) const

inline

Aspect ratio of the texture.

Definition at line 96 of file texture_handler.h.

{ return (float)getWidth() / getHeight(); }

getInvAspectRatio()

float Beatmup::GL::TextureHandler::getInvAspectRatio ( ) const

inline

Inverse of the aspect ratio of the texture.

Definition at line 101 of file texture_handler.h.

{ return (float)getHeight() / getWidth(); }

getTextureFormat()

virtual const TextureFormat Beatmup::GL::TextureHandler::getTextureFormat ( ) const

pure virtual

Returns the texture format specifying how the shader must interpret the data.

Implemented in Beatmup::Android::ExternalBitmap, Beatmup::NNets::Storage::TextureHandler, Beatmup::GL::Vector, Beatmup::GL::LinearMapping::Matrix, and Beatmup::AbstractBitmap.

isFloatingPoint()

const bool Beatmup::GL::TextureHandler::isFloatingPoint ( ) const

inline

Definition at line 108 of file texture_handler.h.

                                               {
                const TextureFormat format = getTextureFormat();
                return format == TextureFormat::Rx32f || format == TextureFormat::RGBx32f || format == TextureFormat::RGBAx32f;
            }

getNumberOfChannels()

const int TextureHandler::getNumberOfChannels

(

)

const

Returns number of channels containing in the texture.

Definition at line 75 of file texture_handler.cpp.

                                                    {
    switch (getTextureFormat())
    {
    case GL::TextureHandler::TextureFormat::Rx8:
    case GL::TextureHandler::TextureFormat::Rx32f:
        return 1;
    case GL::TextureHandler::TextureFormat::RGBx8:
    case GL::TextureHandler::TextureFormat::RGBx32f:
        return 3;
    case GL::TextureHandler::TextureFormat::RGBAx8:
    case GL::TextureHandler::TextureFormat::RGBAx32f:
        return 4;
 
    case OES_Ext:
        return 3;
        //fixme
    }
    return 0;
}

hasValidHandle()

bool Beatmup::GL::TextureHandler::hasValidHandle ( ) const

inline

Returns true if the texture handle points to a valid texture.

Definition at line 121 of file texture_handler.h.

{ return textureHandle > 0; }

Friends And Related Function Documentation

::Beatmup::GraphicPipeline

friend class ::Beatmup::GraphicPipeline

friend

Definition at line 38 of file texture_handler.h.

Member Data Documentation

TEXTURE_FORMAT_BYTES_PER_PIXEL

const int TextureHandler::TEXTURE_FORMAT_BYTES_PER_PIXEL

static

Initial value:

= {
    1, 3, 4,
    4 * 1, 4 * 3, 4 * 4,
    0
}

size of a texel in bytes for different texture formats

Definition at line 54 of file texture_handler.h.

textureHandle

handle_t Beatmup::GL::TextureHandler::textureHandle

protected

Definition at line 59 of file texture_handler.h.

---

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

• core/gpu/texture_handler.h
• core/gpu/texture_handler.cpp