A very basic class for any image. More...

#include <abstract_bitmap.h>

Inheritance diagram for Beatmup::AbstractBitmap:

Classes
class	ReadLock
	Locks a bitmap for reading on CPU. More...

class	WriteLock
	Makes a bitmap writable for a specific target device. More...

Public Member Functions
virtual const int	getDepth () const
	Depth of the texture in pixels. More...

virtual const TextureFormat	getTextureFormat () const
	Returns the texture format specifying how the shader must interpret the data. More...

virtual const PixelFormat	getPixelFormat () const =0
	Pixel format of the bitmap. More...

virtual const msize	getMemorySize () const =0
	Bitmap size in bytes. More...

bool	isUpToDate (ProcessingTarget) const

bool	isDirty () const
	Returns `true` if the bitmap does not contain any valid content. More...

virtual const pixbyte *	getData (int x, int y) const =0
	Returns a pointer to given pixel. More...

virtual pixbyte *	getData (int x, int y)=0

int	getPixelInt (int x, int y, int cha=0) const
	Retrieves integer value of given channel at given pixel. More...

const unsigned char	getBitsPerPixel () const
	Returns number of bits per pixel stored in each bitmap. More...

const unsigned char	getNumberOfChannels () const
	Returns number of bytes per pixel stored in each bitmap. More...

const ImageResolution	getSize () const
	Returns the bitmap resolution within ImageResolution object. More...

Context &	getContext () const

void	zero ()
	Sets all the pixels to zero. More...

bool	isInteger () const
	Returns `true` if the bitmap contains integer values, `false` otherwise. More...

bool	isFloat () const
	Returns `true` if the bitmap contains floating point values, `false` otherwise. More...

bool	isMask () const
	Returns `true` if the bitmap is a mask, `false` otherwise. More...

std::string	toString () const
	Retruns a string describing the bitmap. More...

void	saveBmp (const char *filename)
	Saves the bitmap to a BMP file. More...

	~AbstractBitmap ()

Public Member Functions inherited from Beatmup::GL::TextureHandler
	~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...

float	getAspectRatio () const
	Aspect ratio of the texture. More...

float	getInvAspectRatio () const
	Inverse of the aspect ratio of the texture. 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 bool	isInteger (PixelFormat pixelFormat)
	Returns `true` if a given pixel format corresponds to integer values, `false` otherwise. More...

static bool	isFloat (PixelFormat pixelFormat)
	Returns `true` if a given pixel format corresponds to floating point values, `false` otherwise. More...

static bool	isMask (PixelFormat pixelFormat)
	Returns `true` if a given pixel format corresponds to a mask, `false` otherwise. More...

Static Public Member Functions inherited from Beatmup::GL::TextureHandler
static const char *	textureFormatToString (const TextureFormat &)

Static Public Attributes
static const int	NUM_PIXEL_FORMATS = 9

static const char *	PIXEL_FORMAT_NAMES [NUM_PIXEL_FORMATS]
	pixel format names More...

static const unsigned char	CHANNELS_PER_PIXEL [NUM_PIXEL_FORMATS]
	number of channels for each pixel format More...

static const unsigned char	BITS_PER_PIXEL [NUM_PIXEL_FORMATS]
	number of bits per pixel for each pixel format More...

Static Public Attributes inherited from Beatmup::GL::TextureHandler
static const int	TEXTURE_FORMAT_BYTES_PER_PIXEL []
	size of a texel in bytes for different texture formats More...

Protected Member Functions
	AbstractBitmap (Context &ctx)

virtual void	lockPixelData ()=0
	Locks access to the CPU memory buffer containing pixel data. More...

virtual void	unlockPixelData ()=0
	Unlocks access to the CPU memory buffer containing pixel data. More...

virtual void	prepare (GraphicPipeline &gpu)
	Prepares (eventually uploads) texture data on GPU. More...

Protected Member Functions inherited from Beatmup::GL::TextureHandler
	TextureHandler ()

void	invalidate (RecycleBin &)
	Forces disposing the texture data, e.g. More...

Protected Attributes
Context &	ctx
	context managing this bitmap More...

bool	upToDate [2]
	bitmap up-to-date state on CPU and GPU More...

Protected Attributes inherited from Beatmup::GL::TextureHandler
handle_t	textureHandle

