io.github.bananapuncher714.cartographer.core.api

Class SimpleImage

java.lang.Object

io.github.bananapuncher714.cartographer.core.api.SimpleImage

public class SimpleImage
extends java.lang.Object

Load GIFs and images.

Author:

BananaPuncher714

Constructor Summary

Constructors

Constructor and Description
SimpleImage(java.io.File file)
SimpleImage(java.io.File file, int width, int height, int hints) Construct a SimpleImage with the arguments provided.
SimpleImage(java.awt.Image image, int width, int height, int hints) Construct a SimpleImage with the arguments provided.
SimpleImage(SimpleImage image, int width, int height, int hints) Construct a resized SimpleImage with the arguments provided.

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	getBufferedImage() Get the current image.
java.awt.image.BufferedImage	getBufferedImage(int index) Get the image at the given index.
int	getDelay(int index) Get the delay at the given index.
int	getFrames() Get the amount of frames.
int	getHeight() Get the height.
int[]	getImage() Get the ARGB buffer for the current image.
int[]	getImage(int index) Get the ARGB buffer at the given index.
protected int	getIndex()
int	getWidth() Get the width.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleImage

public SimpleImage(java.io.File file)
            throws java.io.IOException

Throws:

java.io.IOException

SimpleImage

public SimpleImage(java.io.File file,
                   int width,
                   int height,
                   int hints)
            throws java.io.IOException

Construct a SimpleImage with the arguments provided.

Parameters:

file - Must not be null, exist, and be a file.

width - The width that this image should be resized to.

height - The height that this image should be resized to.

hints - Resizing hints. For example, Image.SCALE_REPLICATE.

Throws:

java.io.IOException - Look for ImageIO.read( File ).

SimpleImage

public SimpleImage(java.awt.Image image,
                   int width,
                   int height,
                   int hints)

Construct a SimpleImage with the arguments provided.

Parameters:

image - Cannot be null.

width - The width that this image should be resized to.

height - The height that this image should be resized to.

hints - Resizing hints. For example, Image.SCALE_REPLICATE.

SimpleImage

public SimpleImage(SimpleImage image,
                   int width,
                   int height,
                   int hints)

Construct a resized SimpleImage with the arguments provided.

Parameters:

image - Another SimpleImage, cannot be null.

width - The new width.

height - The new height.

hints - Resizing hints. For example, Image.SCALE_REPLICATE.

Method Detail

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage()

Get the current image.

Returns:

If the image is a GIF, then whichever frame should be displayed currently according to the time of creation.

getBufferedImage

public java.awt.image.BufferedImage getBufferedImage(int index)

Get the image at the given index.

Parameters:

index - The index of the images.

Returns:

The image located at the given index.

getImage

public int[] getImage()

Get the ARGB buffer for the current image.

Returns:

If the image is a GIF, then whichever frame should be displayed currently according to the time of creation.

getImage

public int[] getImage(int index)

Get the ARGB buffer at the given index.

Parameters:

index - The index of the buffer.

Returns:

The ARGB buffer located at the given index.

getIndex

protected int getIndex()

getDelay

public int getDelay(int index)

Get the delay at the given index.

Parameters:

index - The index of the delay.

Returns:

The delay in milliseconds until the next frame.

getFrames

public int getFrames()

Get the amount of frames.

Returns:

Will return 1 if it is a single image.

getWidth

public int getWidth()

Get the width.

Returns:

The width of all the images.

getHeight

public int getHeight()

Get the height.

Returns:

The height of all the images.