de.gurkenlabs.litiengine.util

Class ImageProcessing

java.lang.Object

de.gurkenlabs.litiengine.util.ImageProcessing

public class ImageProcessing
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	CROP_ALIGN_CENTER
static int	CROP_ALIGN_LEFT
static int	CROP_ALIGN_RIGHT
static int	CROP_VALIGN_BOTTOM
static int	CROP_VALIGN_CENTER
static int	CROP_VALIGN_TOP
static int	CROP_VALIGN_TOPCENTER

Method Summary

Modifier and Type	Method and Description
static java.awt.image.BufferedImage	addShadow(java.awt.image.BufferedImage image, int xOffset, int yOffset) Adds a shadow effect by executing the following steps: 1.
static java.awt.Image	applyAlphaChannel(java.awt.Image img, java.awt.Color color) All pixels that have the specified color are rendered transparent.
static java.awt.image.BufferedImage	borderAlpha(java.awt.image.BufferedImage image, java.awt.Color strokeColor, boolean borderOnly)
static java.awt.image.BufferedImage	convertToGrayScale(java.awt.image.BufferedImage image)
static java.awt.image.BufferedImage	crop(java.awt.image.BufferedImage image, int cropAlignment, int cropVerticlaAlignment, int width, int height) Crops a sub image from the specified image.
static java.awt.image.BufferedImage	decodeToImage(java.lang.String imageString)
static java.lang.String	encodeToString(java.awt.image.BufferedImage image)
static java.lang.String	encodeToString(java.awt.image.BufferedImage image, ImageFormat imageFormat)
static java.awt.image.BufferedImage	flashVisiblePixels(java.awt.Image image, java.awt.Color flashColor) All pixels that are not transparent are replaced by a pixel of the specified flashColor.
static java.awt.image.BufferedImage	flipSpritesHorizontally(Spritesheet sprite)
static java.awt.image.BufferedImage	flipSpritesVertically(Spritesheet sprite)
static java.awt.image.BufferedImage	getCompatibleImage(int width, int height)
static java.awt.image.BufferedImage	getCopy(java.awt.image.BufferedImage bi)
static java.awt.image.BufferedImage[][]	getSubImages(java.awt.image.BufferedImage image, int rows, int columns)
static java.awt.image.BufferedImage	horizontalFlip(java.awt.image.BufferedImage img) Horizontalflip.
static boolean	isEmpty(java.awt.image.BufferedImage image)
static boolean	needsBorder(java.awt.image.BufferedImage image, int x, int y) Needs border.
static java.awt.image.BufferedImage	rotate(java.awt.image.BufferedImage bufferedImage, double radians)
static java.awt.image.BufferedImage	rotate(java.awt.image.BufferedImage bufferedImage, Rotation rotation)
static java.awt.image.BufferedImage	scaleImage(java.awt.image.BufferedImage image, float factor)
static java.awt.image.BufferedImage	scaleImage(java.awt.image.BufferedImage image, int max)
static java.awt.image.BufferedImage	scaleImage(java.awt.image.BufferedImage image, int width, int height) The specified image is scaled to a new dimension with the specified width and height.
static java.awt.image.BufferedImage	scaleImage(java.awt.image.BufferedImage image, int width, int height, boolean keepRatio)
static java.awt.image.BufferedImage	scaleImage(java.awt.image.BufferedImage image, int width, int height, boolean keepRatio, boolean fill)
static java.awt.image.BufferedImage	scaleImageWidth(java.awt.image.BufferedImage image, int newWidth)
static java.awt.image.BufferedImage	setOpacity(java.awt.Image img, float opacity)
static java.awt.image.BufferedImage	toBufferedImage(java.awt.Image img)
static java.awt.image.BufferedImage	verticalFlip(java.awt.image.BufferedImage img)
static java.awt.image.BufferedImage	zoom(java.awt.image.BufferedImage image, float zoomLevel)

Methods inherited from class java.lang.Object

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

Field Detail

CROP_ALIGN_CENTER

public static final int CROP_ALIGN_CENTER

See Also:

Constant Field Values

CROP_ALIGN_LEFT

public static final int CROP_ALIGN_LEFT

See Also:

Constant Field Values

CROP_ALIGN_RIGHT

public static final int CROP_ALIGN_RIGHT

See Also:

Constant Field Values

CROP_VALIGN_BOTTOM

public static final int CROP_VALIGN_BOTTOM

See Also:

Constant Field Values

CROP_VALIGN_CENTER

public static final int CROP_VALIGN_CENTER

See Also:

Constant Field Values

CROP_VALIGN_TOP

public static final int CROP_VALIGN_TOP

See Also:

Constant Field Values

CROP_VALIGN_TOPCENTER

public static final int CROP_VALIGN_TOPCENTER

See Also:

Constant Field Values

Method Detail

addShadow

public static java.awt.image.BufferedImage addShadow(java.awt.image.BufferedImage image,
                                                     int xOffset,
                                                     int yOffset)

Adds a shadow effect by executing the following steps: 1. Transform visible pixels to a semi-transparent black 2. Flip the image vertically 3. Scale it down 4. Render original image and shadow on a buffered image

