Package VASSAL.tools.image

Class ImageUtils

java.lang.Object

VASSAL.tools.image.ImageUtils

public class ImageUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static BufferedImage	compatOpaqueImage
protected static int	compatOpaqueImageType
protected static BufferedImage	compatTransImage
protected static int	compatTranslImageType
static String	GIF_SUFFIX
static String[]	IMAGE_SUFFIXES
static String	JPEG_SUFFIX
static String	JPG_SUFFIX
static BufferedImage	NULL_IMAGE
static String	PNG_SUFFIX
static String	SVG_SUFFIX

Method Summary

Modifier and Type	Method	Description
static BufferedImage	coerceToIntType(BufferedImage img)
static BufferedImage	createCompatibleImage(int w, int h)
static BufferedImage	createCompatibleImage(int w, int h, boolean transparent)
static BufferedImage	createCompatibleTranslucentImage(int w, int h)
static Image	forceLoad(Image img)
static Rectangle	getBounds(Dimension d)
static Rectangle	getBounds(BufferedImage im)
static int	getCompatibleImageType()
static int	getCompatibleImageType(boolean transparent)
static int	getCompatibleImageType(BufferedImage img)
static int	getCompatibleTranslucentImageType()
static RenderingHints	getDefaultHints()
static BufferedImage	getImage(InputStream in)	Deprecated, for removal: This API element is subject to removal in a future version. Use getImage(String,InputStream) instead.
static BufferedImage	getImage(String name, InputStream in)
static BufferedImage	getImageResource(String name)
static Dimension	getImageSize(InputStream in)	Deprecated, for removal: This API element is subject to removal in a future version. Use getImageSize(String,InputStream) instead.
static Dimension	getImageSize(String name, InputStream in)
static boolean	hasImageSuffix(String name)
static boolean	isCompatibleImage(BufferedImage img)
static boolean	isTransparent(Image img)
static boolean	isTransparent(BufferedImage img)
static void	setHighQualityScaling(boolean b)	Deprecated, for removal: This API element is subject to removal in a future version. All scaling is done with the high-quality scaler now.
static String	stripImageSuffix(String name)
static BufferedImage	toBufferedImage(Image src)	Transform an Image to a BufferedImage.
static BufferedImage	toCompatibleImage(BufferedImage src)
static BufferedImage	toType(BufferedImage src, int type)
static BufferedImage	transform(BufferedImage src, double scale, double angle)
static BufferedImage	transform(BufferedImage src, double scale, double angle, RenderingHints hints)
static BufferedImage	transform(BufferedImage src, double scale, double angle, RenderingHints hints, int quality)	Deprecated, for removal: This API element is subject to removal in a future version.
static Rectangle	transform(Rectangle srect, double scale, double angle)

Methods inherited from class java.lang.Object

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

Field Details

compatOpaqueImage

protected static final BufferedImage compatOpaqueImage

compatTransImage

protected static final BufferedImage compatTransImage

compatOpaqueImageType

protected static final int compatOpaqueImageType

compatTranslImageType

protected static final int compatTranslImageType

NULL_IMAGE

public static final BufferedImage NULL_IMAGE

GIF_SUFFIX

public static final String GIF_SUFFIX

See Also:

Constant Field Values

PNG_SUFFIX

public static final String PNG_SUFFIX

See Also:

Constant Field Values

SVG_SUFFIX

public static final String SVG_SUFFIX

See Also:

Constant Field Values

JPG_SUFFIX

public static final String JPG_SUFFIX

See Also:

Constant Field Values

JPEG_SUFFIX

public static final String JPEG_SUFFIX

See Also:

Constant Field Values

IMAGE_SUFFIXES

public static final String[] IMAGE_SUFFIXES

Method Details

setHighQualityScaling

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static void setHighQualityScaling(boolean b)

Deprecated, for removal: This API element is subject to removal in a future version.

All scaling is done with the high-quality scaler now.

getDefaultHints

public static RenderingHints getDefaultHints()

transform

public static Rectangle transform(Rectangle srect,
 double scale,
 double angle)

transform

public static BufferedImage transform(BufferedImage src,
 double scale,
 double angle)

transform

public static BufferedImage transform(BufferedImage src,
 double scale,
 double angle,
 RenderingHints hints)

transform

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static BufferedImage transform(BufferedImage src,
 double scale,
 double angle,
 RenderingHints hints,
 int quality)

Deprecated, for removal: This API element is subject to removal in a future version.

coerceToIntType

public static BufferedImage coerceToIntType(BufferedImage img)

getBounds

public static Rectangle getBounds(BufferedImage im)

Parameters:

im - Image

Returns:

the boundaries of this image, where (0,0) is the pseudo-center of the image

getBounds

public static Rectangle getBounds(Dimension d)

getImageSize

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static Dimension getImageSize(InputStream in)
                              throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Use getImageSize(String,InputStream) instead.

Throws:

IOException

getImageSize

public static Dimension getImageSize(String name,
 InputStream in)
                              throws ImageIOException

Throws:

ImageIOException

getImage

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static BufferedImage getImage(InputStream in)
                              throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Use getImage(String,InputStream) instead.

Throws:

IOException

getImageResource

public static BufferedImage getImageResource(String name)
                                      throws ImageIOException

Throws:

ImageIOException

getImage

public static BufferedImage getImage(String name,
 InputStream in)
                              throws ImageIOException

Throws:

ImageIOException

toType

public static BufferedImage toType(BufferedImage src,
 int type)

forceLoad

public static Image forceLoad(Image img)

isTransparent

public static boolean isTransparent(Image img)

isTransparent

public static boolean isTransparent(BufferedImage img)

toBufferedImage

public static BufferedImage toBufferedImage(Image src)

Transform an Image to a BufferedImage.

Parameters:

src - the Image to transform

getCompatibleImageType

public static int getCompatibleImageType()

getCompatibleTranslucentImageType

public static int getCompatibleTranslucentImageType()

getCompatibleImageType

public static int getCompatibleImageType(boolean transparent)

getCompatibleImageType

public static int getCompatibleImageType(BufferedImage img)

createCompatibleImage

public static BufferedImage createCompatibleImage(int w,
 int h)

createCompatibleImage

public static BufferedImage createCompatibleImage(int w,
 int h,
 boolean transparent)

createCompatibleTranslucentImage

public static BufferedImage createCompatibleTranslucentImage(int w,
 int h)

toCompatibleImage

public static BufferedImage toCompatibleImage(BufferedImage src)

isCompatibleImage

public static boolean isCompatibleImage(BufferedImage img)

hasImageSuffix

public static boolean hasImageSuffix(String name)

stripImageSuffix

public static String stripImageSuffix(String name)