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

blend_state_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** Magnus Norddahl
27*/
28
29#pragma once
30
31#include "graphic_context.h"
32
33namespace clan
34{
37
38 class BlendStateDescription_Impl;
39
41 class BlendStateDescription
42 {
43 public:
44 BlendStateDescription();
45 BlendStateDescription clone() const;
46
47 static BlendStateDescription blend(bool src_premultiplied, bool dest_premultiplied = true);
48 static BlendStateDescription opaque();
49
50 bool is_blending_enabled() const;
51 void get_blend_equation(BlendEquation &out_color, BlendEquation &out_alpha) const;
52 void get_blend_function(BlendFunc &out_src, BlendFunc &out_dest, BlendFunc &out_src_alpha, BlendFunc &out_dest_alpha) const;
53 void get_color_write(bool &out_red, bool &out_green, bool &out_blue, bool &out_alpha) const;
54 bool is_logic_op_enabled() const;
55 LogicOp get_logic_op() const;
56
58 void enable_blending(bool value);
59
61 void set_blend_equation(BlendEquation color, BlendEquation alpha);
62
64 void set_blend_function(BlendFunc src, BlendFunc dest, BlendFunc src_alpha, BlendFunc dest_alpha);
65
67 void enable_color_write(bool red, bool green, bool blue, bool alpha);
68
70 void enable_logic_op(bool enabled);
71
73 void set_logic_op(LogicOp op);
74
75 bool operator==(const BlendStateDescription &other) const;
76 bool operator<(const BlendStateDescription &other) const;
77
78 private:
79 std::shared_ptr<BlendStateDescription_Impl> impl;
80 };
81
83}
clan::BlendStateDescription::is_logic_op_enabled
bool is_logic_op_enabled() const
clan::BlendStateDescription::clone
BlendStateDescription clone() const
clan::BlendStateDescription::enable_blending
void enable_blending(bool value)
Enable/Disable blending.
clan::BlendStateDescription::is_blending_enabled
bool is_blending_enabled() const
clan::BlendStateDescription::opaque
static BlendStateDescription opaque()
clan::BlendStateDescription::set_blend_function
void set_blend_function(BlendFunc src, BlendFunc dest, BlendFunc src_alpha, BlendFunc dest_alpha)
Set the blend functions.
clan::BlendStateDescription::enable_color_write
void enable_color_write(bool red, bool green, bool blue, bool alpha)
Enable/disable writing to the color buffer.
clan::BlendStateDescription::operator<
bool operator<(const BlendStateDescription &other) const
clan::BlendStateDescription::blend
static BlendStateDescription blend(bool src_premultiplied, bool dest_premultiplied=true)
clan::BlendStateDescription::set_logic_op
void set_logic_op(LogicOp op)
Set logic operation. (clanGL only)
clan::BlendStateDescription::get_blend_equation
void get_blend_equation(BlendEquation &out_color, BlendEquation &out_alpha) const
clan::BlendStateDescription::enable_logic_op
void enable_logic_op(bool enabled)
Enable/disable logic op. (clanGL only)
clan::BlendStateDescription::set_blend_equation
void set_blend_equation(BlendEquation color, BlendEquation alpha)
Set the constant color used in the blend equations.
clan::BlendStateDescription::get_blend_function
void get_blend_function(BlendFunc &out_src, BlendFunc &out_dest, BlendFunc &out_src_alpha, BlendFunc &out_dest_alpha) const
clan::BlendStateDescription::get_logic_op
LogicOp get_logic_op() const
clan::BlendStateDescription::BlendStateDescription
BlendStateDescription()
clan::BlendStateDescription::operator==
bool operator==(const BlendStateDescription &other) const
clan::BlendStateDescription::get_color_write
void get_color_write(bool &out_red, bool &out_green, bool &out_blue, bool &out_alpha) const
clan::BlendFunc
BlendFunc
Blending functions.
Definition graphic_context.h:154
clan::LogicOp
LogicOp
Logic Op.
Definition graphic_context.h:133
clan::BlendEquation
BlendEquation
Blending equations.
Definition graphic_context.h:203
clan::BlendFunc::dest_alpha
@ dest_alpha
source or destination (Ad, Ad, Ad, Ad)
Definition graphic_context.h:180
clan::BlendFunc::src_alpha
@ src_alpha
source or destination (As, As, As, As)
Definition graphic_context.h:174
clan
Definition clanapp.h:36
clan::StyleValueType::color
@ color
value is an url
Definition style_value_type.h:43