png++  0.2.7
image_info.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2007,2008 Alex Shulgin
3  *
4  * This file is part of png++ the C++ wrapper for libpng. PNG++ is free
5  * software; the exact copying conditions are as follows:
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice,
11  * this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in the
15  * documentation and/or other materials provided with the distribution.
16  *
17  * 3. The name of the author may not be used to endorse or promote products
18  * derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
23  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
25  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 #ifndef PNGPP_IMAGE_INFO_HPP_INCLUDED
32 #define PNGPP_IMAGE_INFO_HPP_INCLUDED
33 
34 #include "types.hpp"
35 #include "palette.hpp"
36 #include "tRNS.hpp"
37 #include "pixel_traits.hpp"
38 
39 namespace png
40 {
41 
47  class image_info
48  {
49  public:
56  : m_width(0),
57  m_height(0),
58  m_bit_depth(0),
63  {
64  }
65 
66  size_t get_width() const
67  {
68  return m_width;
69  }
70 
71  void set_width(size_t width)
72  {
73  m_width = width;
74  }
75 
76  size_t get_height() const
77  {
78  return m_height;
79  }
80 
81  void set_height(size_t height)
82  {
83  m_height = height;
84  }
85 
87  {
88  return m_color_type;
89  }
90 
91  void set_color_type(color_type color_space)
92  {
93  m_color_type = color_space;
94  }
95 
96  size_t get_bit_depth() const
97  {
98  return m_bit_depth;
99  }
100 
101  void set_bit_depth(size_t bit_depth)
102  {
103  m_bit_depth = bit_depth;
104  }
105 
107  {
108  return m_interlace_type;
109  }
110 
112  {
113  m_interlace_type = interlace;
114  }
115 
117  {
118  return m_compression_type;
119  }
120 
122  {
123  m_compression_type = compression;
124  }
125 
127  {
128  return m_filter_type;
129  }
130 
132  {
133  m_filter_type = filter;
134  }
135 
136  palette const& get_palette() const
137  {
138  return m_palette;
139  }
140 
142  {
143  return m_palette;
144  }
145 
146  void set_palette(palette const& plte)
147  {
148  m_palette = plte;
149  }
150 
155  {
156  m_palette.clear();
157  }
158 
159  tRNS const& get_tRNS() const
160  {
161  return m_tRNS;
162  }
163 
165  {
166  return m_tRNS;
167  }
168 
169  void set_tRNS(tRNS const& trns)
170  {
171  m_tRNS = trns;
172  }
173 
174  protected:
177  size_t m_bit_depth;
184  };
185 
190  template< typename pixel >
191  image_info
193  {
194  typedef pixel_traits< pixel > traits;
196  info.set_color_type(traits::get_color_type());
197  info.set_bit_depth(traits::get_bit_depth());
198  return info;
199  }
200 
201 } // namespace png
202 
203 #endif // PNGPP_IMAGE_INFO_HPP_INCLUDED
image_info()
Constructs the image_info object with default values for color_type, interlace_type, compression_method and filter_type.
Definition: image_info.hpp:55
color_type get_color_type() const
Definition: image_info.hpp:86
size_t get_bit_depth() const
Definition: image_info.hpp:96
size_t m_bit_depth
Definition: image_info.hpp:177
void set_color_type(color_type color_space)
Definition: image_info.hpp:91
interlace_type
Definition: types.hpp:79
std::vector< byte > tRNS
The palette transparency map type. Currently implemented as std::vector of png::byte.
Definition: tRNS.hpp:44
compression_type get_compression_type() const
Definition: image_info.hpp:116
void set_palette(palette const &plte)
Definition: image_info.hpp:146
interlace_type get_interlace_type() const
Definition: image_info.hpp:106
filter_type m_filter_type
Definition: image_info.hpp:181
void set_filter_type(filter_type filter)
Definition: image_info.hpp:131
filter_type
Definition: types.hpp:91
void set_interlace_type(interlace_type interlace)
Definition: image_info.hpp:111
palette m_palette
Definition: image_info.hpp:182
std::vector< color > palette
The palette type. Currently implemented as std::vector of png::color.
Definition: palette.hpp:44
Pixel traits class template.
Definition: pixel_traits.hpp:48
palette & get_palette()
Definition: image_info.hpp:141
uint_32 m_height
Definition: image_info.hpp:176
Holds information about PNG image.
Definition: image_info.hpp:47
color_type
Definition: types.hpp:46
palette const & get_palette() const
Definition: image_info.hpp:136
void set_bit_depth(size_t bit_depth)
Definition: image_info.hpp:101
void set_width(size_t width)
Definition: image_info.hpp:71
size_t get_height() const
Definition: image_info.hpp:76
color_type m_color_type
Definition: image_info.hpp:178
compression_type
Definition: types.hpp:85
uint_32 m_width
Definition: image_info.hpp:175
png_uint_32 uint_32
Definition: types.hpp:41
Definition: types.hpp:95
filter_type get_filter_type() const
Definition: image_info.hpp:126
void drop_palette()
Removes all entries from the palette.
Definition: image_info.hpp:154
Definition: types.hpp:81
void set_compression_type(compression_type compression)
Definition: image_info.hpp:121
Definition: types.hpp:88
tRNS & get_tRNS()
Definition: image_info.hpp:164
void set_height(size_t height)
Definition: image_info.hpp:81
Holds information about PNG image. Adapter class for IO image operations.
Definition: info.hpp:45
void set_tRNS(tRNS const &trns)
Definition: image_info.hpp:169
tRNS const & get_tRNS() const
Definition: image_info.hpp:159
tRNS m_tRNS
Definition: image_info.hpp:183
image_info make_image_info()
Returns an image_info object with color_type and bit_depth fields setup appropriate for the pixel typ...
Definition: image_info.hpp:192
Definition: types.hpp:48
Definition: color.hpp:36
compression_type m_compression_type
Definition: image_info.hpp:180
interlace_type m_interlace_type
Definition: image_info.hpp:179
size_t get_width() const
Definition: image_info.hpp:66