Bitmap

java.lang.Object
- com.nutiteq.graphics.Bitmap

```
public class Bitmap
extends java.lang.Object
```
A class that provides the functionality to store, compress, uncompress and resize basic image formats.
Currently supported formats are png and jpeg. Upon loading compressed images will be converted to
alpha premultiplied uncompressed bitmaps of various image formats.

Field Summary

Fields
Modifier and Type Field and Description

protected boolean swigCMemOwn

Fields
Modifier and Type	Field and Description
`protected boolean`	`swigCMemOwn`

Constructor Summary

Constructors
Constructor and Description
`Bitmap(long cPtr, boolean cMemoryOwn)`
`Bitmap(UnsignedCharVector pixelData, long width, long height, ColorFormat colorFormat, int bytesPerRow, boolean pow2Padding)` Constructs a bitmap from an already decoded vector of bytes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UnsignedCharVector`	`compressToInternal()` Compresses this bitmap to a internal format. This operation is intended for serialization of the data only, no actual compression is performed.
`UnsignedCharVector`	`compressToPng()` Compresses this bitmap to a png.
`static Bitmap`	`createFromCompressed(UnsignedCharVector compressedData, boolean pow2Padding)` Creates a new bitmap from compressed byte vector. If the power of two conversion flag is set, additional padding will be added to the image to make it's dimensions power of two.
`void`	`delete()`
`boolean`	`equals(java.lang.Object obj)` Checks if this object is equal to the specified object.
`protected void`	`finalize()`
`long`	`getBytesPerPixel()` Returns the bytes per pixel parameter of this bitmap.
`ColorFormat`	`getColorFormat()` Returns the color format of this bitmap.
`static long`	`getCPtr(Bitmap obj)`
`long`	`getHeight()` Returns the height of the bitmap.
`long`	`getOrigHeight()` Returns the unpadded height of this bitmap.
`long`	`getOrigWidth()` Returns the unpadded width of this bitmap.
`UnsignedCharVector`	`getPixelDataCopy()` Returns a copy of the pixel data of this bitmap.
`Bitmap`	`getResizedBitmap(long width, long height, boolean pow2Padding)` Returns resized version of the bitmap.
`Bitmap`	`getRGBABitmap(boolean pow2Padding)` Returns copy of the bitmap converted to RGBA format.
`Bitmap`	`getSubBitmap(int xOffset, int yOffset, int width, int height, boolean pow2Padding)` Returns sub-bitmap with specified offsets and dimensions.
`Bitmap`	`getUnpaddedBitmap()` Returns copy of the bitmap with padding removed.
`long`	`getWidth()` Returns the width of the bitmap.
`int`	`hashCode()` Returns the hash value of this object.

Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - swigCMemOwn
```
protected boolean swigCMemOwn
```
- Constructor Detail
  - Bitmap
```
public Bitmap(long cPtr,
              boolean cMemoryOwn)
```
  - Bitmap
```
public Bitmap(UnsignedCharVector pixelData,
              long width,
              long height,
              ColorFormat colorFormat,
              int bytesPerRow,
              boolean pow2Padding)
```
    Constructs a bitmap from an already decoded vector of bytes. The bitmap data is expected to be alpha premultiplied, if alpha channel is used.
    If the power of two conversion flag is set, additional padding will be added to the image to make it's dimensions power of two.
    This can be useful when creating OpenGL textures from the Bitmap, because some GPUs perform badly with non power of two textures.
    
    Parameters:
    
    pixelData - A vector of decoded, premultiplied bitmap bytes.
    
    width - The width of the bitmap.
    
    height - The height of the bitmap.
    
    colorFormat - The color format of the bitmap.
    
    bytesPerRow - The total number of bytes per row. Some bitmaps have additional padding at the end of each row. If the value is negative, then bitmap is assumed to be vertically flipped. In this case absolute value of the bytesPerRow value is used.
    
    pow2Padding - The power of two conversion flag.
- Method Detail
  - getCPtr
```
public static long getCPtr(Bitmap obj)
```
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object
  - delete
```
public void delete()
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Checks if this object is equal to the specified object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    True when objects are equal, false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns the hash value of this object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    The hash value of this object.
  - getWidth
```
public long getWidth()
```
    Returns the width of the bitmap.
    
    Returns:
    
    The width of the bitmap.
  - getHeight
```
public long getHeight()
```
    Returns the height of the bitmap.
    
    Returns:
    
    The height of the bitmap.
  - getOrigWidth