Private Member Functions
	AbstractBitmap (const AbstractBitmap &that)=delete
	disabling copying constructor More...

Friends
class	GraphicPipeline

class	BitmapContentLock

class	AbstractBitmap::ReadLock

class	AbstractBitmap::WriteLock< ProcessingTarget::CPU >

class	AbstractBitmap::WriteLock< ProcessingTarget::GPU >

Additional Inherited Members
Public Types inherited from Beatmup::GL::TextureHandler
enum	TextureFormat { Rx8 , RGBx8 , RGBAx8 , Rx32f , RGBx32f , RGBAx32f , OES_Ext }
	Texture format, specifies how the texture should be interpreted on the shader side. More...

Detailed Description

A very basic class for any image.

Contains interfaces to access the bitmap information and its content.

Definition at line 87 of file abstract_bitmap.h.

Constructor & Destructor Documentation

◆ AbstractBitmap() [1/2]

Beatmup::AbstractBitmap::AbstractBitmap ( const AbstractBitmap & that )

privatedelete

disabling copying constructor

◆ AbstractBitmap() [2/2]

AbstractBitmap::AbstractBitmap ( Context & ctx )

protected

Definition at line 208 of file abstract_bitmap.cpp.

                                            : ctx(ctx) {
     upToDate[ProcessingTarget::CPU] = true;
     upToDate[ProcessingTarget::GPU] = false;
 }

◆ ~AbstractBitmap()

AbstractBitmap::~AbstractBitmap ( )

Definition at line 214 of file abstract_bitmap.cpp.

                                 {
     if (hasValidHandle()) {
         TextureHandler::invalidate(*ctx.getGpuRecycleBin());
     }
 }

Member Function Documentation

◆ lockPixelData()

virtual void Beatmup::AbstractBitmap::lockPixelData ( )

protectedpure virtual

Locks access to the CPU memory buffer containing pixel data.

Implemented in Beatmup::Python::Bitmap, Beatmup::Android::ExternalBitmap, Beatmup::Android::Bitmap, Beatmup::GDIBitmap, and Beatmup::InternalBitmap.

◆ unlockPixelData()

virtual void Beatmup::AbstractBitmap::unlockPixelData ( )

protectedpure virtual

Unlocks access to the CPU memory buffer containing pixel data.

Implemented in Beatmup::Python::Bitmap, Beatmup::Android::ExternalBitmap, Beatmup::Android::Bitmap, Beatmup::GDIBitmap, and Beatmup::InternalBitmap.

◆ prepare()

void AbstractBitmap::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 from Beatmup::GL::TextureHandler.

Reimplemented in Beatmup::Android::ExternalBitmap.

Definition at line 54 of file abstract_bitmap.cpp.

                                                  {
     const bool handleValid = hasValidHandle();
  
     if (!handleValid)
         TextureHandler::prepare(gpu);
     glBindTexture(GL_TEXTURE_2D, textureHandle);
  
     // setup alignment
     if (isMask()) {
         // masks are stored as horizontally-stretched bitmaps
         const int textureWidth = getWidth() / (8 / getBitsPerPixel());
  
 #ifdef BEATMUP_OPENGLVERSION_GLES20
         if (!handleValid)
             glTexImage2D(GL_TEXTURE_2D, 0, GL_ALPHA, textureWidth, getHeight(), 0, GL_ALPHA, GL_UNSIGNED_BYTE, nullptr);
 #else
         if (!handleValid)
             glTexStorage2D(GL_TEXTURE_2D, 1, GL_R8, textureWidth, getHeight());
 #endif
         GL::GLException::check("allocating texture image (mask)");
         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
     }
  
     else {
 #ifdef BEATMUP_OPENGLVERSION_GLES20
         if (!handleValid)
             glTexImage2D(GL_TEXTURE_2D,
                 0,
                 GL::BITMAP_INTERNALFORMATS[getPixelFormat()],
                 getWidth(), getHeight(),
                 0,
                 GL::BITMAP_PIXELFORMATS[getPixelFormat()],
                 GL::BITMAP_PIXELTYPES[getPixelFormat()],
                 nullptr);
  
 #else
         if (!handleValid)
             glTexStorage2D(GL_TEXTURE_2D, 1, GL::BITMAP_INTERNALFORMATS[getPixelFormat()], getWidth(), getHeight());
 #endif
         GL::GLException::check("allocating texture image");
     }
 }

