Raster

java.lang.Object
- agi.foundation.graphics.imaging.Raster

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

RasterStream
```
public class Raster
extends Object
implements IDisposable
```
A raster dataset. A raster consists of one or more bands, or sets of values, which are most commonly associated with colors when the raster represents an image. For instance, a typical color image contains three sets of values, or bands (red, green, and blue) which define the color of pixels within the image. The following raster image formats can be read by the raster class: BMP, ECW, IMG, JP2, NTF, NITF, PNG, SID, TIF, TIFF, JPG, JPEG, PPM, PGM, CLDS, and TGA. The raster can also be loaded from memory, or constructed from a BufferedImage. To create a texture from a raster, pass it to the Texture2DFactory.fromRaster(agi.foundation.graphics.imaging.Raster) method.

See Also:

RasterStream, Rasters and Filtering topic

Constructor Summary

Constructors
Constructor and Description
`Raster(BufferedImage bitmap)` Initializes a raster from a `BufferedImage`.
`Raster(byte[] value, RasterAttributes attributes)` Initializes a raster from memory.
`Raster(Raster raster)` Initializes a raster from another raster.
`Raster(String uri)` Initializes a raster from a Uri, which can be a file, HTTP, HTTPS, or FTP source.
`Raster(String uri, int x, int y, int width, int height)` Initializes a raster from a Uri.
`Raster(URI uri)` Initializes a raster from a Uri, which can be a file, HTTP, HTTPS, or FTP source.
`Raster(URI uri, int x, int y, int width, int height)` Initializes a raster from a Uri.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Raster`	`apply(RasterFilter filter)` Applies a `RasterFilter` to the raster and returns a new raster with the results of the filtering.
`void`	`applyInPlace(RasterFilter filter)` Applies a `RasterFilter` to the raster.
`void`	`copyFromBitmap(BufferedImage bitmap)` Copies a `BufferedImage` into this raster.
`void`	`copyFromMemory(byte[] value, RasterAttributes attributes)` Copies the given memory into the raster.
`void`	`copyFromRaster(Raster raster)` Copies the data associated with the given `Raster` into this raster.
`void`	`dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
`protected void`	`dispose(boolean disposing)`
`Raster`	`extractBand(RasterBand band)` Extracts the band of raster data associated with the given `RasterBand`.
`Raster`	`extractBand(RasterFormat format)` Extracts the bands of raster data associated with the given `RasterFormat`.
`protected void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`void`	`flip(FlipAxis axis)` Flips the raster along the given axis.
`RasterAttributes`	`getAttributes()` Gets the `RasterAttributes` that define the raster data.
`int`	`getHeight()` Gets the height of the raster in pixels.
`int`	`getWidth()` Gets the width of the raster in pixels.
`void`	`rotate(double angle)` Rotates the raster by the given angle.
`void`	`setAttributes(RasterAttributes value)` Gets the `RasterAttributes` that define the raster data.
`BufferedImage`	`toBitmap()` Copies the raster to a `BufferedImage` if the `RasterFormat` is supported.

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

- Constructor Detail
  - Raster
```
public Raster(URI uri)
```
    Initializes a raster from a Uri, which can be a file, HTTP, HTTPS, or FTP source. See Raster for a list of supported formats.
    
    Parameters:
    
    uri - The URI of the raster.
  - Raster
```
public Raster(String uri)
```
    Initializes a raster from a Uri, which can be a file, HTTP, HTTPS, or FTP source. See Raster for a list of supported formats.
    
    Parameters:
    
    uri - The Uri of the raster.
  - Raster
```
public Raster(URI uri,
              int x,
              int y,
              int width,
              int height)
```
    Initializes a raster from a Uri. Only the specified subsection of the raster is read. See Raster for a list of supported formats.
    
    Parameters:
    
    uri - The URI of the raster.
    
    x - The X position of the subsection in pixels.
    
    y - The Y position of the subsection in pixels.
    
    width - The width of the subsection in pixels.
    
    height - The height of the subsection in pixels.
  - Raster
```
public Raster(String uri,
              int x,
              int y,
              int width,
              int height)