```
public long getOrigWidth()
```
    Returns the unpadded width of this bitmap. If power of two padding was added when constructing this bitmap, the original unpadded
    bitmap's width will be returned. If no padding was added, this method is equivalent to the getWidth() method.
    
    Returns:
    
    The width of the bitmap without power of two padding.
  - getOrigHeight
```
public long getOrigHeight()
```
    Returns the unpadded height of this bitmap. If power of two padding was added when constructing this bitmap, the original unpadded
    bitmap's height will be returned. If no padding was added, this method is equivalent to the getHeight() method.
    
    Returns:
    
    The height of the bitmap without power of two padding.
  - getColorFormat
```
public ColorFormat getColorFormat()
```
    Returns the color format of this bitmap.
    
    Returns:
    
    The color format of this bitmap.
  - getBytesPerPixel
```
public long getBytesPerPixel()
```
    Returns the bytes per pixel parameter of this bitmap. Valid values are 1, 2, 3 and 4.
    
    Returns:
    
    The bytes per pixel parameter of this bitmap.
  - getPixelDataCopy
```
public UnsignedCharVector getPixelDataCopy()
```
    Returns a copy of the pixel data of this bitmap.
    
    Returns:
    
    A byte vector of the bitmap's pixel data.
  - compressToPng
```
public UnsignedCharVector compressToPng()
```
    Compresses this bitmap to a png.
    
    Returns:
    
    A byte vector of the png's data.
  - compressToInternal
```
public UnsignedCharVector compressToInternal()
```
    Compresses this bitmap to a internal format.
    This operation is intended for serialization of the data only, no actual compression is performed.
    
    Returns:
    
    A byte vector of the serialized data.
  - getResizedBitmap
```
public Bitmap getResizedBitmap(long width,
                               long height,
                               boolean pow2Padding)
```
    Returns resized version of the bitmap. The power of two padding added during the construction of this bitmap
    will be removed prior to resizing. If the power of two conversion flag is set, new padding will be added to the image
    after resizing to make it's dimensions power of two.
    
    Parameters:
    
    width - The new width of this bitmap.
    
    height - The new height of this bitmap.
    
    pow2Padding - The power of two conversion flag.
    
    Returns:
    
    The resized bitmap instance or null in case of error (wrong dimensions).
  - getSubBitmap
```
public Bitmap getSubBitmap(int xOffset,
                           int yOffset,
                           int width,
                           int height,
                           boolean pow2Padding)
```
    Returns sub-bitmap with specified offsets and dimensions.
    
    Parameters:
    
    xOffset - X coordinate offset in the bitmap.
    
    yOffset - Y coordinate offset in the bitmap.
    
    width - Width of the sub-bitmap.
    
    height - Height of the sub-bitmap.
    
    pow2Padding - The power of two conversion flag.
    
    Returns:
    
    Sub-bitmap instance or null in case of error (wrong dimensions).
  - getRGBABitmap
```
public Bitmap getRGBABitmap(boolean pow2Padding)
```
    Returns copy of the bitmap converted to RGBA format.
    
    Parameters:
    
    pow2Padding - The power of two conversion flag.
    
    Returns:
    
    The bitmap with identical dimensions but converted to RGBA format.
  - getUnpaddedBitmap
```
public Bitmap getUnpaddedBitmap()
```
    Returns copy of the bitmap with padding removed.
    
    Returns:
    
    The bitmap with original dimensions.
  - createFromCompressed
```
public static Bitmap createFromCompressed(UnsignedCharVector compressedData,
                                          boolean pow2Padding)
```
    Creates a new bitmap from compressed byte vector.
    If the power of two conversion flag is set, additional padding will be added to the image to make it's dimensions power of two.
    
    Parameters:
    
    compressedData - The compressed bitmap data.
    
    pow2Padding - The power of two conversion flag.
    
    Returns:
    
    The bitmap created from the compressed data. If the decompression fails, null is returned.

Class Bitmap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

swigCMemOwn

Constructor Detail

Bitmap

Bitmap

Method Detail

getCPtr

finalize

delete

equals

hashCode

getWidth

getHeight

getOrigWidth

getOrigHeight

getColorFormat

getBytesPerPixel

getPixelDataCopy

compressToPng

compressToInternal

getResizedBitmap

getSubBitmap

getRGBABitmap

getUnpaddedBitmap

createFromCompressed