public class BMPImageWriteParam extends ImageWriteParam
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 |
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
controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset
| Constructor | Description |
|---|---|
BMPImageWriteParam() |
Constructs an BMPImageWriteParam object with default values for all parameters and a null Locale. |
BMPImageWriteParam |
Constructs a BMPImageWriteParam set to use a given Locale and with default values for all parameters. |
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
isTopDown() |
Returns the value of the topDown parameter. |
void |
setTopDown |
If set, the data will be written out in a top-down manner, the first scanline being written first. |
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
activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setDestinationType, setSourceBands, setSourceRegion, setSourceSubsampling
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.public void setTopDown(boolean topDown)
topDown - whether the data are written in top-down order.public boolean isTopDown()
topDown parameter. The default is false.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/imageio/plugins/bmp/BMPImageWriteParam.html