Top Description Fields Constructors Methods
com.sun.javafx.iio

public final Class ImageFrame

extends Object
Class Inheritance
Imports
com.sun.javafx.iio.ImageStorage.ImageType, java.nio.Buffer

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

Field Summary

Modifier and TypeField and Description
private final int
private final Buffer
private final ImageStorage.ImageType
private final ImageMetadata
private final int[]
private final int
private float
private final int
private final int

Constructor Summary

AccessConstructor and Description
public
ImageFrame(ImageStorage.ImageType
The type of image data. The value of this field also implies the number of bands.
imageType
,
Buffer
The image data.
imageData
,
int
The image width.
width
,
int
The image height.
height
,
int
The stride from a pixel position in one row to the same horizontal position in the next row, in data elements (not necessarily bytes).
stride
,
ImageMetadata
The image metadata.
metadata
)

Create an ImageFrame with a default 72DPI pixel scale.

public
ImageFrame(ImageStorage.ImageType
The type of image data. The value of this field also implies the number of bands.
imageType
,
Buffer
The image data.
imageData
,
int
The image width.
width
,
int
The image height.
height
,
int
The stride from a pixel position in one row to the same horizontal position in the next row, in data elements (not necessarily bytes).
stride
,
float
The scale of a 72DPI virtual pixel in the resolution of the image (1.0f for 72DPI images, 2.0f for 144DPI images, etc.).
pixelScale
,
ImageMetadata
The image metadata.
metadata
)

Create an ImageFrame.

public
ImageFrame(ImageStorage.ImageType
The type of image data. The value of this field also implies the number of bands.
imageType
,
Buffer
The image data.
imageData
,
int
The image width.
width
,
int
The image height.
height
,
int
The stride from a pixel position in one row to the same horizontal position in the next row, in data elements (not necessarily bytes).
stride
,
int[]
The image palette. This is ignored unless the type is one of the palette types.
palette
,
int
The size of a palette index, in bits.
paletteIndexBits
,
float
The scale of a 72DPI virtual pixel in the resolution of the image (1.0f for 72DPI images, 2.0f for 144DPI images, etc.).
pixelScale
,
ImageMetadata
The image metadata.
metadata
)

Create an ImageFrame.

Method Summary

Modifier and TypeMethod and Description
public int
public Buffer
public ImageStorage.ImageType
public ImageMetadata
public int[]
public int
public float
public int
public int
public void
setPixelScale(float pixelScale)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

heightback to summary
private final int height
imageDataback to summary
private final Buffer imageData
imageTypeback to summary
private final ImageStorage.ImageType imageType
metadataback to summary
private final ImageMetadata metadata
paletteback to summary
private final int[] palette
paletteIndexBitsback to summary
private final int paletteIndexBits
pixelScaleback to summary
private float pixelScale
strideback to summary
private final int stride
widthback to summary
private final int width

Constructor Detail

ImageFrameback to summary
public ImageFrame(ImageStorage.ImageType imageType, Buffer imageData, int width, int height, int stride, ImageMetadata metadata)

Create an ImageFrame with a default 72DPI pixel scale.

Parameters
imageType:ImageStorage.ImageType

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

imageData:Buffer

The image data.

width:int

The image width.

height:int

The image height.

stride:int

The stride from a pixel position in one row to the same horizontal position in the next row, in data elements (not necessarily bytes).

metadata:ImageMetadata

The image metadata.

ImageFrameback to summary
public ImageFrame(ImageStorage.ImageType imageType, Buffer imageData, int width, int height, int stride, float pixelScale, ImageMetadata metadata)

Create an ImageFrame.

Parameters
imageType:ImageStorage.ImageType

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

imageData:Buffer

The image data.

width:int

The image width.

height:int

The image height.

stride:int

The stride from a pixel position in one row to the same horizontal position in the next row, in data elements (not necessarily bytes).

pixelScale:float

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:ImageMetadata

The image metadata.

ImageFrameback to summary
public ImageFrame(ImageStorage.ImageType imageType, Buffer imageData, int width, int height, int stride, int[] palette, int paletteIndexBits, float pixelScale, ImageMetadata metadata)

Create an ImageFrame.

Parameters
imageType:ImageStorage.ImageType

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

imageData:Buffer

The image data.

width:int

The image width.

height:int

The image height.

stride:int

The stride from a pixel position in one row to the same horizontal position in the next row, in data elements (not necessarily bytes).

palette:int[]

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

paletteIndexBits:int

The size of a palette index, in bits.

pixelScale:float

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:ImageMetadata

The image metadata.

Method Detail

getHeightback to summary
public int getHeight()
getImageDataback to summary
public Buffer getImageData()
getImageTypeback to summary
public ImageStorage.ImageType getImageType()
getMetadataback to summary
public ImageMetadata getMetadata()
getPaletteback to summary
public int[] getPalette()
getPaletteIndexBitsback to summary
public int getPaletteIndexBits()
getPixelScaleback to summary
public float getPixelScale()
getStrideback to summary
public int getStride()
getWidthback to summary
public int getWidth()
setPixelScaleback to summary
public void setPixelScale(float pixelScale)