org.jsfml.graphics

Class Image

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.graphics.Image

public class Image
extends SFMLNativeObject

Provides methods for loading, manipulating and saving images.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Image.PixelOutOfBoundsException Thrown if a non-existing pixel is being accessed by either getPixel(int, int) or setPixel(int, int, Color).

Constructor Summary

Constructors

Constructor and Description
Image() Constructs a new empty image.

Method Summary

Methods

Modifier and Type	Method and Description
void	copy(Image source, int destX, int destY) Copies another image onto this image.
void	copy(Image source, int destX, int destY, IntRect sourceRect) Copies a portion of another image onto this image.
void	copy(Image source, int destX, int destY, IntRect sourceRect, boolean applyAlpha) Copies a portion of another image onto this image.
void	create(BufferedImage image) Creates a new image by converting an AWT BufferedImage.
void	create(int width, int height) Generates a new image and fills it with black.
void	create(int width, int height, Color color) Generates a new image and fills it with a color.
void	create(int width, int height, int[] pixels) Creates a new image from the given pixel data.
void	createMaskFromColor(Color color) Creates a transparency mask from the given color, making matching pixels fully transparent.
void	createMaskFromColor(Color color, int alpha) Creates a transparency mask from the given color.
void	flipHorizontally() Flips the image horizontally.
void	flipVertically() Flips the image vertically.
Color	getPixel(int x, int y) Gets the color of a certain pixel.
int[]	getPixels() Retrieves a copy of all the pixels of the image in 32-bit ARGB color format.
Vector2i	getSize() Gets the size of the image.
void	loadFromFile(Path path) Attempts to load an image from a file.
void	loadFromStream(InputStream in) Fully loads all available bytes from an InputStream and attempts to load the image from it.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
void	saveToFile(Path path) Attempts to save the image to a file.
void	setPixel(int x, int y, Color color) Sets the color of a certain pixel.
BufferedImage	toBufferedImage() Converts this image to an AWT BufferedImage.

Methods inherited from class org.jsfml.internal.SFMLNativeObject

finalize

Methods inherited from class java.lang.Object

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

Constructor Detail

Image

public Image()

Constructs a new empty image.

Method Detail

nativeCreate

@Deprecated
protected long nativeCreate()

Deprecated.

Description copied from class: SFMLNativeObject

Creates a new native SFML object of the represented SFML class in the JVM memory heap.

Specified by:

nativeCreate in class SFMLNativeObject

Returns:

the pointer to the newly created native SFML object.

nativeSetExPtr

@Deprecated
protected void nativeSetExPtr()

Deprecated.

Description copied from class: SFMLNativeObject

This method is expected to fill the extra pointers array, if any.

It is called after the object has been created or wrapped around an already existing pointer.

Specified by:

nativeSetExPtr in class SFMLNativeObject

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Specified by:

nativeDelete in class SFMLNativeObject

create

public void create(int width,
          int height,
          Color color)

Generates a new image and fills it with a color.

Parameters:

width - the image's width.

height - the image's height.

color - the fill color of the image.

create

public final void create(int width,
          int height)

Generates a new image and fills it with black.

Parameters:

width - the image's width.

height - the image's height.

create

public void create(BufferedImage image)

Creates a new image by converting an AWT BufferedImage.

Parameters:

image - the AWT buffered image to convert.

create

public void create(int width,
          int height,
          int[] pixels)

Creates a new image from the given pixel data.

The pixel data is expected to be in the BufferedImage.TYPE_INT_ARGB color format.

Parameters:

width - the image's width.

height - the image's height.

pixels - the image's pixel data in 32-bit ARGB format.

loadFromStream

public void loadFromStream(InputStream in)
                    throws IOException

Fully loads all available bytes from an InputStream and attempts to load the image from it.

Parameters:

in - the input stream to read from.

Throws:

IOException - in case an I/O error occurs.

loadFromFile

public void loadFromFile(Path path)
                  throws IOException

Attempts to load an image from a file.

Parameters:

path - the file to load the texture from.

Throws:

IOException - in case an I/O error occurs.

saveToFile

public void saveToFile(Path path)
                throws IOException

Attempts to save the image to a file.

Parameters:

path - the path to the file to write.

Throws:

IOException - in case an I/O error occurs.

getSize

public Vector2i getSize()

Gets the size of the image.

Returns:

the size of the image.

createMaskFromColor

public void createMaskFromColor(Color color,
                       int alpha)

Creates a transparency mask from the given color.

Parameters:

color - the color to be made transparent.

alpha - the alpha value to assign to pixels matching the color key.

createMaskFromColor

public final void createMaskFromColor(Color color)

Creates a transparency mask from the given color, making matching pixels fully transparent.

Parameters:

color - the color to be made transparent.

copy

public void copy(Image source,
        int destX,
        int destY,
        IntRect sourceRect,
        boolean applyAlpha)

Copies a portion of another image onto this image.

Parameters:

source - the source image.

destX - the destination X coordinate.

destY - the destination X coordinate.

sourceRect - the source rectangle. An empty rectangle means the full image.

applyAlpha - true to copy alpha values as well, false to leave the destination alpha.

copy

public final void copy(Image source,
        int destX,
        int destY,
        IntRect sourceRect)

Copies a portion of another image onto this image.

Parameters:

source - the source image.

destX - the destination X coordinate.

destY - the destination X coordinate.

sourceRect - the source rectangle. An empty rectangle means the full image.

copy

public final void copy(Image source,
        int destX,
        int destY)

Copies another image onto this image.

Parameters:

source - the source image.

destX - the destination X coordinate.

destY - the destination X coordinate.

setPixel

public void setPixel(int x,
            int y,
            Color color)

Sets the color of a certain pixel.

Parameters:

x - the pixel's X coordinate.

y - the pixel's Y coordinate.

color - the color to apply to the pixel.

getPixel

public Color getPixel(int x,
             int y)

Gets the color of a certain pixel.

Parameters:

x - the pixel's X coordinate.

y - the pixel's Y coordinate.

Returns:

the pixel's color.

getPixels

public int[] getPixels()

Retrieves a copy of all the pixels of the image in 32-bit ARGB color format.

The retrieved image data is compatible to the BufferedImage.TYPE_INT_ARGB color format.

Returns:

a copy of all the pixels of the image in 32-bit ARGB color format.

toBufferedImage

public BufferedImage toBufferedImage()

Converts this image to an AWT BufferedImage.

The resulting buffered image will be of BufferedImage.TYPE_INT_ARGB color format.

Returns:

the resulting buffered image.

flipHorizontally

public void flipHorizontally()

Flips the image horizontally.

flipVertically

public void flipVertically()

Flips the image vertically.