png++  0.2.9
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  m_gamma(0.0)
64  {
65  }
66 
68  {
69  return m_width;
70  }
71 
72  void set_width(uint_32 width)
73  {
74  m_width = width;
75  }
76 
78  {
79  return m_height;
80  }
81 
82  void set_height(uint_32 height)
83  {
84  m_height = height;
85  }
86 
88  {
89  return m_color_type;
90  }
91 
92  void set_color_type(color_type color_space)
93  {
94  m_color_type = color_space;
95  }
96 
97  int get_bit_depth() const
98  {
99  return m_bit_depth;
100  }
101 
102  void set_bit_depth(int bit_depth)
103  {
104  m_bit_depth = bit_depth;
105  }
106 
108  {
109  return m_interlace_type;
110  }
111 
113  {
114  m_interlace_type = interlace;
115  }
116 
118  {
119  return m_compression_type;
120  }
121 
123  {
124  m_compression_type = compression;
125  }
126 
128  {
129  return m_filter_type;
130  }
131 
133  {
134  m_filter_type = filter;
135  }
136 
137  palette const& get_palette() const
138  {
139  return m_palette;
140  }
141 
143  {
144  return m_palette;
145  }
146 
147  void set_palette(palette const& plte)
148  {
149  m_palette = plte;
150  }
151 
156  {
157  m_palette.clear();
158  }
159 
160  tRNS const& get_tRNS() const
161  {
162  return m_tRNS;
163  }
164 
166  {
167  return m_tRNS;
168  }
169 
170  void set_tRNS(tRNS const& trns)
171  {
172  m_tRNS = trns;
173  }
174 
175  double get_gamma() const
176  {
177  return m_gamma;
178  }
179 
180  void set_gamma(double gamma)
181  {
182  m_gamma = gamma;
183  }
184 
185  protected:
195  double m_gamma;
196  };
197 
202  template< typename pixel >
203  image_info
205  {
206  typedef pixel_traits< pixel > traits;
208  info.set_color_type(traits::get_color_type());
209  info.set_bit_depth(traits::get_bit_depth());
210  return info;
211  }
212 
213 } // namespace png
214 
215 #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:87
void set_color_type(color_type color_space)
Definition: image_info.hpp:92
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:117
void set_palette(palette const &plte)
Definition: image_info.hpp:147
uint_32 get_width() const
Definition: image_info.hpp:67
interlace_type get_interlace_type() const
Definition: image_info.hpp:107
filter_type m_filter_type
Definition: image_info.hpp:192
void set_filter_type(filter_type filter)
Definition: image_info.hpp:132
filter_type
Definition: types.hpp:91
void set_interlace_type(interlace_type interlace)
Definition: image_info.hpp:112
palette m_palette
Definition: image_info.hpp:193
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:142
double get_gamma() const
Definition: image_info.hpp:175
uint_32 m_height
Definition: image_info.hpp:187
Holds information about PNG image.
Definition: image_info.hpp:47
uint_32 get_height() const
Definition: image_info.hpp:77
color_type
Definition: types.hpp:46
palette const & get_palette() const
Definition: image_info.hpp:137
color_type m_color_type
Definition: image_info.hpp:189
double m_gamma
Definition: image_info.hpp:195
compression_type
Definition: types.hpp:85
void set_width(uint_32 width)
Definition: image_info.hpp:72
uint_32 m_width
Definition: image_info.hpp:186
png_uint_32 uint_32
Definition: types.hpp:41
Definition: types.hpp:95
filter_type get_filter_type() const
Definition: image_info.hpp:127
void drop_palette()
Removes all entries from the palette.
Definition: image_info.hpp:155
void set_bit_depth(int bit_depth)
Definition: image_info.hpp:102
Definition: types.hpp:81
void set_compression_type(compression_type compression)
Definition: image_info.hpp:122
void set_height(uint_32 height)
Definition: image_info.hpp:82
Definition: types.hpp:88
tRNS & get_tRNS()
Definition: image_info.hpp:165
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:170
tRNS const & get_tRNS() const
Definition: image_info.hpp:160
tRNS m_tRNS
Definition: image_info.hpp:194
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:204
int get_bit_depth() const
Definition: image_info.hpp:97
Definition: types.hpp:48
Definition: color.hpp:36
int m_bit_depth
Definition: image_info.hpp:188
void set_gamma(double gamma)
Definition: image_info.hpp:180
compression_type m_compression_type
Definition: image_info.hpp:191
interlace_type m_interlace_type
Definition: image_info.hpp:190