◆ getDepth()

virtual const int Beatmup::AbstractBitmap::getDepth ( ) const

inlinevirtual

Depth of the texture in pixels.

Implements Beatmup::GL::TextureHandler.

Reimplemented in Beatmup::Android::ExternalBitmap.

Definition at line 127 of file abstract_bitmap.h.

127 { return 1; }

◆ getTextureFormat()

const GL::TextureHandler::TextureFormat AbstractBitmap::getTextureFormat ( ) const

virtual

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

Implements Beatmup::GL::TextureHandler.

Reimplemented in Beatmup::Android::ExternalBitmap.

Definition at line 99 of file abstract_bitmap.cpp.

                                                                            {
     if (isMask())
         return TextureFormat::Rx8;
     return (TextureFormat)getPixelFormat();
 }

◆ getPixelFormat()

virtual const PixelFormat Beatmup::AbstractBitmap::getPixelFormat ( ) const

pure virtual

Pixel format of the bitmap.

Implemented in Beatmup::Python::Bitmap, Beatmup::Android::ExternalBitmap, Beatmup::Android::Bitmap, Beatmup::GDIBitmap, and Beatmup::InternalBitmap.

◆ getMemorySize()

virtual const msize Beatmup::AbstractBitmap::getMemorySize ( ) const

pure virtual

Bitmap size in bytes.

Implemented in Beatmup::Python::Bitmap, Beatmup::Android::ExternalBitmap, Beatmup::Android::Bitmap, Beatmup::GDIBitmap, and Beatmup::InternalBitmap.

◆ isUpToDate()

bool AbstractBitmap::isUpToDate ( ProcessingTarget target ) const

Definition at line 106 of file abstract_bitmap.cpp.

                                                              {
     return upToDate[target];
 }

◆ isDirty()

bool AbstractBitmap::isDirty ( ) const

Returns true if the bitmap does not contain any valid content.

Definition at line 111 of file abstract_bitmap.cpp.

                                    {
     return !upToDate[ProcessingTarget::CPU] && !upToDate[ProcessingTarget::GPU];
 }

◆ getData() [1/2]

virtual const pixbyte* Beatmup::AbstractBitmap::getData	(	int	x,
		int	y
	)		const

pure virtual

Returns a pointer to given pixel.

Parameters

x	target pixel horizontal coordinate
y	target pixel vertical coordinate

Returns: a pointer, may be NULL.

Implemented in Beatmup::Python::Bitmap, Beatmup::Android::ExternalBitmap, Beatmup::Android::Bitmap, Beatmup::GDIBitmap, and Beatmup::InternalBitmap.

◆ getData() [2/2]

virtual pixbyte* Beatmup::AbstractBitmap::getData	(	int	x,
		int	y
	)

pure virtual

Implemented in Beatmup::Python::Bitmap, Beatmup::Android::ExternalBitmap, Beatmup::Android::Bitmap, and Beatmup::InternalBitmap.

◆ getPixelInt()

int AbstractBitmap::getPixelInt	(	int	x,
		int	y,
		int	cha = `0`
	)		const

Retrieves integer value of given channel at given pixel.

Parameters

x	target pixel horizontal coordinate
y	target pixel vertical coordinate
cha	target channel

Returns: requested pixel value

Definition at line 116 of file abstract_bitmap.cpp.

                                                            {
     PixelFormat pf = getPixelFormat();
     if (isMask(pf)) {
         unsigned char
             pixPerByte = 8 / BITS_PER_PIXEL[pf],
             offset = (x + y*getWidth()) % pixPerByte;           // offset from byte-aligned bound in pixels
         const pixbyte* p = getData(x, y);
         return ((*p) >> (offset*BITS_PER_PIXEL[pf])) & ((1 << BITS_PER_PIXEL[pf]) - 1);
     }
     const pixbyte* p = getData(x, y) + cha * BITS_PER_PIXEL[pf] / 8 / CHANNELS_PER_PIXEL[pf];
     if (isInteger(pf))
         return *p;
     //if (isFloat(pf))
         return (int)(*((float*)p) * 255);
 }

◆ getBitsPerPixel()

const unsigned char AbstractBitmap::getBitsPerPixel ( ) const

