public final Class ImageData

Constructs a new, empty ImageData with the given width, height, depth and palette. The data will be initialized to an (all zero) array of the appropriate size.

Parameters

width:int

the width of the image

height:int

the height of the image

depth:int

the depth of the image

palette:PaletteData

the palette of the image (must not be null)

Exceptions

IllegalArgumentException:

• ERROR_INVALID_ARGUMENT - if the width or height is zero or negative, or if the depth is not one of 1, 2, 4, 8, 16, 24 or 32
• ERROR_NULL_ARGUMENT - if the palette is null

Constructs a new, empty ImageData with the given width, height, depth, palette, scanlinePad and data.

Parameters

width:int

the width of the image

height:int

the height of the image

depth:int

the depth of the image

palette:PaletteData

the palette of the image

scanlinePad:int

the padding of each line, in bytes

data:byte[]

the data of the image

Exceptions

IllegalArgumentException:

• ERROR_INVALID_ARGUMENT - if the width or height is zero or negative, or if the depth is not one of 1, 2, 4, 8, 16, 24 or 32, or the data array is too small to contain the image data
• ERROR_NULL_ARGUMENT - if the palette or data is null
• ERROR_CANNOT_BE_ZERO - if the scanlinePad is zero

Constructs an ImageData loaded from the specified input stream. Throws an error if an error occurs while loading the image, or if the image has an unsupported type. Application code is still responsible for closing the input stream.

This constructor is provided for convenience when loading a single image only. If the stream contains multiple images, only the first one will be loaded. To load multiple images, use ImageLoader.load().

This constructor may be used to load a resource as follows:

    static ImageData loadImageData (Class clazz, String string) {
         InputStream stream = clazz.getResourceAsStream (string);
         if (stream == null) return null;
         ImageData imageData = null;
         try {
              imageData = new ImageData (stream);
         } catch (SWTException ex) {
         } finally {
              try {
                   stream.close ();
              } catch (IOException ex) {}
         }
         return imageData;
    }

Parameters

stream:InputStream

the input stream to load the image from (must not be null)

Exceptions

IllegalArgumentException:

• ERROR_NULL_ARGUMENT - if the stream is null

SWTException:

• ERROR_IO - if an IO error occurs while reading from the stream
• ERROR_INVALID_IMAGE - if the image stream contains invalid data
• ERROR_UNSUPPORTED_FORMAT - if the image stream contains an unrecognized format

See Also

ImageLoader#load(InputStream)

Constructs an ImageData loaded from a file with the specified name. Throws an error if an error occurs loading the image, or if the image has an unsupported type.

This constructor is provided for convenience when loading a single image only. If the file contains multiple images, only the first one will be loaded. To load multiple images, use ImageLoader.load().

Parameters

filename:String

the name of the file to load the image from (must not be null)

Exceptions

IllegalArgumentException:

• ERROR_NULL_ARGUMENT - if the file name is null

SWTException:

• ERROR_IO - if an IO error occurs while reading from the file
• ERROR_INVALID_IMAGE - if the image file contains invalid data
• ERROR_UNSUPPORTED_FORMAT - if the image file contains an unrecognized format

Overrides java.lang.Object.clone.

Returns a new instance of the same class as the receiver, whose slots have been filled in with copies of the values in the slots of the receiver. That is, the returned object is a deep copy of the receiver.

Returns:Object

a copy of the receiver.

Annotations

@Override

Returns the alpha value at offset x in scanline y in the receiver's alpha data. The alpha value is between 0 (transparent) and 255 (opaque).

Parameters

x:int

the x coordinate of the pixel to get the alpha value of

y:int

the y coordinate of the pixel to get the alpha value of

Returns:int

the alpha value at the given coordinates

Exceptions

IllegalArgumentException:

• ERROR_INVALID_ARGUMENT - if either argument is out of range

Returns getWidth alpha values starting at offset x in scanline y in the receiver's alpha data starting at startIndex. The alpha values are unsigned, between (byte)0 (transparent) and (byte)255 (opaque).

Parameters

x:int

the x position of the pixel to begin getting alpha values

y:int

the y position of the pixel to begin getting alpha values

getWidth:int

the width of the data to get

alphas:byte[]

the buffer in which to put the alpha values

startIndex:int

the offset into the image to begin getting alpha values

Exceptions

IndexOutOfBoundsException:

if getWidth is too large

IllegalArgumentException:

• ERROR_NULL_ARGUMENT - if pixels is null
• ERROR_INVALID_ARGUMENT - if x or y is out of bounds
• ERROR_INVALID_ARGUMENT - if getWidth is negative

Returns the pixel value at offset x in scanline y in the receiver's data.

Parameters

x:int

the x position of the pixel to get

y:int

the y position of the pixel to get

Returns:int

the pixel at the given coordinates

Exceptions

IllegalArgumentException:

• ERROR_INVALID_ARGUMENT - if either argument is out of bounds

SWTException:

• ERROR_UNSUPPORTED_DEPTH if the depth is not one of 1, 2, 4, 8, 16, 24 or 32

Returns getWidth pixel values starting at offset x in scanline y in the receiver's data starting at startIndex.

Parameters

x:int

the x position of the first pixel to get

y:int

the y position of the first pixel to get

getWidth:int

the width of the data to get

pixels:byte[]

the buffer in which to put the pixels

startIndex:int

the offset into the byte array to begin storing pixels

Exceptions

IndexOutOfBoundsException:

