PngWriter.h
1 /* Copyright (C) 2017 Marc Duerner
2  *
3  * This library is free software; you can redistribute it and/or
4  * modify it under the terms of the GNU Lesser General Public
5  * License as published by the Free Software Foundation; either
6  * version 2.1 of the License, or (at your option) any later version.
7  *
8  * As a special exception, you may use this file as part of a free
9  * software library without restriction. Specifically, if other files
10  * instantiate templates or use macros or inline functions from this
11  * file, or you compile this file and link it with other files to
12  * produce an executable, this file does not by itself cause the
13  * resulting executable to be covered by the GNU General Public
14  * License. This exception does not however invalidate any other
15  * reasons why the executable file might be covered by the GNU Library
16  * General Public License.
17  *
18  * This library is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21  * Lesser General Public License for more details.
22  *
23  * You should have received a copy of the GNU Lesser General Public
24  * License along with this library; if not, write to the Free Software
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
26  * MA 02110-1301 USA
27  */
28 
29 #ifndef PT_GFX_PNGWRITER_H
30 #define PT_GFX_PNGWRITER_H
31 
32 #include <Pt/Gfx/Api.h>
33 #include <iosfwd>
34 
35 namespace Pt {
36 
37 namespace Gfx {
38 
41 class PT_GFX_API PngWriter
42 {
43  public:
47 
50  PngWriter(std::ostream& is);
51 
55 
58  void attach(std::ostream& is);
59 
62  void detach();
63 
66  void reset();
67 
70  void beginWrite(const Image& image);
71 
74  bool advance();
75 
78  void write(const Image& image);
79 
80  private:
81  class PngWriterImpl* _impl;
82 };
83 
84 } // namespace
85 
86 } // namespace
87 
88 #endif
Core module.
Definition: pt-gfx-images.dox:14
PngWriter(std::ostream &is)
Construct with target stream.
void beginWrite(const Image &image)
Begin compression of an image.
PngWriter()
Default Constructor.
bool advance()
Advance compression af an image, returns true when finished.
void detach()
Detach from target stream.
~PngWriter()
Destructor.
Writer for PNG images.
Definition: PngWriter.h:42
Basic image.
Definition: Image.h:52
void write(const Image &image)
Writes the whole image to the stream.
void attach(std::ostream &is)
Attach to target stream.
void reset()
Reset to begin new compression.