OpenJDK 27 · com.sun.imageio.plugins.png.PNGImageWriter

Modifier and Type	Field and Description
pack-priv int	bpp
pack-priv byte[]	currRow
private static final int	DEFAULT_COMPRESSION_LEVEL Default compression level = 4 ie medium compression
pack-priv byte[][]	filteredRows
pack-priv PNGMetadata	metadata
pack-priv int	numBands
pack-priv int	periodX
pack-priv int	periodY
pack-priv int	pixelsDone
pack-priv byte[]	prevRow
pack-priv RowFilter	rowFilter
pack-priv int[]	sampleSize
pack-priv byte[][]	scale
pack-priv byte[]	scale0
pack-priv byte[][]	scaleh
pack-priv byte[][]	scalel
pack-priv int	scalingBitDepth
pack-priv int[]	sourceBands
pack-priv int	sourceHeight
pack-priv int	sourceWidth
pack-priv int	sourceXOffset
pack-priv int	sourceYOffset
pack-priv ImageOutputStream	stream
pack-priv int	totalPixels

Access	Constructor and Description
public	PNGImageWriter(ImageWriterSpi originatingProvider)

Method Summary

Modifier and Type	Method and Description
private static int	chunkType(String typeString)
public IIOMetadata	convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param) Implements abstract javax.imageio.ImageWriter.convertImageMetadata. Implements javax.imageio.ImageTranscoder.convertImageMetadata. 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.
public IIOMetadata	convertStreamMetadata(IIOMetadata inData, ImageWriteParam param) Implements abstract javax.imageio.ImageWriter.convertStreamMetadata. Implements javax.imageio.ImageTranscoder.convertStreamMetadata. 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.
private byte[]	deflate(byte[] b)
private void	encodePass(ImageOutputStream os, RenderedImage image, int xOffset, int yOffset, int xSkip, int ySkip)
private boolean	equals(int[] s0, int[] s1)
public IIOMetadata	getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param) Implements abstract javax.imageio.ImageWriter.getDefaultImageMetadata. Returns an `IIOMetadata` object containing default values for encoding an image of the given type.
public IIOMetadata	getDefaultStreamMetadata(ImageWriteParam param) Implements abstract javax.imageio.ImageWriter.getDefaultStreamMetadata. Returns an `IIOMetadata` object containing default values for encoding a stream of images.
public ImageWriteParam	getDefaultWriteParam() Overrides javax.imageio.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.
private void	initializeScaleTables(int[] sampleSize)
public void	setOutput(Object output) Overrides javax.imageio.ImageWriter.setOutput. Sets the destination to the given `ImageOutputStream` or other `Object`.
public void	write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param) Implements abstract javax.imageio.ImageWriter.write. Appends a complete image stream containing a single image and associated stream and image metadata and thumbnails to the output.
private void	write_bKGD()
private void	write_cHRM()
private void	write_gAMA()
private void	write_hIST()
private void	write_iCCP()
private void	write_IDAT(RenderedImage image, int deflaterLevel)
private void	write_IHDR()
private void	write_iTXt()
private void	write_magic()
private void	write_pHYs()
private void	write_PLTE()
private void	write_sBIT()
private void	write_sPLT()
private void	write_sRGB()
private void	write_tEXt()
private void	write_tIME()
private void	write_tRNS()
private void	write_zTXt()
private void	writeIEND()
private void	writeUnknownChunks()

