playn.core

Class Assets

java.lang.Object

playn.core.Assets

public abstract class Assets
extends java.lang.Object

Fetches and returns assets.

Method Summary

Modifier and Type	Method and Description
RFuture<java.nio.ByteBuffer>	getBytes(java.lang.String path) Loads binary data asynchronously.
abstract java.nio.ByteBuffer	getBytesSync(java.lang.String path) Loads and returns the raw bytes of the asset - useful for custom binary formatted files.
Image	getImage(java.lang.String path) Asynchronously loads and returns an image.
Image	getImageSync(java.lang.String path) Synchronously loads and returns an image.
Sound	getMusic(java.lang.String path) Asynchronously loads and returns a music resource.
Image	getRemoteImage(java.lang.String url) Asynchronously loads and returns the image at the specified URL.
Image	getRemoteImage(java.lang.String url, int width, int height) Asynchronously loads and returns the image at the specified URL.
abstract Sound	getSound(java.lang.String path) Asynchronously loads and returns a short sound effect.
RFuture<java.lang.String>	getText(java.lang.String path) Loads UTF-8 encoded text asynchronously.
abstract java.lang.String	getTextSync(java.lang.String path) Loads and returns a UTF-8 encoded text asset.

Methods inherited from class java.lang.Object

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

Method Detail

getImageSync

public Image getImageSync(java.lang.String path)

Synchronously loads and returns an image. The calling thread will block while the image is loaded from disk and decoded. When this call returns, the image's width and height will be valid, and the image can be immediately converted to a texture and drawn into a canvas.

Parameters:

path - the path to the image asset.

Throws:

java.lang.UnsupportedOperationException - on platforms that cannot support synchronous asset loading (HTML).

getImage

public Image getImage(java.lang.String path)

Asynchronously loads and returns an image. The calling thread will not block. The returned image will not be immediately usable, will not report valid width and height, and cannot be immediately rendered into a canvas or converted into a texture. Use Image.state to be notified when loading succeeds or fails.

Parameters:

path - the path to the image asset.

getRemoteImage

public Image getRemoteImage(java.lang.String url)

Asynchronously loads and returns the image at the specified URL. The width and height of the image will be unset (0) until the image is loaded. Note: on non-HTML platforms, this spawns a new thread for each loaded image. Thus, attempts to load large numbers of remote images simultaneously may result in poor performance.

getRemoteImage

public Image getRemoteImage(java.lang.String url,
                            int width,
                            int height)

Asynchronously loads and returns the image at the specified URL. The width and height of the image will be the supplied width and height until the image is loaded. Note: on non-HTML platforms, this spawns a new thread for each loaded image. Thus, attempts to load large numbers of remote images simultaneously may result in poor performance.

getSound

public abstract Sound getSound(java.lang.String path)

Asynchronously loads and returns a short sound effect.

Note: if a request to play the sound is made before the sound is loaded, it will be noted and the sound will be played when loading has completed.

Parameters:

path - the path to the sound resource. NOTE: this should not include a file extension, PlayN will automatically add .mp3, (or .caf on iOS).

getMusic

public Sound getMusic(java.lang.String path)

Asynchronously loads and returns a music resource. On some platforms, the backend will use a different implementation from getSound(java.lang.String) which is better suited to the much larger size of music audio data.

Note: if a request to play the sound is made before the sound is loaded, it will be noted and the sound will be played when loading has completed.

Parameters:

path - the path to the sound resource. NOTE: this should not include a file extension, PlayN will automatically add .mp3, (or .caf on iOS).

getTextSync

public abstract java.lang.String getTextSync(java.lang.String path)
                                      throws java.lang.Exception

Loads and returns a UTF-8 encoded text asset.

Parameters:

path - the path to the text asset.

Throws:

java.lang.Exception - if there is an error loading the text (for example, if it does not exist).

java.lang.UnsupportedOperationException - on platforms that cannot support synchronous asset loading (e.g. HTML5 and Flash).

getText

public RFuture<java.lang.String> getText(java.lang.String path)

Loads UTF-8 encoded text asynchronously. The returned state instance provides a means to listen for the arrival of the text.

Parameters:

path - the path to the text asset.

getBytesSync

public abstract java.nio.ByteBuffer getBytesSync(java.lang.String path)
                                          throws java.lang.Exception

Loads and returns the raw bytes of the asset - useful for custom binary formatted files.

Parameters:

path - the path to the text asset.

Throws:

java.lang.Exception - if there is an error loading the data (for example, if it does not exist).

java.lang.UnsupportedOperationException - on platforms that cannot support synchronous asset loading (e.g. HTML5 and Flash).

getBytes

public RFuture<java.nio.ByteBuffer> getBytes(java.lang.String path)

Loads binary data asynchronously. The returned state instance provides a means to listen for the arrival of the data.

Parameters:

path - the path to the binary asset.