eve.sys

Interface ImageMaker

public interface ImageMaker

Author:

Michael L Brereton

Method Summary

Modifier and Type	Method and Description
void	createImageFor(ImageDataInfo imageInfo) This is called at the start of decoding - to let the ImageMaker know the parameters of the image to be created.
ImageData	getImageData() After decoding is done this is used to retrieve the fully decoded image.
boolean	setScanLinePixels(int scanLine, int[] pixels, int offset, int destX, int destFrequency, int numPixels, int srcFrequency) This is used when decoding images.

Method Detail

createImageFor

void createImageFor(ImageDataInfo imageInfo)
             throws IllegalArgumentException

This is called at the start of decoding - to let the ImageMaker know the parameters of the image to be created. The minimum this will provide is the width and height of the image - but other information may not be available. No matter what type of image is being decoded the pixels are always provided in ARGB int format using setScanLinePixels.

Parameters:

imageInfo - information on the image to be decoded.

Throws:

IllegalArgumentException - if the ImageMaker decides it cannot create the image.

setScanLinePixels

boolean setScanLinePixels(int scanLine,
                          int[] pixels,
                          int offset,
                          int destX,
                          int destFrequency,
                          int numPixels,
                          int srcFrequency)

This is used when decoding images. For certain interlaced images the pixels on a scan line are not available as a single sequence of pixels, but rather as pixels that are spaced at fixed distances apart on the scan line.

Parameters:

scanLine - the scan line being set.

pixels - an array containing the scan line ARGB pixel values.

offset - the start of the pixel within the pixels array.

destX - the x location where the first pixel should be placed.

destFrequency - the distance between the pixels being provided. If this value is 1, then the pixels are actually right next to each other. A value of 2 means that every other pixel is being done.

numPixels - the number of pixels being set.

srcFrequency - the distance between the pixels in the pixels array. This will usually be 1 but may be any other distance.

Returns:

true if the pixels were successfully set.

getImageData

ImageData getImageData()

After decoding is done this is used to retrieve the fully decoded image.

Returns:

the fully decoded image.