Inherited from javax.imageio.ImageWriter:: abort abortRequested addIIOWriteProgressListener addIIOWriteWarningListener canInsertEmpty canInsertImage canRemoveImage canReplaceImageMetadata canReplacePixels canReplaceStreamMetadata canWriteEmpty canWriteRasters canWriteSequence clearAbortRequest dispose endInsertEmpty endReplacePixels endWriteEmpty endWriteSequence getAvailableLocales getLocale getNumThumbnailsSupported getOriginatingProvider getOutput getPreferredThumbnailSizes prepareInsertEmpty prepareReplacePixels prepareWriteEmpty prepareWriteSequence processImageComplete processImageProgress processImageStarted processThumbnailComplete processThumbnailProgress processThumbnailStarted processWarningOccurred processWarningOccurred processWriteAborted removeAllIIOWriteProgressListeners removeAllIIOWriteWarningListeners removeIIOWriteProgressListener removeIIOWriteWarningListener removeImage replaceImageMetadata replacePixels replacePixels replaceStreamMetadata reset setLocale write write writeInsert writeToSequence

bpp	back to summary
pack-priv int bpp

currRow	back to summary
pack-priv byte[] currRow

DEFAULT_COMPRESSION_LEVEL	back to summary
private static final int DEFAULT_COMPRESSION_LEVEL Default compression level = 4 ie medium compression

filteredRows	back to summary
pack-priv byte[][] filteredRows

numBands	back to summary
pack-priv int numBands

periodX	back to summary
pack-priv int periodX

periodY	back to summary
pack-priv int periodY

pixelsDone	back to summary
pack-priv int pixelsDone

prevRow	back to summary
pack-priv byte[] prevRow

rowFilter	back to summary
pack-priv RowFilter rowFilter

sampleSize	back to summary
pack-priv int[] sampleSize

scale	back to summary
pack-priv byte[][] scale

scale0	back to summary
pack-priv byte[] scale0

scaleh	back to summary
pack-priv byte[][] scaleh

scalel	back to summary
pack-priv byte[][] scalel

scalingBitDepth	back to summary
pack-priv int scalingBitDepth

sourceBands	back to summary
pack-priv int[] sourceBands

sourceHeight	back to summary
pack-priv int sourceHeight

sourceWidth	back to summary
pack-priv int sourceWidth

sourceXOffset	back to summary
pack-priv int sourceXOffset

sourceYOffset	back to summary
pack-priv int sourceYOffset

stream	back to summary
pack-priv ImageOutputStream stream

totalPixels	back to summary
pack-priv int totalPixels

PNGImageWriter	back to summary
public PNGImageWriter(ImageWriterSpi originatingProvider)

Method Detail

chunkType	back to summary
private static int chunkType(String typeString)

convertImageMetadata back to summary

public IIOMetadata convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)

Implements abstract javax.imageio.ImageWriter.convertImageMetadata.

Implements javax.imageio.ImageTranscoder.convertImageMetadata.

Doc from javax.imageio.ImageTranscoder.convertImageMetadata.

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.

An optional ImageWriteParam may be supplied for cases where it may affect the structure of the image metadata.

If the supplied ImageWriteParam contains optional setting values not understood by this writer or transcoder, they will be ignored.

Annotations

@Override

convertStreamMetadata back to summary

public IIOMetadata convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)

Implements abstract javax.imageio.ImageWriter.convertStreamMetadata.

Implements javax.imageio.ImageTranscoder.convertStreamMetadata.

Doc from javax.imageio.ImageTranscoder.convertStreamMetadata.

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.

An optional ImageWriteParam may be supplied for cases where it may affect the structure of the stream metadata.

If the supplied ImageWriteParam contains optional setting values not understood by this writer or transcoder, they will be ignored.

Annotations

@Override

deflate	back to summary
private byte[] deflate(byte[] b) throws IOException

encodePass	back to summary
private void encodePass(ImageOutputStream os, RenderedImage image, int xOffset, int yOffset, int xSkip, int ySkip) throws IOException

equals	back to summary
private boolean equals(int[] s0, int[] s1)

getDefaultImageMetadata back to summary

public IIOMetadata getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)

Implements abstract javax.imageio.ImageWriter.getDefaultImageMetadata.

Doc from javax.imageio.ImageWriter.getDefaultImageMetadata.

