eve.fx

Class BufferedImageData

java.lang.Object

eve.fx.ImageObject

eve.fx.BufferedImageData

All Implemented Interfaces:

Drawable, IImage, ImageMaker, IScanLineStore, ImageData

public class BufferedImageData
extends ImageObject
implements IScanLineStore

Author:

Michael L Brereton

Field Summary

Fields

Modifier and Type	Field and Description
java.awt.image.BufferedImage	bi

Fields inherited from class eve.fx.ImageObject

background, height, width

Fields inherited from interface eve.sys.ImageData

CREATE_OPTION_DONT_SCALE_UP, CREATE_OPTION_IGNORE_ALPHA, CREATE_OPTION_KEEP_ASPECT_RATIO, CREATE_OPTION_ROUGH_SCALING, SCAN_LINE_BYTE_ARRAY, SCAN_LINE_INT_ARRAY, TYPE_ARGB, TYPE_GRAY_SCALE_16, TYPE_GRAY_SCALE_2, TYPE_GRAY_SCALE_256, TYPE_GRAY_SCALE_4, TYPE_INDEXED_16, TYPE_INDEXED_2, TYPE_INDEXED_256, TYPE_INDEXED_4, TYPE_MASK, TYPE_MONO, TYPE_RGB, TYPE_UNKNOWN

Fields inherited from interface eve.fx.Drawable

ACTIVE, DISABLED, INACTIVE, INDENT_ITEM_FLAG, OUTLINED

Constructor Summary

Constructors

Constructor and Description
BufferedImageData(java.awt.image.BufferedImage bi)
BufferedImageData(ImageData from)
BufferedImageData(ImageData from, boolean dontCopy)

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics g, int x, int y, int options)
void	free()
void	freeScanLines()
void	getImageScanLines(int startLine, int numLines, Object destArray, int offset, int destScanLineLength) Place a set of scan lines into a destination array.
void	getPixels(int[] dest, int offset, int line)
int[]	getPixels(int[] dest, int offset, int x, int y, int width, int height, int rowStride) Retrieve the pixels from the Image in encoded ARGB values.
boolean	isWriteableImage() Returns if you can write data to the ImageData.
void	setImageScanLines(int startLine, int numLines, Object sourceArray, int offset, int sourceScanLineLength) Place a set of scan lines from a source Array into the ImageData.
boolean	setPixels(int[] src, int offset, int x, int y, int width, int height, int rowStride) Set the pixels in the IImage in encoded ARGB values.
boolean	usesAlpha() Returns whether the image uses the Alpha channel.

Methods inherited from class eve.fx.ImageObject

createImageFor, draw, draw, freeImage, getBackground, getCompatibleImagePoints, getDPI, getHeight, getImageColorTable, getImageData, getImageHeight, getImageScanLineLength, getImageScanLineType, getImageType, getImageWidth, getNativeDrawable, getPixelsUsingScanLines, getScanLinesUsingPixels, getWidth, isReadableImage, scanLinesComplete, setPixelsUsingScanLines, setScanLinePixels, setScanLinesUsingPixels

Methods inherited from class java.lang.Object

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

Field Detail

bi

public java.awt.image.BufferedImage bi

Constructor Detail

BufferedImageData

public BufferedImageData(java.awt.image.BufferedImage bi)

BufferedImageData

public BufferedImageData(ImageData from)

BufferedImageData

public BufferedImageData(ImageData from,
                         boolean dontCopy)

Method Detail

draw

public void draw(Graphics g,
                 int x,
                 int y,
                 int options)

Specified by:

draw in interface Drawable

free

public void free()

Specified by:

free in interface Drawable

Overrides:

free in class ImageObject

getPixels

public int[] getPixels(int[] dest,
                       int offset,
                       int x,
                       int y,
                       int width,
                       int height,
                       int rowStride)

Description copied from interface: ImageData

Retrieve the pixels from the Image in encoded ARGB values. If the usesAlpha() method returns false, then the A component of each pixel value (the top 8 bits) should be ignored.

Specified by:

getPixels in interface ImageData

Parameters:

dest - The destination int array. If this is null then a new array should be created.

offset - The offset into the array to start placing pixels.

x - the x co-ordinate within the image.

y - the y co-ordinate within the image.

width - the width of the pixel block to get.

height - the height of the pixel block to get.

rowStride - the number of int values between each row in the destination int array. If this is 0 it will be assumed to be equal to width.

Returns:

The array containing the pixels, or null if getting pixels is not supported.

setPixels

public boolean setPixels(int[] src,
                         int offset,
                         int x,
                         int y,
                         int width,
                         int height,
                         int rowStride)

Description copied from interface: ImageData

Set the pixels in the IImage in encoded ARGB values. If the usesAlpha() method returns false, then the A component of each pixel value (the top 8 bits) will be ignored.

Specified by:

setPixels in interface ImageData

Parameters:

src - The source int array.

offset - The offset into the array to start retrieving pixels.

x - the x co-ordinate within the image.

y - the y co-ordinate within the image.

width - the width of the pixel block to get.

height - the height of the pixel block to get.

rowStride - the number of int values between each row in the source int array. If this is 0 it will be assumed to be equal to width.

Returns:

true if setting pixel values is supported, false if not.

usesAlpha

public boolean usesAlpha()

Description copied from interface: IImage

Returns whether the image uses the Alpha channel.

Specified by:

usesAlpha in interface IImage

getImageScanLines

public void getImageScanLines(int startLine,
                              int numLines,
                              Object destArray,
                              int offset,
                              int destScanLineLength)
                       throws IllegalStateException

Description copied from interface: ImageData

Place a set of scan lines into a destination array. The type of the destination array must be either byte[] or int[] depending on the value of getImageScanLineType().

Specified by:

getImageScanLines in interface ImageData

Throws:

IllegalStateException

setImageScanLines

public void setImageScanLines(int startLine,
                              int numLines,
                              Object sourceArray,
                              int offset,
                              int sourceScanLineLength)
                       throws IllegalStateException

Description copied from interface: ImageData

Place a set of scan lines from a source Array into the ImageData. The type of the destination array must be either byte[] or int[] depending on the value of getImageScanLineType().

Specified by:

setImageScanLines in interface ImageData

Throws:

IllegalStateException

isWriteableImage

public boolean isWriteableImage()

Description copied from interface: ImageData

Returns if you can write data to the ImageData.

Specified by:

isWriteableImage in interface ImageData

getPixels

public void getPixels(int[] dest,
                      int offset,
                      int line)

Specified by:

getPixels in interface IScanLineStore

freeScanLines

public void freeScanLines()

Specified by:

freeScanLines in interface IScanLineStore