image_import_description.h Source File - ClanLib SDK
Description: image_import_description.h Source File

image_import_description.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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#pragma once
30
31#include <memory>
32#include <functional>
33
34namespace clan
35{
38
39 class Size;
40 class Rect;
41 class ImageImportDescription_Impl;
42 class PixelBuffer;
43
47 class ImageImportDescription
48 {
49 public:
51 ImageImportDescription();
52 ~ImageImportDescription();
53
55 bool get_premultiply_alpha() const;
56
58 bool flip_vertical() const;
59
61 bool is_srgb() const;
62
64 bool is_cached() const;
65
70 PixelBuffer process(PixelBuffer &image) const;
71
75 void set_premultiply_alpha(bool enable);
76
80 void set_flip_vertical(bool enable);
81
85 void set_srgb(bool enable);
86
90 void set_cached(bool enable);
91
97 std::function<PixelBuffer(PixelBuffer &)> &func_process();
98
99 private:
100 std::shared_ptr<ImageImportDescription_Impl> impl;
101 };
102
104}
clan::ImageImportDescription::func_process
std::function< PixelBuffer(PixelBuffer &)> & func_process()
User defined fine control of the pixel buffer.
clan::ImageImportDescription::is_cached
bool is_cached() const
Returns if this image should be cached.
clan::ImageImportDescription::~ImageImportDescription
~ImageImportDescription()
clan::ImageImportDescription::set_srgb
void set_srgb(bool enable)
Controls if the image is uploaded as a sRGB texture or not.
clan::ImageImportDescription::flip_vertical
bool flip_vertical() const
Returns the flip vertical setting.
clan::ImageImportDescription::set_cached
void set_cached(bool enable)
Controls if this image can be cached.
clan::ImageImportDescription::ImageImportDescription
ImageImportDescription()
Constructs a image import description with default values.
clan::ImageImportDescription::is_srgb
bool is_srgb() const
Returns the sRGB setting.
clan::ImageImportDescription::set_premultiply_alpha
void set_premultiply_alpha(bool enable)
Set the premultiply alpha setting.
clan::ImageImportDescription::process
PixelBuffer process(PixelBuffer &image) const
Process the pixel buffers depending of the chosen settings.
clan::ImageImportDescription::get_premultiply_alpha
bool get_premultiply_alpha() const
Returns the premultiply alpha setting.
clan::ImageImportDescription::set_flip_vertical
void set_flip_vertical(bool enable)
Set the flip vertical setting.
clan::PixelBuffer
Pixel data container.
Definition pixel_buffer.h:68
clan::Rect
2D (left,top,right,bottom) rectangle structure - Integer
Definition rect.h:446
clan::Size
2D (width,height) size structure - Integer
Definition size.h:176
clan
Definition clanapp.h:36
clan::BrushType::image
@ image
Definition brush.h:54