javax.imageio.plugins.bmp
Class BMPImageWriteParam
java.lang.Object
javax.imageio.IIOParam
javax.imageio.ImageWriteParam
javax.imageio.plugins.bmp.BMPImageWriteParam
public class BMPImageWriteParam
- extends ImageWriteParam
A class to encode images in the BMP format.
By default, the data layout is bottom-up, such that the pixels are stored in
bottom-up order.
The compression scheme can be specified by using setCompressionType()
appropriate type string. The compression scheme specified will be honored
if it is compatible with the type of image being written. If the
compression scheme is not compatible with the type of image being written,
then an IOException will be thrown by the BMP image writer. If the
compression type is not set, then getCompressionType() will return null.
In this case the BMP image writer will select a compression type that
supports encoding of the given image without loss of the color resolution.
The compression type strings and the image type each supports are:
Uncompressed RLE: BI_RGB, image type: <= 8-bits/sample.
8-bit Run Length Encoding: BI_RLE8, image type: <= 8-bits/sample
4-bit Run Length Encoding: BI_RLE4, image type: <= 4-bits/sample
Packed data: BI_BITFIELDS, image type: 16 or 32 bits/sample
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 |
Constructor Summary |
BMPImageWriteParam()
Constructs an BMPImageWriteParam object with default values
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.ImageWriteParam |
canOffsetTiles, canWriteCompressed, canWriteProgressive, canWriteTiles, getBitRate, getCompressionMode, getCompressionQuality, getCompressionQualityDescriptions, getCompressionQualityValues, getCompressionType, getCompressionTypes, getLocale, getLocalizedCompressionTypeName, getPreferredTileSizes, getProgressiveMode, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, getTilingMode, isCompressionLossless, setCompressionMode, setCompressionQuality, setCompressionType, setProgressiveMode, setTiling, setTilingMode, unsetCompression, unsetTiling |
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 |
BMPImageWriteParam
public BMPImageWriteParam()
- Constructs an
BMPImageWriteParam
object with default values
and a null Locale
.
BMPImageWriteParam
public BMPImageWriteParam(Locale locale)
- Constructs a
BMPImageWriteParam
set to use a given
Locale
and with default values for all parameters.
- Parameters:
locale
- - a Locale
to be used to localize compression
type names and quality descriptions, or null
.
setTopDown
public void setTopDown(boolean topDown)
- If set, the data will be written out in a top-down manner, the first
scanline being written first.
- Parameters:
topDown
- - whether the data are written in top-down order.
isTopDown
public boolean isTopDown()
- Returns the value of the
topDown
parameter. The default is
false.
- Returns:
- whether the data are written in top-down order.