net.sf.image4j.codec.bmp
Class BMPImage

java.lang.Object
  net.sf.image4j.codec.bmp.BMPImage

Direct Known Subclasses:

ICOImage

public class BMPImage
extends java.lang.Object

Contains a decoded BMP image, as well as information about the source encoded image.

Since:

0.7

Author:

Ian McDonagh

Field Summary

protected java.awt.image.BufferedImage	image
protected InfoHeader	infoHeader

Constructor Summary

BMPImage(java.awt.image.BufferedImage image, InfoHeader infoHeader)
Creates a new instance of BMPImage

Method Summary

int	getColourCount() The number of possible colours for the BMP image.
int	getColourDepth() The colour depth of the BMP image (bits per pixel).
int	getHeight() The height of the BMP image in pixels.
java.awt.image.BufferedImage	getImage() The decoded BMP image.
InfoHeader	getInfoHeader() The InfoHeader structure representing the encoded BMP image.
int	getWidth() The width of the BMP image in pixels.
boolean	isIndexed() Specifies whether this BMP image is indexed, that is, the encoded bitmap uses a colour table.
void	setImage(java.awt.image.BufferedImage image) Sets the image to be encoded.
void	setInfoHeader(InfoHeader infoHeader) Sets the InfoHeader structure used for encoding the BMP image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

infoHeader

protected InfoHeader infoHeader

image

protected java.awt.image.BufferedImage image

Constructor Detail

BMPImage

public BMPImage(java.awt.image.BufferedImage image,
                InfoHeader infoHeader)

Creates a new instance of BMPImage

Parameters:

image - the decoded image

infoHeader - the InfoHeader structure providing information about the source encoded image

Method Detail

getInfoHeader

public InfoHeader getInfoHeader()

The InfoHeader structure representing the encoded BMP image.

setInfoHeader

public void setInfoHeader(InfoHeader infoHeader)

Sets the InfoHeader structure used for encoding the BMP image.

getImage

public java.awt.image.BufferedImage getImage()

The decoded BMP image.

setImage

public void setImage(java.awt.image.BufferedImage image)

Sets the image to be encoded.

getWidth

public int getWidth()

The width of the BMP image in pixels.

Returns:

the width of the BMP image, or -1 if unknown

Since:

0.7alpha2

getHeight

public int getHeight()

The height of the BMP image in pixels.

Returns:

the height of the BMP image, or -1 if unknown.

Since:

0.7alpha2

getColourDepth

public int getColourDepth()

The colour depth of the BMP image (bits per pixel).

Returns:

the colour depth, or -1 if unknown.

Since:

0.7alpha2

getColourCount

public int getColourCount()

The number of possible colours for the BMP image.

Returns:

the number of colours, or -1 if unknown.

Since:

0.7alpha2

isIndexed

public boolean isIndexed()

Specifies whether this BMP image is indexed, that is, the encoded bitmap uses a colour table. If getColourDepth() returns -1, the return value has no meaning.

Returns:

true if indexed, false if not.

Since:

0.7alpha2