Class PixmapIO.PNG

  • All Implemented Interfaces:
    Disposable
    Enclosing class:
    PixmapIO

    public static class PixmapIO.PNG
    extends java.lang.Object
    implements Disposable
    PNG encoder with compression. An instance can be reused to encode multiple PNGs with minimal allocation.
     Copyright (c) 2007 Matthias Mann - www.matthiasmann.de
     Copyright (c) 2014 Nathan Sweet
    
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal
     in the Software without restriction, including without limitation the rights
     to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     copies of the Software, and to permit persons to whom the Software is
     furnished to do so, subject to the following conditions:
    
     The above copyright notice and this permission notice shall be included in
     all copies or substantial portions of the Software.
    
     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
     THE SOFTWARE.
     
    • Constructor Summary

      Constructors 
      Constructor Description
      PNG()  
      PNG​(int initialBufferSize)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void dispose()
      Disposal will happen automatically in Object.finalize() but can be done explicitly if desired.
      void setCompression​(int level)
      Sets the deflate compression level.
      void setFlipY​(boolean flipY)
      If true, the resulting PNG is flipped vertically.
      void write​(FileHandle file, Pixmap pixmap)  
      void write​(java.io.OutputStream output, Pixmap pixmap)
      Writes the pixmap to the stream without closing the stream.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • PNG

        public PNG()
      • PNG

        public PNG​(int initialBufferSize)
    • Method Detail

      • setFlipY

        public void setFlipY​(boolean flipY)
        If true, the resulting PNG is flipped vertically. Default is true.
      • setCompression

        public void setCompression​(int level)
        Sets the deflate compression level. Default is Deflater.DEFAULT_COMPRESSION.
      • write

        public void write​(FileHandle file,
                          Pixmap pixmap)
                   throws java.io.IOException
        Throws:
        java.io.IOException
      • write

        public void write​(java.io.OutputStream output,
                          Pixmap pixmap)
                   throws java.io.IOException
        Writes the pixmap to the stream without closing the stream.
        Throws:
        java.io.IOException
      • dispose

        public void dispose()
        Disposal will happen automatically in Object.finalize() but can be done explicitly if desired.
        Specified by:
        dispose in interface Disposable