depth_stencil_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 DepthStencilStateDescription_Impl;
41 
43 class CL_API_DISPLAY DepthStencilStateDescription
44 {
47 public:
49  DepthStencilStateDescription clone() const;
51 
54 public:
55  bool is_stencil_test_enabled() const;
56  void get_stencil_compare_front(CompareFunction &out_front, int &out_front_ref, int &out_front_mask) const;
57  void get_stencil_compare_back(CompareFunction &out_back, int &out_back_ref, int &out_back_mask) const;
58  void get_stencil_write_mask(unsigned char &out_front_facing_mask, unsigned char &out_back_facing_mask) const;
59  void get_stencil_op_front(StencilOp &out_fail_front, StencilOp &out_pass_depth_fail_front, StencilOp &out_pass_depth_pass_front) const;
60  void get_stencil_op_back(StencilOp &out_fail_back, StencilOp &out_pass_depth_fail_back, StencilOp &out_pass_depth_pass_back) const;
61 
62  bool is_depth_test_enabled() const;
63  bool is_depth_write_enabled() const;
64  CompareFunction get_depth_compare_function() const;
66 
69 public:
71  void enable_stencil_test(bool enabled);
72 
74  void set_stencil_compare_front(CompareFunction front, int front_ref, int front_mask);
75 
77  void set_stencil_compare_back(CompareFunction back, int back_ref, int back_mask);
78 
80  void set_stencil_write_mask(unsigned char front_facing_mask, unsigned char back_facing_mask);
81 
87  void set_stencil_op_front(StencilOp fail_front, StencilOp pass_depth_fail_front, StencilOp pass_depth_pass_front);
88 
94  void set_stencil_op_back(StencilOp fail_back, StencilOp pass_depth_fail_back, StencilOp pass_depth_pass_back);
95 
97  void enable_depth_test(bool enabled);
98 
100  void enable_depth_write(bool enabled);
101 
103  void set_depth_compare_function(CompareFunction func);
105 
106  bool operator==(const DepthStencilStateDescription &other) const;
107  bool operator<(const DepthStencilStateDescription &other) const;
108 
111 private:
112  std::shared_ptr<DepthStencilStateDescription_Impl> impl;
114 };
115 
116 }
117 
StencilOp
Stencil operations.
Definition: graphic_context.h:106
DepthStencil state description.
Definition: depth_stencil_state_description.h:43
CompareFunction
Compare functions.
Definition: graphic_context.h:93