Returns number of bits per pixel stored in each bitmap.

Definition at line 133 of file abstract_bitmap.cpp.

                                                           {
     return BITS_PER_PIXEL[getPixelFormat()];
 }

◆ getNumberOfChannels()

const unsigned char AbstractBitmap::getNumberOfChannels ( ) const

Returns number of bytes per pixel stored in each bitmap.

Definition at line 138 of file abstract_bitmap.cpp.

                                                               {
     return CHANNELS_PER_PIXEL[getPixelFormat()];
 }

◆ getSize()

const ImageResolution Beatmup::AbstractBitmap::getSize ( ) const

inline

Returns the bitmap resolution within ImageResolution object.

Definition at line 178 of file abstract_bitmap.h.

                                               {
             return ImageResolution(getWidth(), getHeight());
         }

◆ getContext()

Context & AbstractBitmap::getContext ( ) const

Definition at line 221 of file abstract_bitmap.cpp.

                                           {
     return ctx;
 }

◆ zero()

void AbstractBitmap::zero ( )

Sets all the pixels to zero.

Definition at line 226 of file abstract_bitmap.cpp.

                           {
     lockPixelData();
     memset(getData(0, 0), 0, getMemorySize());
     unlockPixelData();
     upToDate[ProcessingTarget::CPU] = true;
     upToDate[ProcessingTarget::GPU] = false;
 }

◆ isInteger() [1/2]

bool AbstractBitmap::isInteger ( ) const

Returns true if the bitmap contains integer values, false otherwise.

Definition at line 143 of file abstract_bitmap.cpp.

                                      {
     return isInteger(getPixelFormat());
 }

◆ isFloat() [1/2]

bool AbstractBitmap::isFloat ( ) const

Returns true if the bitmap contains floating point values, false otherwise.

Definition at line 148 of file abstract_bitmap.cpp.

                                    {
     return isFloat(getPixelFormat());
 }

◆ isMask() [1/2]

bool AbstractBitmap::isMask ( ) const

Returns true if the bitmap is a mask, false otherwise.

Definition at line 153 of file abstract_bitmap.cpp.

                                   {
     return isMask(getPixelFormat());
 }

◆ isInteger() [2/2]

bool AbstractBitmap::isInteger ( PixelFormat pixelFormat )

static

Returns true if a given pixel format corresponds to integer values, false otherwise.

Definition at line 158 of file abstract_bitmap.cpp.

                                                       {
     return pixelFormat == SingleByte|| pixelFormat == TripleByte || pixelFormat == QuadByte;
 }

◆ isFloat() [2/2]

bool AbstractBitmap::isFloat ( PixelFormat pixelFormat )

static

Returns true if a given pixel format corresponds to floating point values, false otherwise.

Definition at line 163 of file abstract_bitmap.cpp.

                                                     {
     return pixelFormat == SingleFloat || pixelFormat == TripleFloat || pixelFormat == QuadFloat;
 }

◆ isMask() [2/2]

bool AbstractBitmap::isMask ( PixelFormat pixelFormat )

static

Returns true if a given pixel format corresponds to a mask, false otherwise.

Definition at line 168 of file abstract_bitmap.cpp.

                                                    {
     return pixelFormat == BinaryMask || pixelFormat == QuaternaryMask || pixelFormat == HexMask;
 }

◆ toString()

std::string AbstractBitmap::toString ( ) const

Retruns a string describing the bitmap.

Definition at line 173 of file abstract_bitmap.cpp.

                                          {
     std::string desc = std::to_string(getWidth()) + "x" + std::to_string(getHeight()) + " " + PIXEL_FORMAT_NAMES[getPixelFormat()];
     if (isUpToDate(ProcessingTarget::CPU) && isUpToDate(ProcessingTarget::GPU))
         desc += " stored on CPU+GPU";
     else
         if (isUpToDate(ProcessingTarget::CPU))
             desc += " stored on CPU";
         else
             if (isUpToDate(ProcessingTarget::GPU))
                 desc += " stored on GPU";
             else
                 desc += " dirty";
     return desc;
 }

◆ saveBmp()

void AbstractBitmap::saveBmp ( const char * filename )

Saves the bitmap to a BMP file.

