com.ajtjp.jImageReader.bitmap

Interface IBitmap

All Known Implementing Classes:

Bitmap, BitmapLowRAM, IndexedBitmap

public interface IBitmap

Bitmap interface. Contains common functionality across bitmap types.

Author:

Andrew

Method Summary

Modifier and Type	Method and Description
void	add(Color color) Adds a pixel of the specified color to the bitmap.
int	addRepeats(int count, Color color) Adds count pixels of the specified color, consecutively, to the bitmap.
Color	getPixel(int x, int y) Returns the Color at the specified pixel in the bitmap.
int	getPixelRGB(int x, int y) Returns the int-based RGB(A) pixel at the specified location in the bitmap.
void	goToNextScanLine() Tells the bitmap to move on to the next scan line, even if there are remaining pixels in the current one.
void	setPixel(int x, int y, Color color) Sets the pixel at location (x, y) to the given color.
void	setPixel(int x, int y, int color) Sets the pixel at location (x, y) to the given color, in 24-bit rgb format.

Method Detail

add

void add(Color color)

Adds a pixel of the specified color to the bitmap. TODO: Should this take an int instead of a color? Quite possibly yes.

Parameters:

color - The color to be added to the bitmap.

addRepeats

int addRepeats(int count,
               Color color)

Adds count pixels of the specified color, consecutively, to the bitmap.

Parameters:

count - The number of times (in pixels) the color should be added.

color - The color to be added to the bitmap.

Returns:

How many pixels were added (should equal repeats).

getPixel

Color getPixel(int x,
               int y)

Returns the Color at the specified pixel in the bitmap.

Parameters:

x - X (horizontal) coordinate, left-to-right.

y - Y (vertical) coordinate, top-to-bottom.

Returns:

The Color of the requested pixel.

getPixelRGB

int getPixelRGB(int x,
                int y)

Returns the int-based RGB(A) pixel at the specified location in the bitmap.

Parameters:

x - X (horizontal) coordinate, left-to-right.

y - Y (vertical) coordinate, top-to-bottom.

Returns:

the RGB value of the color of the pixel in the default sRGB color model

setPixel

void setPixel(int x,
              int y,
              Color color)

Sets the pixel at location (x, y) to the given color.

Parameters:

x - The x (horizontal) coordinate of the pixel, left-to-right.

y - The y (vertical) coordinate, top-to-bottom.

color - The color the pixel should be set to.

setPixel

void setPixel(int x,
              int y,
              int color)

Sets the pixel at location (x, y) to the given color, in 24-bit rgb format.

Parameters:

x - The x (horizontal) coordinate of the pixel, left-to-right.

y - The y (vertical) coordinate, top-to-bottom.

color - The color the pixel should be set to.

goToNextScanLine

void goToNextScanLine()

Tells the bitmap to move on to the next scan line, even if there are remaining pixels in the current one. The implementation will fill in those pixels.