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

pixel_converter.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** Magnus Norddahl
27** Mark Page
28*/
29
30#pragma once
31
32#include <memory>
33#include "../../Core/Math/vec4.h"
34#include "texture_format.h"
35
36namespace clan
37{
40
41 class PixelConverter_Impl;
42
44 class PixelConverter
45 {
46 public:
48 PixelConverter();
49 ~PixelConverter();
50
52 bool get_premultiply_alpha() const;
53
55 bool flip_vertical() const;
56
58 float get_gamma() const;
59
61 Vec4i get_swizzle() const;
62
64 bool get_input_is_ycrcb() const;
65
67 bool get_output_is_ycrcb() const;
68
72 void set_premultiply_alpha(bool enable);
73
77 void set_flip_vertical(bool enable);
78
82 void set_gamma(float gamma);
83
87 void set_swizzle(int red_source, int green_source, int blue_source, int alpha_source);
88 void set_swizzle(const Vec4i &swizzle);
89
91 void set_input_is_ycrcb(bool enable);
92
94 void set_output_is_ycrcb(bool enable);
95
97 void convert(void *output, int output_pitch, TextureFormat output_format, const void *input, int input_pitch, TextureFormat input_format, int width, int height);
98
99 private:
100 std::shared_ptr<PixelConverter_Impl> impl;
101 };
102
104}
clan::PixelConverter
Low level pixel format converter class.
Definition pixel_converter.h:45
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.
clan::PixelConverter::set_input_is_ycrcb
void set_input_is_ycrcb(bool enable)
Converts from JPEG JFIF YCrCb.
clan::PixelConverter::~PixelConverter
~PixelConverter()
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::get_swizzle
Vec4i get_swizzle() const
Returns the input channel used for each output channel.
clan::PixelConverter::set_flip_vertical
void set_flip_vertical(bool enable)
Set the flip vertical setting.
clan::PixelConverter::get_gamma
float get_gamma() const
Returns the gamma setting.
clan::PixelConverter::get_output_is_ycrcb
bool get_output_is_ycrcb() const
Returns the JPEG JFIF YCrCb output setting.
clan::PixelConverter::set_premultiply_alpha
void set_premultiply_alpha(bool enable)
Set the premultiply alpha setting.
clan::PixelConverter::get_input_is_ycrcb
bool get_input_is_ycrcb() const
Returns the JPEG JFIF YCrCb input setting.
clan::PixelConverter::set_gamma
void set_gamma(float gamma)
Set the gamma applied when converting.
clan::PixelConverter::flip_vertical
bool flip_vertical() const
Returns the flip vertical setting.
clan::PixelConverter::PixelConverter
PixelConverter()
Constructs a pixel format converter.
clan::PixelConverter::get_premultiply_alpha
bool get_premultiply_alpha() const
Returns the premultiply alpha setting.
clan::PixelConverter::set_swizzle
void set_swizzle(const Vec4i &swizzle)
clan::Vec4
4D vector
Definition vec4.h:75
clan::TextureFormat
TextureFormat
Texture format.
Definition texture_format.h:39
clan
Definition clanapp.h:36