/* * Copyright (c) 2003, 2017, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.imageio.plugins.bmp; import java.util.Locale; import javax.imageio.ImageWriteParam; import com.sun.imageio.plugins.bmp.BMPConstants; import com.sun.imageio.plugins.bmp.BMPCompressionTypes; /** * A subclass of {@code 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 {@code 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 {@code IOException} will be thrown by the BMP image writer. * If the compression type is not set explicitly then {@code getCompressionType()} * will return {@code 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 * | {@literal <= } 8-bits/sample * |
BI_RLE8 * | 8-bit Run Length Encoding * | {@literal <=} 8-bits/sample * |
BI_RLE4 * | 4-bit Run Length Encoding * | {@literal <=} 4-bits/sample * |
BI_BITFIELDS * | Packed data * | 16 or 32 bits/sample * |