if getWidth is too large

IllegalArgumentException:

• ERROR_NULL_ARGUMENT - if pixels is null
• ERROR_INVALID_ARGUMENT - if x or y is out of bounds
• ERROR_INVALID_ARGUMENT - if getWidth is negative

SWTException:

• ERROR_UNSUPPORTED_DEPTH - if the depth is not one of 1, 2, 4 or 8 (For higher depths, use the int[] version of this method.)

Returns getWidth pixel values starting at offset x in scanline y in the receiver's data starting at startIndex.

Parameters

x:int

the x position of the first pixel to get

y:int

the y position of the first pixel to get

getWidth:int

the width of the data to get

pixels:int[]

the buffer in which to put the pixels

startIndex:int

the offset into the buffer to begin storing pixels

Exceptions

IndexOutOfBoundsException:

if getWidth is too large

IllegalArgumentException:

• ERROR_NULL_ARGUMENT - if pixels is null
• ERROR_INVALID_ARGUMENT - if x or y is out of bounds
• ERROR_INVALID_ARGUMENT - if getWidth is negative

SWTException:

• ERROR_UNSUPPORTED_DEPTH - if the depth is not one of 1, 2, 4, 8, 16, 24 or 32

Returns an array of RGBs which comprise the indexed color table of the receiver, or null if the receiver has a direct color model.

Returns:RGB[]

the RGB values for the image or null if direct color

See Also

PaletteData#getRGBs()

Returns an ImageData which specifies the transparency mask information for the receiver. If the receiver has no transparency or is not an icon, returns an opaque mask.

Returns:ImageData

the transparency mask

Returns the image transparency type, which will be one of SWT.TRANSPARENCY_NONE, SWT.TRANSPARENCY_MASK, SWT.TRANSPARENCY_PIXEL or SWT.TRANSPARENCY_ALPHA.

Returns:int

the receiver's transparency type

Invokes internal SWT functionality to create a new instance of this class.

This method is for internal use, and is not described further.

Returns a copy of the receiver which has been stretched or shrunk to the specified size. If either the width or height is negative, the resulting image will be inverted in the associated axis.

Parameters

width:int

the width of the new ImageData

height:int

the height of the new ImageData

Returns:ImageData

a scaled copy of the image

Sets the alpha value at offset x in scanline y in the receiver's alpha data. The alpha value must be between 0 (transparent) and 255 (opaque).

Parameters

x:int

the x coordinate of the alpha value to set

y:int

the y coordinate of the alpha value to set

alpha:int

the value to set the alpha to

Exceptions

IllegalArgumentException:

• ERROR_INVALID_ARGUMENT - if x or y is out of bounds

Sets the alpha values starting at offset x in scanline y in the receiver's alpha data to the values from the array alphas starting at startIndex. The alpha values must be between (byte)0 (transparent) and (byte)255 (opaque)

Parameters

x:int

the x coordinate of the pixel to being setting the alpha values

y:int

the y coordinate of the pixel to being setting the alpha values

putWidth:int

the width of the alpha values to set

alphas:byte[]

the alpha values to set

startIndex:int

the index at which to begin setting

Exceptions

IndexOutOfBoundsException:

if putWidth is too large

IllegalArgumentException:

• ERROR_NULL_ARGUMENT - if pixels is null
• ERROR_INVALID_ARGUMENT - if x or y is out of bounds
• ERROR_INVALID_ARGUMENT - if putWidth is negative

Sets the pixel value at offset x in scanline y in the receiver's data.

Parameters

x:int

the x coordinate of the pixel to set

y:int

the y coordinate of the pixel to set

pixelValue:int

the value to set the pixel to

Exceptions

IllegalArgumentException:

• ERROR_INVALID_ARGUMENT - if x or y is out of bounds

SWTException:

• ERROR_UNSUPPORTED_DEPTH if the depth is not one of 1, 2, 4, 8, 16, 24 or 32

Sets the pixel values starting at offset x in scanline y in the receiver's data to the values from the array pixels starting at startIndex.

Parameters

x:int

the x position of the pixel to set

y:int

the y position of the pixel to set

putWidth:int

the width of the pixels to set

pixels:byte[]

the pixels to set

startIndex:int

the index at which to begin setting

Exceptions

IndexOutOfBoundsException:

if putWidth is too large

IllegalArgumentException:

• ERROR_NULL_ARGUMENT - if pixels is null
• ERROR_INVALID_ARGUMENT - if x or y is out of bounds
• ERROR_INVALID_ARGUMENT - if putWidth is negative

SWTException:

• ERROR_UNSUPPORTED_DEPTH if the depth is not one of 1, 2, 4, 8 (For higher depths, use the int[] version of this method.)

Sets the pixel values starting at offset x in scanline y in the receiver's data to the values from the array pixels starting at startIndex.

Parameters

x:int

the x position of the pixel to set

y:int

the y position of the pixel to set

putWidth:int

the width of the pixels to set

pixels:int[]

the pixels to set

startIndex:int

the index at which to begin setting

Exceptions

IndexOutOfBoundsException:

if putWidth is too large

IllegalArgumentException:

• ERROR_NULL_ARGUMENT - if pixels is null
• ERROR_INVALID_ARGUMENT - if x or y is out of bounds
• ERROR_INVALID_ARGUMENT - if putWidth is negative

SWTException:

• ERROR_UNSUPPORTED_DEPTH if the depth is not one of 1, 2, 4, 8, 16, 24 or 32