Definition at line 189 of file abstract_bitmap.cpp.

                                                  {
     if (!isUpToDate(ProcessingTarget::CPU)) {
         // Grab output bitmap from GPU memory to RAM
         Swapper::pullPixels(*this);
     }
  
     lockPixelData();
  
     BmpFile::save(
         getData(0, 0),
         getWidth(), getHeight(),
         getBitsPerPixel(),
         filename
     );
  
     unlockPixelData();
 }

Friends And Related Function Documentation

◆ GraphicPipeline

friend class GraphicPipeline

friend

Definition at line 93 of file abstract_bitmap.h.

◆ BitmapContentLock

friend class BitmapContentLock

friend

Definition at line 94 of file abstract_bitmap.h.

◆ AbstractBitmap::ReadLock

friend class AbstractBitmap::ReadLock

friend

Definition at line 95 of file abstract_bitmap.h.

◆ AbstractBitmap::WriteLock< ProcessingTarget::CPU >

friend class AbstractBitmap::WriteLock< ProcessingTarget::CPU >

friend

Definition at line 95 of file abstract_bitmap.h.

◆ AbstractBitmap::WriteLock< ProcessingTarget::GPU >

friend class AbstractBitmap::WriteLock< ProcessingTarget::GPU >

friend

Definition at line 95 of file abstract_bitmap.h.

Member Data Documentation

◆ ctx

Context& Beatmup::AbstractBitmap::ctx

protected

context managing this bitmap

Definition at line 102 of file abstract_bitmap.h.

◆ upToDate

bool Beatmup::AbstractBitmap::upToDate[2]

protected

bitmap up-to-date state on CPU and GPU

Definition at line 103 of file abstract_bitmap.h.

◆ NUM_PIXEL_FORMATS

const int Beatmup::AbstractBitmap::NUM_PIXEL_FORMATS = 9

static

Definition at line 121 of file abstract_bitmap.h.

◆ PIXEL_FORMAT_NAMES

const char * AbstractBitmap::PIXEL_FORMAT_NAMES

static

Initial value:

= {
    "single byte", "triple byte", "quad byte",
    "single floating point", "triple floating point", "quad floating point",
    "binary mask", "quaternary mask", "hexadecimal mask"
}

pixel format names

Definition at line 122 of file abstract_bitmap.h.

◆ CHANNELS_PER_PIXEL

const unsigned char AbstractBitmap::CHANNELS_PER_PIXEL

static

Initial value:

number of channels for each pixel format

Definition at line 123 of file abstract_bitmap.h.

◆ BITS_PER_PIXEL

const unsigned char AbstractBitmap::BITS_PER_PIXEL

static

Initial value:

= {
     8,  8*3,  8*4,     
    32, 32*3, 32*4,     
    1, 2, 4             
}

number of bits per pixel for each pixel format

Definition at line 124 of file abstract_bitmap.h.

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

core/bitmap/abstract_bitmap.h
core/bitmap/abstract_bitmap.cpp

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AbstractBitmap() [1/2]

◆ AbstractBitmap() [2/2]

◆ ~AbstractBitmap()

Member Function Documentation

◆ lockPixelData()

◆ unlockPixelData()

◆ prepare()

◆ getDepth()

◆ getTextureFormat()

◆ getPixelFormat()

◆ getMemorySize()

◆ isUpToDate()

◆ isDirty()

◆ getData() [1/2]

◆ getData() [2/2]

◆ getPixelInt()

◆ getBitsPerPixel()

◆ getNumberOfChannels()

◆ getSize()

◆ getContext()

◆ zero()

◆ isInteger() [1/2]

◆ isFloat() [1/2]

◆ isMask() [1/2]

◆ isInteger() [2/2]

◆ isFloat() [2/2]

◆ isMask() [2/2]

◆ toString()

◆ saveBmp()

Friends And Related Function Documentation

◆ GraphicPipeline

◆ BitmapContentLock

◆ AbstractBitmap::ReadLock

◆ AbstractBitmap::WriteLock< ProcessingTarget::CPU >

◆ AbstractBitmap::WriteLock< ProcessingTarget::GPU >

Member Data Documentation

◆ ctx

◆ upToDate

◆ NUM_PIXEL_FORMATS

◆ PIXEL_FORMAT_NAMES

◆ CHANNELS_PER_PIXEL

◆ BITS_PER_PIXEL