Uses of Class javax.imageio.ImageWriteParam (Java SE 22 & JDK 22)
Description: use: module: java.desktop, package: javax.imageio, class: ImageWriteParam

# Uses of Class
javax.imageio.ImageWriteParam

Packages that use ImageWriteParam
Package
Description
javax.imageio
The main package of the Java Image I/O API.
javax.imageio.plugins.bmp
Package containing the public classes used by the built-in BMP plug-in.
javax.imageio.plugins.jpeg
Classes supporting the built-in JPEG plug-in.

- ## Uses of ImageWriteParam in javax.imageio

  Methods in javax.imageio that return ImageWriteParam
  Modifier and Type
  Method
  Description
  `ImageWriteParam`
  ImageWriter.`getDefaultWriteParam()`
  Returns a new `ImageWriteParam` object of the appropriate type for this file format containing default values, that is, those values that would be used if no `ImageWriteParam` object were specified.
  Methods in javax.imageio with parameters of type ImageWriteParam
  Modifier and Type
  Method
  Description
  `IIOMetadata`
  ImageTranscoder.`convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)`
  Returns an `IIOMetadata` object that may be used for encoding and optionally modified using its document interfaces or other interfaces specific to the writer plug-in that will be used for encoding.
  `IIOMetadata`
  ImageTranscoder.`convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)`
  Returns an `IIOMetadata` object that may be used for encoding and optionally modified using its document interfaces or other interfaces specific to the writer plug-in that will be used for encoding.
  `abstract IIOMetadata`
  ImageWriter.`getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)`
  Returns an `IIOMetadata` object containing default values for encoding an image of the given type.
  `abstract IIOMetadata`
  ImageWriter.`getDefaultStreamMetadata(ImageWriteParam param)`
  Returns an `IIOMetadata` object containing default values for encoding a stream of images.
  `int`
  ImageWriter.`getNumThumbnailsSupported(ImageTypeSpecifier imageType, ImageWriteParam param, IIOMetadata streamMetadata, IIOMetadata imageMetadata)`
  Returns the number of thumbnails supported by the format being written, given the image type and any additional write parameters and metadata objects that will be used during encoding.
  `Dimension[]`
  ImageWriter.`getPreferredThumbnailSizes(ImageTypeSpecifier imageType, ImageWriteParam param, IIOMetadata streamMetadata, IIOMetadata imageMetadata)`
  Returns an array of `Dimension`s indicating the legal size ranges for thumbnail images as they will be encoded in the output file or stream.
  `void`
  ImageWriter.`prepareInsertEmpty(int imageIndex, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List<? extends BufferedImage> thumbnails, ImageWriteParam param)`
  Begins the insertion of a new image with undefined pixel values into an existing image stream.
  `void`
  ImageWriter.`prepareWriteEmpty(IIOMetadata streamMetadata, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List<? extends BufferedImage> thumbnails, ImageWriteParam param)`
  Begins the writing of a complete image stream, consisting of a single image with undefined pixel values and associated metadata and thumbnails, to the output.
  `void`
  ImageWriter.`replacePixels(Raster raster, ImageWriteParam param)`
  Replaces a portion of an image already present in the output with a portion of the given `Raster`.
  `void`
  ImageWriter.`replacePixels(RenderedImage image, ImageWriteParam param)`
  Replaces a portion of an image already present in the output with a portion of the given image.
  `abstract void`
  ImageWriter.`write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param)`
  Appends a complete image stream containing a single image and associated stream and image metadata and thumbnails to the output.
  `void`
  ImageWriter.`writeInsert(int imageIndex, IIOImage image, ImageWriteParam param)`
  Inserts a new image into an existing image stream.
  `void`
  ImageWriter.`writeToSequence(IIOImage image, ImageWriteParam param)`
  Appends a single image and possibly associated metadata and thumbnails, to the output.

- ## Uses of ImageWriteParam in javax.imageio.plugins.bmp

  Subclasses of ImageWriteParam in javax.imageio.plugins.bmp
  Modifier and Type
  Class
  Description
  `class`
  `BMPImageWriteParam`
  A subclass of `ImageWriteParam` for encoding images in the BMP format.

- ## Uses of ImageWriteParam in javax.imageio.plugins.jpeg

  Subclasses of ImageWriteParam in javax.imageio.plugins.jpeg
  Modifier and Type
  Class
  Description
  `class`
  `JPEGImageWriteParam`
  This class adds the ability to set JPEG quantization and Huffman tables when using the built-in JPEG writer plug-in, and to request that optimized Huffman tables be computed for an image.