Beatmup.Bitmap Class Reference

Bitmap wrapper. More...

Inheritance diagram for Beatmup.Bitmap:

Classes
class	BadPixelFormat
	CoreException thrown when a native bitmap has incompatible pixel format. More...

Public Member Functions
	Bitmap (Context context, int width, int height, PixelFormat pixelFormat)
	Creates new internally managed bitmap. More...
int	getWidth ()
int	getHeight ()
IntRectangle	clientRectangle ()
PixelFormat	getPixelFormat ()
void	zero ()
	Sets all bitmap pixels to zero. More...
Bitmap	clone ()
Bitmap	clone (PixelFormat pixelFormat)
Bitmap	copyRegion (IntRectangle region)
	Creates a bitmap containing a copy of a rectangular region. More...
void	projectOn (Bitmap bitmap, int left, int top)
	Copies a rectangular area to another bitmap. More...
void	invert ()
	Pixelwise bitmap inversion. More...
void	pullPixels ()
	Transfers pixel data from GPU to CPU. More...

Static Public Member Functions
static Bitmap	createEmpty (Bitmap bitmap)
	Creates an empty bitmap of the same size and pixel format as a given bitmap. More...

Protected Member Functions
	Bitmap (Context context, android.graphics.Bitmap bitmap) throws BadPixelFormat
	Creates new bitmap from Android bitmap object. More...
Protected Member Functions inherited from Beatmup.Object
synchronized void	dispose ()
	Destroys the native object. More...

Additional Inherited Members
Protected Attributes inherited from Beatmup.Object
long	handle
	pointer to the native object More...

Detailed Description

Bitmap wrapper.

Definition at line 32 of file Bitmap.java.

Constructor & Destructor Documentation

Bitmap() [1/2]

Beatmup.Bitmap.Bitmap ( Context  context, android.graphics.Bitmap  bitmap  ) throws BadPixelFormat

inlineprotected

Creates new bitmap from Android bitmap object.

NO PIXEL DATA IS COPIED.

Parameters

context	Beatmup context
bitmap	source bitmap

Exceptions

BadPixelFormat

Definition at line 71 of file Bitmap.java.

                                                                                            {
        super(createNativeBitmapEnsuringPixelFormat(context, bitmap));
        this.context = context;
        context.watchBitmap(this);
    }

Bitmap() [2/2]

Beatmup.Bitmap.Bitmap ( Context  context, int  width, int  height, PixelFormat  pixelFormat  )

inline

Creates new internally managed bitmap.

Parameters

context	Beatmup context
width	bitmap width in pixels
height	bitmap height in pixels
pixelFormat	bitmap pixel format

Definition at line 85 of file Bitmap.java.

                                                                                   {
        super(newInternalBitmap(context, width, height, pixelFormat.ordinal()));
        this.context = context;
        context.watchBitmap(this);
    }

Member Function Documentation

createEmpty()

static Bitmap Beatmup.Bitmap.createEmpty ( Bitmap  bitmap )

inlinestatic

Creates an empty bitmap of the same size and pixel format as a given bitmap.

Parameters

bitmap

the bitmap specifying size and pixel format

Returns

the new bitmap

Definition at line 113 of file Bitmap.java.

                                                    {
        return new Bitmap(bitmap.context, bitmap.getWidth(), bitmap.getHeight(), bitmap.getPixelFormat());
    }

getWidth()

int Beatmup.Bitmap.getWidth ( )

inline

Returns

bitmap width in pixels

Definition at line 121 of file Bitmap.java.

                          {
        return getWidth(handle);
    }

getHeight()

int Beatmup.Bitmap.getHeight ( )

inline

Returns

bitmap height in pixels

Definition at line 129 of file Bitmap.java.

                           {
        return getHeight(handle);
    }

clientRectangle()

IntRectangle Beatmup.Bitmap.clientRectangle ( )

inline

Returns

bitmap border rectangle in pixels

Definition at line 137 of file Bitmap.java.

                                          {
        return new IntRectangle(0, 0, getWidth()-1, getHeight()-1);
    }

getPixelFormat()

PixelFormat Beatmup.Bitmap.getPixelFormat ( )

inline

Returns

bitmap pixel format

Definition at line 145 of file Bitmap.java.

                                        {
        return PixelFormat.values()[ getPixelFormat(handle) ];
    }

zero()

void Beatmup.Bitmap.zero ( )

inline

Sets all bitmap pixels to zero.

Definition at line 153 of file Bitmap.java.

                       {
        zero(handle);
    }

clone() [1/2]

Bitmap Beatmup.Bitmap.clone ( )

inline

Returns

copy of this bitmap

Reimplemented in Beatmup.Android.Bitmap.

Definition at line 166 of file Bitmap.java.

                          {
        return context.copyBitmap(this, getPixelFormat());
    }

clone() [2/2]

Bitmap Beatmup.Bitmap.clone ( PixelFormat  pixelFormat )

inline

Returns

copy of this bitmap with a different pixel format

Definition at line 174 of file Bitmap.java.

                                                 {
        return context.copyBitmap(this, pixelFormat);
    }

copyRegion()

Bitmap Beatmup.Bitmap.copyRegion ( IntRectangle  region )

inline

Creates a bitmap containing a copy of a rectangular region.

Parameters

region

the region to copy

Returns

the new bitmap

Definition at line 184 of file Bitmap.java.

                                                  {
        Bitmap copy = Bitmap.createByteAligned(context, region.getWidth(), region.getHeight(), getPixelFormat());
        if (copy.getWidth() != region.getWidth())
            copy.zero();
        crop(handle, copy.handle, region.x1, region.y1, region.x2, region.y2, 0, 0);
        return copy;
    }

projectOn()

void Beatmup.Bitmap.projectOn ( Bitmap  bitmap, int  left, int  top  )

inline

Copies a rectangular area to another bitmap.

The area size is equal to the target bitmap size.

Parameters

bitmap	the target bitmap
left	source area top-left corner horizontal position in pixels
top	source area top-left corner vertical position in pixels

Definition at line 198 of file Bitmap.java.

                                                            {
        crop(handle, bitmap.handle, left, top, left+bitmap.getWidth(), top+bitmap.getHeight(), 0, 0);
    }

invert()

void Beatmup.Bitmap.invert ( )

inline

Pixelwise bitmap inversion.

Definition at line 205 of file Bitmap.java.

                         {
        invert(handle);
    }

pullPixels()

void Beatmup.Bitmap.pullPixels ( )

inline

Transfers pixel data from GPU to CPU.

Definition at line 212 of file Bitmap.java.

                             {
        pullPixels(handle);
    }

---

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

• android/lib/src/main/java/Beatmup/Bitmap.java