com.sun.javafx.iio

Class ImageFrame

java.lang.Object

com.sun.javafx.iio.ImageFrame

public class ImageFrame
extends java.lang.Object

A class representing the data and metadata of a single image.

Field Summary

Fields

Modifier and Type	Field and Description
private int	height
private java.nio.ByteBuffer	imageData
private ImageStorage.ImageType	imageType
private ImageMetadata	metadata
private byte[][]	palette
private float	pixelScale
private int	stride
private int	width

Constructor Summary

Constructors

Constructor and Description
ImageFrame(ImageStorage.ImageType imageType, java.nio.ByteBuffer imageData, int width, int height, int stride, byte[][] palette, float pixelScale, ImageMetadata metadata) Create an ImageFrame.
ImageFrame(ImageStorage.ImageType imageType, java.nio.ByteBuffer imageData, int width, int height, int stride, byte[][] palette, ImageMetadata metadata) Create an ImageFrame with a default 72DPI pixel scale.

Method Summary

Modifier and Type	Method and Description
int	getHeight()
java.nio.Buffer	getImageData()
ImageStorage.ImageType	getImageType()
ImageMetadata	getMetadata()
byte[][]	getPalette()
float	getPixelScale()
int	getStride()
int	getWidth()
void	setPixelScale(float pixelScale)

Methods inherited from class java.lang.Object

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

Field Detail

imageType

private ImageStorage.ImageType imageType

imageData

private java.nio.ByteBuffer imageData

width

private int width

height

private int height

stride

private int stride

pixelScale

private float pixelScale

palette

private byte[][] palette

metadata

private ImageMetadata metadata

Constructor Detail

ImageFrame

public ImageFrame(ImageStorage.ImageType imageType,
                  java.nio.ByteBuffer imageData,
                  int width,
                  int height,
                  int stride,
                  byte[][] palette,
                  ImageMetadata metadata)

Create an ImageFrame with a default 72DPI pixel scale.

Parameters:

imageType - The type of image data. The value of this field also implies the number of bands.

imageData - The image data.

width - The image width.

height - The image height.

stride - The stride from a pixel position in one row to the same horizontal position in the next row.

palette - The image palette. This is ignored unless the type is one of the palette types.

metadata - The image metadata.

ImageFrame

public ImageFrame(ImageStorage.ImageType imageType,
                  java.nio.ByteBuffer imageData,
                  int width,
                  int height,
                  int stride,
                  byte[][] palette,
                  float pixelScale,
                  ImageMetadata metadata)

Create an ImageFrame.

Parameters:

imageType - The type of image data. The value of this field also implies the number of bands.

imageData - The image data.

width - The image width.

height - The image height.

stride - The stride from a pixel position in one row to the same horizontal position in the next row.

palette - The image palette. This is ignored unless the type is one of the palette types.

pixelScale - The scale of a 72DPI virtual pixel in the resolution of the image (1.0f for 72DPI images, 2.0f for 144DPI images, etc.).

metadata - The image metadata.

Method Detail

getImageType

public ImageStorage.ImageType getImageType()

getImageData

public java.nio.Buffer getImageData()

getWidth

public int getWidth()

getHeight

public int getHeight()

getStride

public int getStride()

getPalette

public byte[][] getPalette()

setPixelScale

public void setPixelScale(float pixelScale)

getPixelScale

public float getPixelScale()

getMetadata

public ImageMetadata getMetadata()