Returns an IIOMetadata object containing default values for encoding an image of the given type. The contents of the object may be manipulated using either the XML tree structure returned by the IIOMetadata.getAsTree method, an IIOMetadataController object, or via plug-in specific interfaces, and the resulting data supplied to one of the write methods that take a stream metadata parameter.

An optional ImageWriteParam may be supplied for cases where it may affect the structure of the image metadata.

If the supplied ImageWriteParam contains optional setting values not supported by this writer (e.g. progressive encoding or any format-specific settings), they will be ignored.

Annotations

@Override

getDefaultStreamMetadata back to summary

public IIOMetadata getDefaultStreamMetadata(ImageWriteParam param)

Implements abstract javax.imageio.ImageWriter.getDefaultStreamMetadata.

Doc from javax.imageio.ImageWriter.getDefaultStreamMetadata.

Returns an IIOMetadata object containing default values for encoding a stream of images. The contents of the object may be manipulated using either the XML tree structure returned by the IIOMetadata.getAsTree method, an IIOMetadataController object, or via plug-in specific interfaces, and the resulting data supplied to one of the write methods that take a stream metadata parameter.

An optional ImageWriteParam may be supplied for cases where it may affect the structure of the stream metadata.

If the supplied ImageWriteParam contains optional setting values not supported by this writer (e.g. progressive encoding or any format-specific settings), they will be ignored.

Writers that do not make use of stream metadata (e.g., writers for single-image formats) should return null.

Annotations

@Override

getDefaultWriteParam back to summary

