Package com.sixlegs.png
Class PngConfig
java.lang.Object
com.sixlegs.png.PngConfig
Customizable parameters used by
PngImage
when decoding an image.
Instances of this class are immutable and can only be constructed
using the PngConfig.Builder
inner-class.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Builder class used to constructPngConfig
instances. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Read the entire imagestatic final int
Read the entire image, skipping over the image datastatic final int
Read the entire image, skipping over all non-critical chunks except tRNS and gAMAstatic final int
Read only the header chunkstatic final int
Read all the metadata up to the image data -
Method Summary
Modifier and TypeMethodDescriptionboolean
Return sthe current indexed image conversion setting.float
Returns the current default gamma value.float
Returns the current display exponent.boolean
Returns the current gamma correction setting.boolean
Returns the current progressive display setting.int
Returns the current read limit setting.boolean
Returns the current 16-bit reduction setting.Returns the source region to be used.int
Returns the number of source columns to advance for each pixel.int
Returns the number of rows to advance for each pixel.int
Returns the horizontal offset of the subsampling grid.int
Returns the vertical offset of the subsampling grid.boolean
Returns whether warnings are treated as fatal errors.
-
Field Details
-
READ_ALL
public static final int READ_ALLRead the entire image- See Also:
-
READ_HEADER
public static final int READ_HEADERRead only the header chunk- See Also:
-
READ_UNTIL_DATA
public static final int READ_UNTIL_DATARead all the metadata up to the image data- See Also:
-
READ_EXCEPT_DATA
public static final int READ_EXCEPT_DATARead the entire image, skipping over the image data- See Also:
-
READ_EXCEPT_METADATA
public static final int READ_EXCEPT_METADATARead the entire image, skipping over all non-critical chunks except tRNS and gAMA- See Also:
-
-
Method Details
-
getConvertIndexed
public boolean getConvertIndexed()Return sthe current indexed image conversion setting.- See Also:
-
PngConfig.Builder.convertIndexed
-
getReduce16
public boolean getReduce16()Returns the current 16-bit reduction setting.- See Also:
-
PngConfig.Builder.reduce16
-
getDefaultGamma
public float getDefaultGamma()Returns the current default gamma value.- See Also:
-
PngConfig.Builder.defaultGamma
-
getGammaCorrect
public boolean getGammaCorrect()Returns the current gamma correction setting.- See Also:
-
PngConfig.Builder.gammaCorrect
-
getProgressive
public boolean getProgressive()Returns the current progressive display setting.- See Also:
-
PngConfig.Builder.progressive
-
getDisplayExponent
public float getDisplayExponent()Returns the current display exponent.- See Also:
-
PngConfig.Builder.displayExponent
-
getReadLimit
public int getReadLimit()Returns the current read limit setting.- Returns:
- one of
READ_ALL
,
READ_HEADER
,
READ_UNTIL_DATA
,
READ_EXCEPT_DATA
,
orREAD_EXCEPT_METADATA
- See Also:
-
PngConfig.Builder.readLimit
-
getWarningsFatal
public boolean getWarningsFatal()Returns whether warnings are treated as fatal errors.- See Also:
-
PngConfig.Builder.warningsFatal
-
getSourceRegion
Returns the source region to be used.- See Also:
-
PngConfig.Builder.sourceRegion
-
getSourceXSubsampling
public int getSourceXSubsampling()Returns the number of source columns to advance for each pixel. -
getSourceYSubsampling
public int getSourceYSubsampling()Returns the number of rows to advance for each pixel. -
getSubsamplingXOffset
public int getSubsamplingXOffset()Returns the horizontal offset of the subsampling grid. -
getSubsamplingYOffset
public int getSubsamplingYOffset()Returns the vertical offset of the subsampling grid.
-