blend_state_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 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "graphic_context.h"
33 
34 namespace clan
35 {
38 
39 class BlendStateDescription_Impl;
40 
43 {
46 public:
49 
50  static BlendStateDescription blend(bool src_premultiplied, bool dest_premultiplied = true);
52 
54 
57 public:
58  bool is_blending_enabled() const;
59  void get_blend_equation(BlendEquation &out_color, BlendEquation &out_alpha) const;
60  void get_blend_function(BlendFunc &out_src, BlendFunc &out_dest, BlendFunc &out_src_alpha, BlendFunc &out_dest_alpha) const;
61  void get_color_write(bool &out_red, bool &out_green, bool &out_blue, bool &out_alpha) const;
62  bool is_logic_op_enabled() const;
64 
66 
69 public:
71  void enable_blending(bool value);
72 
75 
77  void set_blend_function(BlendFunc src, BlendFunc dest, BlendFunc src_alpha, BlendFunc dest_alpha);
78 
80  void enable_color_write(bool red, bool green, bool blue, bool alpha);
81 
83  void enable_logic_op(bool enabled);
84 
87 
89 
90  bool operator==(const BlendStateDescription &other) const;
91  bool operator<(const BlendStateDescription &other) const;
92 
95 private:
96  std::shared_ptr<BlendStateDescription_Impl> impl;
98 };
99 
100 }
101 
LogicOp get_logic_op() const
BlendEquation
Blending equations.
Definition: graphic_context.h:204
Blend state description.
Definition: blend_state_description.h:43
bool is_logic_op_enabled() const
void set_logic_op(LogicOp op)
Set logic operation. (clanGL only)
void enable_color_write(bool red, bool green, bool blue, bool alpha)
Enable/disable writing to the color buffer.
void get_blend_equation(BlendEquation &out_color, BlendEquation &out_alpha) const
static BlendStateDescription opaque()
BlendFunc
Blending functions.
Definition: graphic_context.h:155
void get_blend_function(BlendFunc &out_src, BlendFunc &out_dest, BlendFunc &out_src_alpha, BlendFunc &out_dest_alpha) const
bool is_blending_enabled() const
Definition: clanapp.h:36
void set_blend_function(BlendFunc src, BlendFunc dest, BlendFunc src_alpha, BlendFunc dest_alpha)
Set the blend functions.
void get_color_write(bool &out_red, bool &out_green, bool &out_blue, bool &out_alpha) const
BlendStateDescription clone() const
bool operator<(const BlendStateDescription &other) const
void enable_blending(bool value)
Enable/Disable blending.
bool operator==(const BlendStateDescription &other) const
LogicOp
Logic Op.
Definition: graphic_context.h:134
void set_blend_equation(BlendEquation color, BlendEquation alpha)
Set the constant color used in the blend equations.
void enable_logic_op(bool enabled)
Enable/disable logic op. (clanGL only)
static BlendStateDescription blend(bool src_premultiplied, bool dest_premultiplied=true)