java.lang.Object javax.imageio.IIOParam javax.imageio.ImageWriteParam javax.imageio.plugins.bmp.BMPImageWriteParam
A subclass of ImageWriteParam
for encoding images in
the BMP format.
This class allows for the specification of various parameters while writing a BMP format image file. By default, no compression is used (the compression type is "BI_RGB"), and the data layout isbottom-up, such that the pixels are stored in bottom-up order, the first scanline being stored last.
The particular compression scheme to be used can be specified by using
the setCompressionType()
method with the appropriate type
string. The compression scheme specified will be honored if only if it
is compatible with the type of image being written. The compression type
strings and the image type(s) each supports are listed in the following
table:
Type String | Description | Image Types |
---|---|---|
BI_RGB | Uncompressed RLE | <= 8-bits/sample |
BI_RLE8 | 8-bit Run Length Encoding | <= 8-bits/sample |
BI_RLE4 | 4-bit Run Length Encoding | <= 4-bits/sample |
BI_BITFIELDS | Packed data | 16 or 32 bits/sample |
Field Summary |
---|
Fields inherited from class javax.imageio.ImageWriteParam |
---|
canOffsetTiles, canWriteCompressed, canWriteProgressive, canWriteTiles, compressionMode, compressionQuality, compressionType, compressionTypes, locale, MODE_COPY_FROM_METADATA, MODE_DEFAULT, MODE_DISABLED, MODE_EXPLICIT, preferredTileSizes, progressiveMode, tileGridXOffset, tileGridYOffset, tileHeight, tileWidth, tilingMode, tilingSet |
Fields inherited from class javax.imageio.IIOParam |
---|
controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset |
Constructor Summary | |
---|---|
BMPImageWriteParam()
Constructs an BMPImageWriteParam object with default
values for all parameters and a null Locale . |
|
BMPImageWriteParam(Locale locale)
Constructs a BMPImageWriteParam set to use a given
Locale and with default values for all parameters. |
Method Summary | |
---|---|
boolean |
isTopDown()
Returns the value of the topDown parameter. |
void |
setTopDown(boolean topDown)
If set, the data will be written out in a top-down manner, the first scanline being written first. |
Methods inherited from class javax.imageio.IIOParam |
---|
activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setDestinationType, setSourceBands, setSourceRegion, setSourceSubsampling |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BMPImageWriteParam(Locale locale)
BMPImageWriteParam
set to use a given
Locale
and with default values for all parameters.
locale
- a Locale
to be used to localize
compression type names and quality descriptions, or
null
.public BMPImageWriteParam()
BMPImageWriteParam
object with default
values for all parameters and a null
Locale
.
Method Detail |
---|
public void setTopDown(boolean topDown)
topDown
- whether the data are written in top-down order.public boolean isTopDown()
topDown
parameter.
The default is false
.