getDefaultWriteParam	back to summary
public ImageWriteParam getDefaultWriteParam() Overrides javax.imageio.ImageWriter.getDefaultWriteParam. Doc from javax.imageio.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. This is useful as a starting point for tweaking just a few parameters and otherwise leaving the default settings alone. The default implementation constructs and returns a new `ImageWriteParam` object that does not allow tiling, progressive encoding, or compression, and that will be localized for the current `Locale` (i.e., what you would get by calling `new ImageWriteParam(getLocale())`. Individual plug-ins may return an instance of `ImageWriteParam` with additional optional features enabled, or they may return an instance of a plug-in specific subclass of `ImageWriteParam`. Annotations @Override

public ImageWriteParam getDefaultWriteParam()

Overrides javax.imageio.ImageWriter.getDefaultWriteParam.

Doc from javax.imageio.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. This is useful as a starting point for tweaking just a few parameters and otherwise leaving the default settings alone.

The default implementation constructs and returns a new ImageWriteParam object that does not allow tiling, progressive encoding, or compression, and that will be localized for the current Locale (i.e., what you would get by calling new ImageWriteParam(getLocale()).

Individual plug-ins may return an instance of ImageWriteParam with additional optional features enabled, or they may return an instance of a plug-in specific subclass of ImageWriteParam.

Annotations

@Override

initializeScaleTables	back to summary
private void initializeScaleTables(int[] sampleSize)

setOutput back to summary

setOutput	back to summary
public void setOutput(Object output) Overrides javax.imageio.ImageWriter.setOutput. Doc from javax.imageio.ImageWriter.setOutput. Sets the destination to the given `ImageOutputStream` or other `Object`. The destination is assumed to be ready to accept data, and will not be closed at the end of each write. This allows distributed imaging applications to transmit a series of images over a single network connection. If `output` is `null`, any currently set output will be removed. If `output` is an `ImageOutputStream`, calls to the `write`, `writeToSequence`, and `prepareWriteEmpty`/`endWriteEmpty` methods will preserve the existing contents of the stream. Other write methods, such as `writeInsert`, `replaceStreamMetadata`, `replaceImageMetadata`, `replacePixels`, `prepareInsertEmpty`/`endInsertEmpty`, and `endWriteSequence`, require the full contents of the stream to be readable and writable, and may alter any portion of the stream. Use of a general `Object` other than an `ImageOutputStream` is intended for writers that interact directly with an output device or imaging protocol. The set of legal classes is advertised by the writer's service provider's `getOutputTypes` method; most writers will return a single-element array containing only `ImageOutputStream.class` to indicate that they accept only an `ImageOutputStream`. The default implementation sets the `output` instance variable to the value of `output` after checking `output` against the set of classes advertised by the originating provider, if there is one. Annotations @Override

public void setOutput(Object output)

Overrides javax.imageio.ImageWriter.setOutput.

Doc from javax.imageio.ImageWriter.setOutput.

Sets the destination to the given ImageOutputStream or other Object. The destination is assumed to be ready to accept data, and will not be closed at the end of each write. This allows distributed imaging applications to transmit a series of images over a single network connection. If output is null, any currently set output will be removed.

If output is an ImageOutputStream, calls to the write, writeToSequence, and prepareWriteEmpty/endWriteEmpty methods will preserve the existing contents of the stream. Other write methods, such as writeInsert, replaceStreamMetadata, replaceImageMetadata, replacePixels, prepareInsertEmpty/endInsertEmpty, and endWriteSequence, require the full contents of the stream to be readable and writable, and may alter any portion of the stream.

Use of a general Object other than an ImageOutputStream is intended for writers that interact directly with an output device or imaging protocol. The set of legal classes is advertised by the writer's service provider's getOutputTypes method; most writers will return a single-element array containing only ImageOutputStream.class to indicate that they accept only an ImageOutputStream.

The default implementation sets the output instance variable to the value of output after checking output against the set of classes advertised by the originating provider, if there is one.

Annotations

@Override

write back to summary

public void write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param) throws IIOException

Implements abstract javax.imageio.ImageWriter.write.

Doc from javax.imageio.ImageWriter.write.

Appends a complete image stream containing a single image and associated stream and image metadata and thumbnails to the output. Any necessary header information is included. If the output is an ImageOutputStream, its existing contents prior to the current seek position are not affected, and need not be readable or writable.

The output must have been set beforehand using the setOutput method.

Stream metadata may optionally be supplied; if it is null, default stream metadata will be used.

If canWriteRasters returns true, the IIOImage may contain a Raster source. Otherwise, it must contain a RenderedImage source.

The supplied thumbnails will be resized if needed, and any thumbnails in excess of the supported number will be ignored. If the format requires additional thumbnails that are not provided, the writer should generate them internally.

An ImageWriteParam may optionally be supplied to control the writing process. If param is null, a default write param will be used.

If the supplied ImageWriteParam contains optional setting values not supported by this writer (e.g. progressive encoding or any format-specific settings), they will be ignored.

Annotations

@Override

write_bKGD	back to summary
private void write_bKGD() throws IOException

write_cHRM	back to summary
private void write_cHRM() throws IOException

write_gAMA	back to summary
private void write_gAMA() throws IOException

write_hIST	back to summary
private void write_hIST() throws IOException, IIOException

write_iCCP	back to summary
private void write_iCCP() throws IOException

write_IDAT	back to summary
private void write_IDAT(RenderedImage image, int deflaterLevel) throws IOException

write_IHDR	back to summary
private void write_IHDR() throws IOException

write_iTXt	back to summary
private void write_iTXt() throws IOException

write_magic	back to summary
private void write_magic() throws IOException

write_pHYs	back to summary
private void write_pHYs() throws IOException

write_PLTE	back to summary
private void write_PLTE() throws IOException

write_sBIT	back to summary
private void write_sBIT() throws IOException

write_sPLT	back to summary
private void write_sPLT() throws IOException

write_sRGB	back to summary
private void write_sRGB() throws IOException

write_tEXt	back to summary
private void write_tEXt() throws IOException

write_tIME	back to summary
private void write_tIME() throws IOException

write_tRNS	back to summary
private void write_tRNS() throws IOException, IIOException

write_zTXt	back to summary
private void write_zTXt() throws IOException

writeIEND	back to summary
private void writeIEND() throws IOException

writeUnknownChunks	back to summary
private void writeUnknownChunks() throws IOException

public final Class PNGImageWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail