Class PNGEncodeParam.RGB

java.lang.Object
org.apache.xmlgraphics.image.codec.png.PNGEncodeParam
org.apache.xmlgraphics.image.codec.png.PNGEncodeParam.RGB
All Implemented Interfaces:
Serializable, Cloneable, ImageDecodeParam, ImageEncodeParam
Enclosing class:
PNGEncodeParam

public static class PNGEncodeParam.RGB extends PNGEncodeParam
See Also:
  • Constructor Details

    • RGB

      public RGB()
      Constructs an instance of PNGEncodeParam.RGB.
  • Method Details

    • unsetBackground

      public void unsetBackground()
      Suppresses the 'bKGD' chunk from being output.
      Overrides:
      unsetBackground in class PNGEncodeParam
    • isBackgroundSet

      public boolean isBackgroundSet()
      Returns true if a 'bKGD' chunk will be output.
      Overrides:
      isBackgroundSet in class PNGEncodeParam
    • setBitDepth

      public void setBitDepth(int bitDepth)
      Sets the desired bit depth for an RGB image. The bit depth must be 8 or 16.
      Specified by:
      setBitDepth in class PNGEncodeParam
    • setBackgroundRGB

      public void setBackgroundRGB(int[] rgb)
      Sets the RGB value of the suggested background color. The rgb parameter should have 3 entries.

      The 'bKGD' chunk will encode this information.

    • getBackgroundRGB

      public int[] getBackgroundRGB()
      Returns the RGB value of the suggested background color.

      If the background color has not previously been set, or has been unset, an IllegalStateException will be thrown.

      Throws:
      IllegalStateException - if the background color is not set.
    • setTransparentRGB

      public void setTransparentRGB(int[] transparentRGB)
      Sets the RGB value to be used to denote transparency.

      Setting this attribute will cause the alpha channel of the input image to be ignored.

      The 'tRNS' chunk will encode this information.

    • getTransparentRGB

      public int[] getTransparentRGB()
      Returns the RGB value to be used to denote transparency.

      If the transparent color has not previously been set, or has been unset, an IllegalStateException will be thrown.

      Throws:
      IllegalStateException - if the transparent color is not set.