blend_state_description.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 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 "../api_display.h"
33 #include "graphic_context.h"
34 
35 namespace clan
36 {
39 
40 class BlendStateDescription_Impl;
41 
43 class CL_API_DISPLAY BlendStateDescription
44 {
47 public:
49  BlendStateDescription clone() const;
51 
54 public:
55  bool is_blending_enabled() const;
56  void get_blend_equation(BlendEquation &out_color, BlendEquation &out_alpha) const;
57  void get_blend_function(BlendFunc &out_src, BlendFunc &out_dest, BlendFunc &out_src_alpha, BlendFunc &out_dest_alpha) const;
58  void get_color_write(bool &out_red, bool &out_green, bool &out_blue, bool &out_alpha) const;
59  bool is_logic_op_enabled() const;
60  LogicOp get_logic_op() const;
61 
63 
66 public:
68  void enable_blending(bool value);
69 
71  void set_blend_equation(BlendEquation color, BlendEquation alpha);
72 
74  void set_blend_function(BlendFunc src, BlendFunc dest, BlendFunc src_alpha, BlendFunc dest_alpha);
75 
77  void enable_color_write(bool red, bool green, bool blue, bool alpha);
78 
80  void enable_logic_op(bool enabled);
81 
83  void set_logic_op(LogicOp op);
84 
86 
87  bool operator==(const BlendStateDescription &other) const;
88  bool operator<(const BlendStateDescription &other) const;
89 
92 private:
93  std::shared_ptr<BlendStateDescription_Impl> impl;
95 };
96 
97 }
98 
Blend state description.
Definition: blend_state_description.h:43
BlendEquation
Blending equations.
Definition: graphic_context.h:204
BlendFunc
Blending functions.
Definition: graphic_context.h:155
LogicOp
Logic Op.
Definition: graphic_context.h:134