Parameters:

image - the image

xOffset - the x offset

yOffset - the y offset

Returns:

the buffered image

applyAlphaChannel

public static java.awt.Image applyAlphaChannel(java.awt.Image img,
                                               java.awt.Color color)

All pixels that have the specified color are rendered transparent.

Parameters:

img - the img

color - the color

Returns:

the image

borderAlpha

public static java.awt.image.BufferedImage borderAlpha(java.awt.image.BufferedImage image,
                                                       java.awt.Color strokeColor,
                                                       boolean borderOnly)

isEmpty

public static boolean isEmpty(java.awt.image.BufferedImage image)

crop

public static java.awt.image.BufferedImage crop(java.awt.image.BufferedImage image,
                                                int cropAlignment,
                                                int cropVerticlaAlignment,
                                                int width,
                                                int height)

Crops a sub image from the specified image.

Parameters:

image - The image to crop the sub-image from.

cropAlignment - use the following consts:

• CROP_ALIGN_CENTER
• CROP_ALIGN_LEFT
• CROP_ALIGN_RIGHT

cropVerticlaAlignment - use the following consts:

• CROP_VALIGN_CENTER
• CROP_VALIGN_TOP
• CROP_VALIGN_TOPCENTER
• CROP_VALIGN_BOTTOM

width - The width to crop.

height - The height to crop.

Returns:

The cropped image or the original image if it is smaller than the specified dimensions.

decodeToImage

public static java.awt.image.BufferedImage decodeToImage(java.lang.String imageString)

encodeToString

public static java.lang.String encodeToString(java.awt.image.BufferedImage image)

encodeToString

public static java.lang.String encodeToString(java.awt.image.BufferedImage image,
                                              ImageFormat imageFormat)

flashVisiblePixels

public static java.awt.image.BufferedImage flashVisiblePixels(java.awt.Image image,
                                                              java.awt.Color flashColor)

All pixels that are not transparent are replaced by a pixel of the specified flashColor.

Parameters:

image - the image

flashColor - the flash color

Returns:

the buffered image

flipSpritesHorizontally

public static java.awt.image.BufferedImage flipSpritesHorizontally(Spritesheet sprite)

flipSpritesVertically

public static java.awt.image.BufferedImage flipSpritesVertically(Spritesheet sprite)

getCopy

public static java.awt.image.BufferedImage getCopy(java.awt.image.BufferedImage bi)

getCompatibleImage

public static java.awt.image.BufferedImage getCompatibleImage(int width,
                                                              int height)

getSubImages

public static java.awt.image.BufferedImage[][] getSubImages(java.awt.image.BufferedImage image,
                                                            int rows,
                                                            int columns)

horizontalFlip

public static java.awt.image.BufferedImage horizontalFlip(java.awt.image.BufferedImage img)

Horizontalflip.

Parameters:

img - the img

Returns:

the buffered image

needsBorder

public static boolean needsBorder(java.awt.image.BufferedImage image,
                                  int x,
                                  int y)

Needs border.

Parameters:

image - the image

x - the x

y - the y

Returns:

true, if successful

rotate

public static java.awt.image.BufferedImage rotate(java.awt.image.BufferedImage bufferedImage,
                                                  Rotation rotation)

rotate

public static java.awt.image.BufferedImage rotate(java.awt.image.BufferedImage bufferedImage,
                                                  double radians)

scaleImage

public static java.awt.image.BufferedImage scaleImage(java.awt.image.BufferedImage image,
                                                      int max)

scaleImage

public static java.awt.image.BufferedImage scaleImage(java.awt.image.BufferedImage image,
                                                      float factor)

scaleImage

public static java.awt.image.BufferedImage scaleImage(java.awt.image.BufferedImage image,
                                                      int width,
                                                      int height)

The specified image is scaled to a new dimension with the specified width and height. This method doesn't use anti aliasing for this process to keep the indy look.

Parameters:

image - the image

width - the width

height - the height

Returns:

the buffered image

scaleImage

public static java.awt.image.BufferedImage scaleImage(java.awt.image.BufferedImage image,
                                                      int width,
                                                      int height,
                                                      boolean keepRatio)

scaleImage

public static java.awt.image.BufferedImage scaleImage(java.awt.image.BufferedImage image,
                                                      int width,
                                                      int height,
                                                      boolean keepRatio,
                                                      boolean fill)

scaleImageWidth

public static java.awt.image.BufferedImage scaleImageWidth(java.awt.image.BufferedImage image,
                                                           int newWidth)

setOpacity

public static java.awt.image.BufferedImage setOpacity(java.awt.Image img,
                                                      float opacity)

toBufferedImage

public static java.awt.image.BufferedImage toBufferedImage(java.awt.Image img)

verticalFlip

public static java.awt.image.BufferedImage verticalFlip(java.awt.image.BufferedImage img)

zoom

public static java.awt.image.BufferedImage zoom(java.awt.image.BufferedImage image,
                                                float zoomLevel)

convertToGrayScale

public static java.awt.image.BufferedImage convertToGrayScale(java.awt.image.BufferedImage image)