```
    Initializes a raster from a Uri. Only the specified subsection of the raster is read. See Raster for a list of supported formats.
    
    Parameters:
    
    uri - The Uri of the raster.
    
    x - The X position of the subsection in pixels.
    
    y - The Y position of the subsection in pixels.
    
    width - The width of the subsection in pixels.
    
    height - The height of the subsection in pixels.
  - Raster
```
public Raster(byte[] value,
              RasterAttributes attributes)
```
    Initializes a raster from memory.
    
    Parameters:
    
    value - The byte array that contains the raster data.
    
    attributes - The RasterAttributes that define the raster.
  - Raster
```
public Raster(Raster raster)
```
    Initializes a raster from another raster.
    
    Parameters:
    
    raster - The Raster to create the raster from.
  - Raster
```
public Raster(BufferedImage bitmap)
```
    Initializes a raster from 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 raster from.
- 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)
```
  - getAttributes
```
public final RasterAttributes getAttributes()
```
    Gets the RasterAttributes that define the raster data.
  - setAttributes
```
public final void setAttributes(RasterAttributes value)
```
    Gets the RasterAttributes that define the raster data.
  - getWidth
```
public final int getWidth()
```
    Gets the width of the raster in pixels.
  - getHeight
```
public final int getHeight()
```
    Gets the height of the raster in pixels.
  - flip
```
public final void flip(FlipAxis axis)
```
    Flips the raster along the given axis.
    
    Parameters:
    
    axis - The axis along which the raster will be flipped.
  - rotate
```
public final void rotate(double angle)
```
    Rotates the raster by the given angle.
    
    Parameters:
    
    angle - The angle in degrees by which the raster is rotated.
  - apply
```
public final Raster apply(RasterFilter filter)
```
    Applies a RasterFilter to the raster and returns a new raster with the results of the filtering. The current raster is not modified.
    
    Parameters:
    
    filter - The RasterFilter to apply.
    
    Returns:
    
    A Raster with the results of the filtering.
  - applyInPlace
```
public final void applyInPlace(RasterFilter filter)
```
    Applies a RasterFilter to the raster. The current raster will contain the results of the filtering.
    
    Parameters:
    
    filter - The RasterFilter to apply.
  - toBitmap
```
public final BufferedImage toBitmap()
```
    Copies the raster to a BufferedImage if the RasterFormat is supported. RGB, RGBA, BGR, and BGRA raster data is supported.
    
    Returns:
    
    The BufferedImage that contains the raster data.
  - extractBand
```
public final Raster extractBand(RasterBand band)
```
    Extracts the band of raster data associated with the given RasterBand.
    
    Parameters:
    
    band - The RasterBand to be extracted.
    
    Returns:
    
    A raster containing the band of data specified.
  - extractBand
```
public final Raster extractBand(RasterFormat format)
```
    Extracts the bands of raster data associated with the given RasterFormat.
    
    Parameters:
    
    format - The RasterFormat associated with the bands to be extracted.
    
    Returns:
    
    A raster containing the bands of data specified.
  - copyFromRaster
```
public final void copyFromRaster(Raster raster)
```
    Copies the data associated with the given Raster into this raster.
    
    Parameters:
    
    raster - The Raster to copy from.
  - copyFromMemory
```
public final void copyFromMemory(byte[] value,
                                 RasterAttributes attributes)
```
    Copies the given memory into the raster.
    
    Parameters:
    
    value - The byte array that contains the raster data to copy.
    
    attributes - The RasterAttributes that define the raster data being copied.
  - copyFromBitmap
```
public final void copyFromBitmap(BufferedImage bitmap)
```
    Copies a BufferedImage into this raster. 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 copy the data from.

Class Raster

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface agi.foundation.compatibility.IDisposable

Constructor Detail

Raster

Raster

Raster

Raster

Raster

Raster

Method Detail

finalize

dispose

dispose

getAttributes

setAttributes

getWidth

getHeight

flip

rotate

apply

applyInPlace

toBitmap

extractBand

extractBand

copyFromRaster

copyFromMemory

copyFromBitmap