png_output_description.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Harry Storbacka
27 */
28 
29 
30 #pragma once
31 
32 #include "../api_display.h"
33 #include "../Image/pixel_buffer.h"
34 #include "../../Core/IOData/file_system.h"
35 
36 namespace clan
37 {
40 
41 class FileSystem;
42 class PNGOutputDescription_Impl;
43 class DateTime;
44 
46 {
55 };
56 
58 {
61 };
62 
64 {
67 };
68 
70 {
75 };
76 
78 {
82 };
83 
85 {
88 };
89 
91 {
94 };
95 
96 
98 {
99 public:
101 
102 public:
103  void set_colors(const std::vector<Color> &palette_colors);
104  void set_key_color(const Color &color);
105  void set_tranparent_color_indexes(const std::vector<int> &alpha_indexes);
106 
107 private:
108  std::vector<Color> colors;
109  bool use_keycolor;
110 };
111 
112 
115 {
116 
119 
120 public:
125  PNGOutputDescription(int bit_depth=8, PNGColorType color_type = png_color_type_rgb_alpha);
126 
130 
131 public:
132 
136 
137 public:
138  void add_palette(const PNGOutputDescriptionPalette &palette);
139 
140  void add_comment(
141  const std::string &comment,
142  std::string &keyword, // max 79 characters.
143  const std::string &lang,
144  const std::string &translated_keyword);
145 
146  void add_unknown_chunk(const std::string &name, const DataBuffer &chunk_data, PNGUnknownChunkLocation location);
147 
148  void set_background_color(const Color &background_color);
149 
150  void set_chromacities(const Vec2f &white, const Vec2f &red, const Vec2f &green, const Vec2f &blue);
151  void set_chromacities_XYZ(const Vec3f &red, const Vec3f &green, const Vec3f &blue);
152 
153  void set_key_color(const Color &color);
154 
155  void set_filter_method(PNGFilterMethod filter);
156 
157  void set_gamma(float gamma);
158 
159  void set_icc_profile(const std::string &profile_name, const DataBuffer &profile_data);
160 
162 
163  void set_modification_time(const DateTime &datetime);
164 
165  void set_offset_from_screen_topleft(const Vec2i &offset, PNGOffsetUnitType offset_unit_type);
166 
167  void set_physical_resolution(const Vec2i &resolution, PNGResolutionUnitType resolution_type);
168 
169  void set_physical_scale(int scale_units, const Sized &pixel_size_in_scale_units);
170 
171  void set_srgb_intent(PNGsRGBIntent intent);
172 
173  void set_significant_bits(int num_bits);
174 
178 
179 private:
180 
181  std::shared_ptr<PNGOutputDescription_Impl> impl;
182 
184 };
185 
186 }
187 
PNGOffsetUnitType
Definition: png_output_description.h:84
void set_chromacities(const Vec2f &white, const Vec2f &red, const Vec2f &green, const Vec2f &blue)
PNGUnknownChunkLocation
Definition: png_output_description.h:77
Definition: png_output_description.h:93
void set_gamma(float gamma)
Definition: png_output_description.h:47
Date/Time class.
Definition: datetime.h:44
Definition: png_output_description.h:59
Definition: png_output_description.h:49
Definition: png_output_description.h:73
void set_modification_time(const DateTime &datetime)
PNGFilterMethod
Definition: png_output_description.h:63
Definition: png_output_description.h:80
void set_tranparent_color_indexes(const std::vector< int > &alpha_indexes)
void set_significant_bits(int num_bits)
Set PNG output options. Used with PNGProvider::save().
Definition: png_output_description.h:114
PNGOutputDescription(int bit_depth=8, PNGColorType color_type=png_color_type_rgb_alpha)
Create output description.
Definition: png_output_description.h:92
void set_offset_from_screen_topleft(const Vec2i &offset, PNGOffsetUnitType offset_unit_type)
Definition: png_output_description.h:65
void add_unknown_chunk(const std::string &name, const DataBuffer &chunk_data, PNGUnknownChunkLocation location)
2D (width,height) size structure - Double
Definition: size.h:183
void set_interlace_type(PNGInterlaceType type)
Definition: png_output_description.h:87
PNGInterlaceType
Definition: png_output_description.h:57
Definition: png_output_description.h:52
PNGResolutionUnitType
Definition: png_output_description.h:90
void set_chromacities_XYZ(const Vec3f &red, const Vec3f &green, const Vec3f &blue)
Definition: png_output_description.h:74
void set_background_color(const Color &background_color)
void set_colors(const std::vector< Color > &palette_colors)
void add_comment(const std::string &comment, std::string &keyword, const std::string &lang, const std::string &translated_keyword)
PNGColorType
Definition: png_output_description.h:45
PNGsRGBIntent
Definition: png_output_description.h:69
Definition: png_output_description.h:53
Definition: png_output_description.h:86
Definition: png_output_description.h:60
Definition: png_output_description.h:51
Definition: png_output_description.h:72
Definition: png_output_description.h:79
void set_physical_scale(int scale_units, const Sized &pixel_size_in_scale_units)
Definition: png_output_description.h:66
Definition: png_output_description.h:81
void set_key_color(const Color &color)
void set_filter_method(PNGFilterMethod filter)
Definition: png_output_description.h:48
Definition: png_output_description.h:97
Definition: png_output_description.h:71
General purpose data buffer.
Definition: databuffer.h:43
Definition: png_output_description.h:50
void set_key_color(const Color &color)
Definition: png_output_description.h:54
void add_palette(const PNGOutputDescriptionPalette &palette)
void set_srgb_intent(PNGsRGBIntent intent)
Color description class.
Definition: color.h:47
void set_icc_profile(const std::string &profile_name, const DataBuffer &profile_data)
void set_physical_resolution(const Vec2i &resolution, PNGResolutionUnitType resolution_type)