Package de.jcm.discordgamesdk

Class ImageManager

java.lang.Object

de.jcm.discordgamesdk.ImageManager

public class ImageManager
extends Object

Manager to receive information about images and the image data itself.

See Also:

• https://discordapp.com/developers/docs/game-sdk/images

Method Summary

Modifier and Type	Method	Description
void	fetch(ImageHandle handle, boolean refresh, BiConsumer<Result,ImageHandle> callback)	Prepares an image to later retrieve it.
BufferedImage	getAsBufferedImage(ImageHandle handle)	Obtains the image dimensions from getDimensions(ImageHandle) and then constructs a BufferedImage using getAsBufferedImage(ImageHandle, ImageDimensions).
BufferedImage	getAsBufferedImage(ImageHandle handle, ImageDimensions dimensions)	Deprecated.
byte[]	getData(ImageHandle handle, int length)	Gets the image data for a given image.
byte[]	getData(ImageHandle handle, ImageDimensions dimensions)	Gets the image data for a given image.
ImageDimensions	getDimensions(ImageHandle handle)	Fetches the dimensions (size) of an image.

Methods inherited from class java.lang.Object

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

Method Details

fetch

public void fetch(ImageHandle handle,
 boolean refresh,
 BiConsumer<Result,ImageHandle> callback)

Prepares an image to later retrieve it.

Parameters:

handle - Handle identifying the image

refresh - whether to refresh the (possibly) cached image

callback - Callback to handle result and returned handle

See Also:

• https://discordapp.com/developers/docs/game-sdk/images#fetch

getDimensions

public ImageDimensions getDimensions(ImageHandle handle)

Fetches the dimensions (size) of an image.

Parameters:

handle - Handle identifying the image

Returns:

The fetches dimensions

Throws:

GameSDKException - if something went wrong fetching the image dimensions

See Also:

• https://discordapp.com/developers/docs/game-sdk/images#getdimensions

getData

public byte[] getData(ImageHandle handle,
 ImageDimensions dimensions)

Gets the image data for a given image.

The data is automatically put in a Java byte array.

The length of this array and thus the length of the allocated space is automatically calculated based on the dimensions.

Parameters:

handle - Handle identifying the image

dimensions - Dimensions of the image

Returns:

The image data

Throws:

GameSDKException - if something went wrong fetching the image data

See Also:

• https://discordapp.com/developers/docs/game-sdk/images#getdata

getData

public byte[] getData(ImageHandle handle,
 int length)

Gets the image data for a given image.

The data is automatically put in a Java byte array of the given length.

Prefer getData(ImageHandle, ImageDimensions) and retrieve the dimensions with getDimensions(ImageHandle).

Parameters:

handle - Handle identifying the image

length - Length of the image data, should be width*height*4

Returns:

The image data

Throws:

GameSDKException - if something went wrong fetching the image data

See Also:

• https://discordapp.com/developers/docs/game-sdk/images#getdata

getAsBufferedImage

@Deprecated
public BufferedImage getAsBufferedImage(ImageHandle handle,
 ImageDimensions dimensions)

Deprecated.

Gets the image data for a give image with getData(ImageHandle, ImageDimensions) and writes it into a BufferedImage's raster.

Parameters:

handle - Handle identifying the image

dimensions - Dimensions of the image

Returns:

A BufferedImage containing the image data

Throws:

GameSDKException - if something went wrong fetching the image data

getAsBufferedImage

public BufferedImage getAsBufferedImage(ImageHandle handle)

Obtains the image dimensions from getDimensions(ImageHandle) and then constructs a BufferedImage using getAsBufferedImage(ImageHandle, ImageDimensions).

Parameters:

handle - Handle identifying the image

Returns:

A BufferedImage containing the image data

Throws:

GameSDKException - if something went wrong fetching the image dimensions or data