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, the data layout is bottom-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 and only if it
is compatible with the type of image being written. If the specified
compression scheme is not compatible with the type of image being written
then the IOException will be thrown by the BMP image writer.
If the compression type is not set explicitly 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(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 declared in 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, tilingSetFields declared in class javax.imageio.IIOParam
controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset -
Constructor Summary
ConstructorsConstructorDescriptionConstructs anBMPImageWriteParamobject with default values for all parameters and anull Locale.BMPImageWriteParam(Locale locale) Constructs aBMPImageWriteParamset to use a givenLocaleand with default values for all parameters. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturns the value of thetopDownparameter.voidsetTopDown(boolean topDown) If set, the data will be written out in a top-down manner, the first scanline being written first.Methods declared in 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, unsetTilingMethods declared in class javax.imageio.IIOParam
activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setDestinationType, setSourceBands, setSourceRegion, setSourceSubsampling
-
Constructor Details
-
BMPImageWriteParam
Constructs aBMPImageWriteParamset to use a givenLocaleand with default values for all parameters.- Parameters:
locale- aLocaleto be used to localize compression type names and quality descriptions, ornull.
-
BMPImageWriteParam
public BMPImageWriteParam()Constructs anBMPImageWriteParamobject with default values for all parameters and anull Locale.
-
-
Method Details
-
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 thetopDownparameter. The default isfalse.- Returns:
- whether the data are written in top-down order.
-