image_import_description.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 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 ** Mark Page
27 */
28
29
30 #pragma once
31
32 #include <memory>
33 #include <functional>
34
35 namespace clan
36 {
39
40 class Size;
41 class Rect;
42 class ImageImportDescription_Impl;
43 class PixelBuffer;
44
48 class ImageImportDescription
49 {
52 public:
54 ImageImportDescription();
55
56 ~ImageImportDescription();
57
61 public:
62
64 bool get_premultiply_alpha() const;
65
67 bool flip_vertical() const;
68
70 bool is_srgb() const;
71
73 bool is_cached() const;
77 public:
82 PixelBuffer process(PixelBuffer &image) const;
83
87 void set_premultiply_alpha(bool enable);
88
92 void set_flip_vertical(bool enable);
93
97 void set_srgb(bool enable);
98
102 void set_cached(bool enable);
103
107 public:
113 std::function<PixelBuffer(PixelBuffer &)> &func_process();
114
118 private:
119 std::shared_ptr<ImageImportDescription_Impl> impl;
121 };
122
123 }
124
clan::ImageImportDescription::func_process
std::function< PixelBuffer(PixelBuffer &)> & func_process()
User defined fine control of the pixel buffer.
clan
Definition: clanapp.h:35
clan::PixelBuffer
Pixel data container.
Definition: pixel_buffer.h:68
clan::ImageImportDescription::process
PixelBuffer process(PixelBuffer &image) const
Process the pixel buffers depending of the chosen settings.
clan::ImageImportDescription::set_premultiply_alpha
void set_premultiply_alpha(bool enable)
Set the premultiply alpha setting.
clan::ImageImportDescription
Image Import Description Class.
Definition: image_import_description.h:48
clan::ImageImportDescription::ImageImportDescription
ImageImportDescription()
Constructs a image import description with default values.
clan::BrushType::image
clan::ImageImportDescription::set_srgb
void set_srgb(bool enable)
Controls if the image is uploaded as a sRGB texture or not.
clan::ImageImportDescription::is_srgb
bool is_srgb() const
Returns the sRGB setting.
clan::ImageImportDescription::is_cached
bool is_cached() const
Returns if this image should be cached.
clan::ImageImportDescription::set_cached
void set_cached(bool enable)
Controls if this image can be cached.
clan::ImageImportDescription::set_flip_vertical
void set_flip_vertical(bool enable)
Set the flip vertical setting.
clan::ImageImportDescription::get_premultiply_alpha
bool get_premultiply_alpha() const
Returns the premultiply alpha setting.
clan::ImageImportDescription::~ImageImportDescription
~ImageImportDescription()
clan::ImageImportDescription::flip_vertical
bool flip_vertical() const
Returns the flip vertical setting.