org.refcodes.graphical

Interface Pixmap<PX>

Type Parameters:

PX - The type of the pixel being managed by the Pixmap.

All Known Subinterfaces:

Pixmap.PixmapProperty<PX>, Pixmap.PixmapPropertyBuilder<PX,B>, RgbPixmap, RgbPixmap.RgbPixmapProperty, RgbPixmap.RgbPixmapPropertyBuilder

All Known Implementing Classes:

RgbPixmapImpl, RgbPixmapImpl.RgbPixmapPropertyBuilderImpl

public interface Pixmap<PX>

A pixmap represents the data of a two dimensional image. The pixels may be accessed by providing an x and a y position and, depending on the sub-types, a pixel my be represented by an RgbPixel (as of the RgbPixmap type).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Pixmap.PixmapBuilder<PX,B extends Pixmap.PixmapBuilder<PX,B>> Provides a builder method for a pixmap property returning the builder for applying multiple build operations.
static interface	Pixmap.PixmapMutator<PX> Provides a mutator for a pixmap property.
static interface	Pixmap.PixmapProperty<PX> Provides a pixmap property.
static interface	Pixmap.PixmapPropertyBuilder<PX,B extends Pixmap.PixmapPropertyBuilder<PX,B>> Provides a pixmap property builder.

Method Summary

Modifier and Type	Method and Description
PX	getPixelAt(int aPosX, int aPosY) Retrieves a pixel at a given position.
PX[][]	getPixels() Returns the two dimensional pixels array representing the pixmap.
int	getPixmapHeight() Retrieves the height of the Pixmap.
int	getPixmapWidth() Retrieves the width of the Pixmap.

Method Detail

getPixels

PX[][] getPixels()

Returns the two dimensional pixels array representing the pixmap.

Returns:

The pixmap array.

getPixmapWidth

int getPixmapWidth()

Retrieves the width of the Pixmap.

Returns:

The width of the Pixmap

getPixmapHeight

int getPixmapHeight()

Retrieves the height of the Pixmap.

Returns:

The height of the Pixmap

getPixelAt

PX getPixelAt(int aPosX,
              int aPosY)
       throws IndexOutOfBoundsException

Retrieves a pixel at a given position.

Parameters:

aPosX - The x position for the pixel to be retrieved.

aPosY - The y position for the pixel to be retrieved.

Returns:

The according pixel

Throws:

IndexOutOfBoundsException - in case the index is out of bounds.