agi.foundation.graphics.advanced

(agi.foundation.graphics-2024r2.jar)

Class Texture2DFactory

java.lang.Object

agi.foundation.graphics.advanced.Texture2DFactory

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class Texture2DFactory
extends Object
implements IDisposable

A factory for creating Texture2D objects from various sources.

Method Summary

Modifier and Type	Method and Description
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
protected void	dispose(boolean disposing)
protected void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
Texture2D	fromBitmap(BufferedImage bitmap) Creates a new texture from a bitmap.
Texture2D	fromMemory(byte[] value, RasterAttributes attributes) Creates a new texture from memory.
Texture2D	fromRaster(Raster raster) Creates a new texture from a Raster.
Texture2D	fromUri(String uri) Creates a new texture from a URI, which can be a file, HTTP, HTTPS, or FTP source.
Texture2D	fromUri(URI uri) Creates a new texture from a URI, which can be a file, HTTP, HTTPS, or FTP source.
boolean	getGenerateMipmapCompatibleTextures() Gets whether the Texture2DFactory will create mipmap compatible textures.
void	setGenerateMipmapCompatibleTextures(boolean value) Sets whether the Texture2DFactory will create mipmap compatible textures.

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close

Method Detail

finalize

protected void finalize()
                 throws Throwable

Description copied from class: java.lang.Object

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Overrides:

finalize in class Object

Throws:

Throwable - the Exception raised by this method

See Also:

WeakReference, PhantomReference

dispose

public final void dispose()

Description copied from interface: IDisposable

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Specified by:

dispose in interface IDisposable

dispose

protected void dispose(boolean disposing)

getGenerateMipmapCompatibleTextures

public final boolean getGenerateMipmapCompatibleTextures()

Gets whether the Texture2DFactory will create mipmap compatible textures. Mipmap compatible textures are required when using TextureFilter2D with a MipMapped MinificationFilter.

See Also:

TextureFilter2D

setGenerateMipmapCompatibleTextures

public final void setGenerateMipmapCompatibleTextures(boolean value)

Sets whether the Texture2DFactory will create mipmap compatible textures. Mipmap compatible textures are required when using TextureFilter2D with a MipMapped MinificationFilter.

See Also:

TextureFilter2D

fromUri

public final Texture2D fromUri(URI uri)

Creates a new texture from a URI, which can be a file, HTTP, HTTPS, or FTP source. See Raster for a list of supported raster formats.

Parameters:

uri - The URI of the raster to create the texture from.

Returns:

The Texture2D that was created.

fromUri

public final Texture2D fromUri(String uri)

Creates a new texture from a URI, which can be a file, HTTP, HTTPS, or FTP source. See Raster for a list of supported raster formats.

Parameters:

uri - The URI of the raster to create the texture from.

Returns:

The Texture2D that was created.

fromRaster

public final Texture2D fromRaster(Raster raster)

Creates a new texture from a Raster.

Parameters:

raster - The Raster to create the texture from.

Returns:

The Texture2D that was created.

fromBitmap

public final Texture2D fromBitmap(BufferedImage bitmap)

Creates a new texture from a bitmap. Accepts a BufferedImage. For best performance, use an image of type bufferedimage.TYPE_3BYTE_BGR, bufferedimage.TYPE_INT_RGB, or bufferedimage.TYPE_INT_ARGB. Images of other types will be converted automatically.

Parameters:

bitmap - The BufferedImage to create the texture from.

Returns:

The Texture2D that was created.

fromMemory

public final Texture2D fromMemory(byte[] value,
                                  RasterAttributes attributes)

Creates a new texture from memory.

Parameters:

value - The byte array that contains the texture data.

attributes - The RasterAttributes that define the texture.

Returns:

The Texture2D that was created.