pixel_converter.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 ** Magnus Norddahl
27 ** Mark Page
28 */
29
30
31 #pragma once
32
33 #include <memory>
34 #include "../../Core/Math/vec4.h"
35 #include "texture_format.h"
36
37 namespace clan
38 {
41
42 class PixelConverter_Impl;
43
45 class PixelConverter
46 {
49 public:
51 PixelConverter();
52 ~PixelConverter();
54
57 public:
59 bool get_premultiply_alpha() const;
60
62 bool flip_vertical() const;
63
65 float get_gamma() const;
66
68 Vec4i get_swizzle() const;
69
71 bool get_input_is_ycrcb() const;
72
74 bool get_output_is_ycrcb() const;
75
77
80 public:
84 void set_premultiply_alpha(bool enable);
85
89 void set_flip_vertical(bool enable);
90
94 void set_gamma(float gamma);
95
99 void set_swizzle(int red_source, int green_source, int blue_source, int alpha_source);
100 void set_swizzle(const Vec4i &swizzle);
101
103 void set_input_is_ycrcb(bool enable);
104
106 void set_output_is_ycrcb(bool enable);
107
109 void convert(void *output, int output_pitch, TextureFormat output_format, const void *input, int input_pitch, TextureFormat input_format, int width, int height);
111
114 private:
115 std::shared_ptr<PixelConverter_Impl> impl;
117 };
118
119 }
120
clan
Definition: clanapp.h:35
clan::PixelConverter::convert
void convert(void *output, int output_pitch, TextureFormat output_format, const void *input, int input_pitch, TextureFormat input_format, int width, int height)
Convert some pixel data.
clan::PixelConverter::set_output_is_ycrcb
void set_output_is_ycrcb(bool enable)
Converts to JPEG JFIF YCrCb.
clan::PixelConverter::flip_vertical
bool flip_vertical() const
Returns the flip vertical setting.
clan::PixelConverter::set_gamma
void set_gamma(float gamma)
Set the gamma applied when converting.
clan::PixelConverter::set_premultiply_alpha
void set_premultiply_alpha(bool enable)
Set the premultiply alpha setting.
clan::PixelConverter::set_input_is_ycrcb
void set_input_is_ycrcb(bool enable)
Converts from JPEG JFIF YCrCb.
clan::PixelConverter::get_input_is_ycrcb
bool get_input_is_ycrcb() const
Returns the JPEG JFIF YCrCb input setting.
clan::TextureFormat
TextureFormat
Texture format.
Definition: texture_format.h:40
clan::PixelConverter::get_gamma
float get_gamma() const
Returns the gamma setting.
clan::PixelConverter::~PixelConverter
~PixelConverter()
clan::PixelConverter
Low level pixel format converter class.
Definition: pixel_converter.h:45
clan::PixelConverter::set_flip_vertical
void set_flip_vertical(bool enable)
Set the flip vertical setting.
clan::PixelConverter::get_premultiply_alpha
bool get_premultiply_alpha() const
Returns the premultiply alpha setting.
clan::PixelConverter::get_swizzle
Vec4i get_swizzle() const
Returns the input channel used for each output channel.
clan::PixelConverter::PixelConverter
PixelConverter()
Constructs a pixel format converter.
clan::PixelConverter::get_output_is_ycrcb
bool get_output_is_ycrcb() const
Returns the JPEG JFIF YCrCb output setting.
clan::Vec4
4D vector
Definition: size.h:47
clan::PixelConverter::set_swizzle
void set_swizzle(int red_source, int green_source, int blue_source, int alpha_source)
Set the input channel used for each output channel.