depth_stencil_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 DepthStencilStateDescription_Impl;
40
42 class DepthStencilStateDescription
43 {
46 public:
47 DepthStencilStateDescription();
48 DepthStencilStateDescription clone() const;
50
53 public:
54 bool is_stencil_test_enabled() const;
55 void get_stencil_compare_front(CompareFunction &out_front, int &out_front_ref, int &out_front_mask) const;
56 void get_stencil_compare_back(CompareFunction &out_back, int &out_back_ref, int &out_back_mask) const;
57 void get_stencil_write_mask(unsigned char &out_front_facing_mask, unsigned char &out_back_facing_mask) const;
58 void get_stencil_op_front(StencilOp &out_fail_front, StencilOp &out_pass_depth_fail_front, StencilOp &out_pass_depth_pass_front) const;
59 void get_stencil_op_back(StencilOp &out_fail_back, StencilOp &out_pass_depth_fail_back, StencilOp &out_pass_depth_pass_back) const;
60
61 bool is_depth_test_enabled() const;
62 bool is_depth_write_enabled() const;
63 CompareFunction get_depth_compare_function() const;
65
68 public:
70 void enable_stencil_test(bool enabled);
71
73 void set_stencil_compare_front(CompareFunction front, int front_ref, int front_mask);
74
76 void set_stencil_compare_back(CompareFunction back, int back_ref, int back_mask);
77
79 void set_stencil_write_mask(unsigned char front_facing_mask, unsigned char back_facing_mask);
80
86 void set_stencil_op_front(StencilOp fail_front, StencilOp pass_depth_fail_front, StencilOp pass_depth_pass_front);
87
93 void set_stencil_op_back(StencilOp fail_back, StencilOp pass_depth_fail_back, StencilOp pass_depth_pass_back);
94
96 void enable_depth_test(bool enabled);
97
99 void enable_depth_write(bool enabled);
100
102 void set_depth_compare_function(CompareFunction func);
104
105 bool operator==(const DepthStencilStateDescription &other) const;
106 bool operator<(const DepthStencilStateDescription &other) const;
107
110 private:
111 std::shared_ptr<DepthStencilStateDescription_Impl> impl;
113 };
114
115 }
116
clan
Definition: clanapp.h:35
clan::DepthStencilStateDescription::enable_depth_write
void enable_depth_write(bool enabled)
Enables/disables depth writing.
clan::DepthStencilStateDescription::set_stencil_op_back
void set_stencil_op_back(StencilOp fail_back, StencilOp pass_depth_fail_back, StencilOp pass_depth_pass_back)
Set stencil operations.
clan::DepthStencilStateDescription::set_stencil_compare_front
void set_stencil_compare_front(CompareFunction front, int front_ref, int front_mask)
Set stencil compare function.
clan::DepthStencilStateDescription::is_stencil_test_enabled
bool is_stencil_test_enabled() const
clan::DepthStencilStateDescription::set_depth_compare_function
void set_depth_compare_function(CompareFunction func)
Set depth test function.
clan::DepthStencilStateDescription::operator==
bool operator==(const DepthStencilStateDescription &other) const
clan::DepthStencilStateDescription::get_stencil_op_front
void get_stencil_op_front(StencilOp &out_fail_front, StencilOp &out_pass_depth_fail_front, StencilOp &out_pass_depth_pass_front) const
clan::DepthStencilStateDescription::operator<
bool operator<(const DepthStencilStateDescription &other) const
clan::DepthStencilStateDescription::get_stencil_compare_front
void get_stencil_compare_front(CompareFunction &out_front, int &out_front_ref, int &out_front_mask) const
clan::DepthStencilStateDescription::DepthStencilStateDescription
DepthStencilStateDescription()
clan::StencilOp
StencilOp
Stencil operations.
Definition: graphic_context.h:105
clan::DepthStencilStateDescription::get_depth_compare_function
CompareFunction get_depth_compare_function() const
clan::DepthStencilStateDescription::get_stencil_compare_back
void get_stencil_compare_back(CompareFunction &out_back, int &out_back_ref, int &out_back_mask) const
clan::DepthStencilStateDescription::set_stencil_compare_back
void set_stencil_compare_back(CompareFunction back, int back_ref, int back_mask)
Set stencil compare function.
clan::DepthStencilStateDescription::clone
DepthStencilStateDescription clone() const
clan::DepthStencilStateDescription::is_depth_test_enabled
bool is_depth_test_enabled() const
clan::DepthStencilStateDescription::enable_depth_test
void enable_depth_test(bool enabled)
Enables/disables depth testing.
clan::DepthStencilStateDescription::get_stencil_write_mask
void get_stencil_write_mask(unsigned char &out_front_facing_mask, unsigned char &out_back_facing_mask) const
clan::DepthStencilStateDescription
DepthStencil state description.
Definition: depth_stencil_state_description.h:42
clan::CompareFunction
CompareFunction
Compare functions.
Definition: graphic_context.h:92
clan::DepthStencilStateDescription::enable_stencil_test
void enable_stencil_test(bool enabled)
Enables/disables stencil testing.
clan::DepthStencilStateDescription::set_stencil_write_mask
void set_stencil_write_mask(unsigned char front_facing_mask, unsigned char back_facing_mask)
Set stencil write masks.
clan::DepthStencilStateDescription::get_stencil_op_back
void get_stencil_op_back(StencilOp &out_fail_back, StencilOp &out_pass_depth_fail_back, StencilOp &out_pass_depth_pass_back) const
clan::DepthStencilStateDescription::set_stencil_op_front
void set_stencil_op_front(StencilOp fail_front, StencilOp pass_depth_fail_front, StencilOp pass_depth_pass_front)
Set stencil operations.
clan::DepthStencilStateDescription::is_depth_write_enabled
bool is_depth_write_enabled() const