RDPipelineDepthStencilState

继承： RefCounted < Object

管道深度/模板状态（由RenderingDevice使用）。

描述

RDPipelineDepthStencilState控制使用RenderingDevice对这些值进行采样时执行深度和模板比较的方式。

属性

CompareOperator	back_op_compare	7
int	back_op_compare_mask	0
StencilOperation	back_op_depth_fail	1
StencilOperation	back_op_fail	1
StencilOperation	back_op_pass	1
int	back_op_reference	0
int	back_op_write_mask	0
CompareOperator	depth_compare_operator	7
float	depth_range_max	0.0
float	depth_range_min	0.0
bool	enable_depth_range	false
bool	enable_depth_test	false
bool	enable_depth_write	false
bool	enable_stencil	false
CompareOperator	front_op_compare	7
int	front_op_compare_mask	0
StencilOperation	front_op_depth_fail	1
StencilOperation	front_op_fail	1
StencilOperation	front_op_pass	1
int	front_op_reference	0
int	front_op_write_mask	0

---

属性说明

CompareOperator back_op_compare = 7 🔗

• void set_back_op_compare(value: CompareOperator)

• CompareOperator get_back_op_compare()

用于比较以前的背面模板值和back_op_reference的方法。

---

int back_op_compare_mask = 0 🔗

• void set_back_op_compare_mask(value: int)

• int get_back_op_compare_mask()

选择将比较背面模板值中的哪些位。

---

StencilOperation back_op_depth_fail = 1 🔗

• void set_back_op_depth_fail(value: StencilOperation)

• StencilOperation get_back_op_depth_fail()

对通过模板测试但未通过深度测试的后像素在模板缓冲区上执行的操作。

---

StencilOperation back_op_fail = 1 🔗

• void set_back_op_fail(value: StencilOperation)

• StencilOperation get_back_op_fail()

对未通过模板测试的后像素在模板缓冲区上执行的操作。

---

StencilOperation back_op_pass = 1 🔗

• void set_back_op_pass(value: StencilOperation)

• StencilOperation get_back_op_pass()

对通过模板测试的后像素在模板缓冲区上执行的操作。

---

int back_op_reference = 0 🔗

• void set_back_op_reference(value: int)

• int get_back_op_reference()

将与前一个背面模板值进行比较的值。

---

int back_op_write_mask = 0 🔗

• void set_back_op_write_mask(value: int)

• int get_back_op_write_mask()

从背面模板值中选择哪些位将被更改。

---

CompareOperator depth_compare_operator = 7 🔗

• void set_depth_compare_operator(value: CompareOperator)

• CompareOperator get_depth_compare_operator()

用于比较先前和当前深度值的方法。

---

float depth_range_max = 0.0 🔗

• void set_depth_range_max(value: float)

• float get_depth_range_max()

enable_depth_range返回true的最大深度。

---

float depth_range_min = 0.0 🔗

• void set_depth_range_min(value: float)

• float get_depth_range_min()

enable_depth_range返回true的最小深度。

---

bool enable_depth_range = false 🔗

• void set_enable_depth_range(value: bool)

• bool get_enable_depth_range()

如果true，将测试每个深度值，看它是否在depth_range_min和depth_range_max之间，如果在这些值之外，则丢弃。

---

bool enable_depth_test = false 🔗

• void set_enable_depth_test(value: bool)

• bool get_enable_depth_test()

如果true，则启用深度测试，允许对象根据其深度自动被其他对象遮挡。这也允许对象被其他对象部分遮挡。如果false，对象将按绘制顺序出现（如在i3D的2D渲染器中）。

---

bool enable_depth_write = false 🔗

• void set_enable_depth_write(value: bool)

• bool get_enable_depth_write()

如果true，则在深度测试返回true时写入深度缓冲区。仅当enable_depth_test也是true时才有效。

---

bool enable_stencil = false 🔗

• void set_enable_stencil(value: bool)

• bool get_enable_stencil()

如果true，则启用模板测试。正面三角形和背面三角形有单独的模板缓冲区。请参阅以“front_op”开头的属性和每个以“back_op”开头的属性。

---

CompareOperator front_op_compare = 7 🔗

• void set_front_op_compare(value: CompareOperator)

• CompareOperator get_front_op_compare()

用于比较前模板值和front_op_reference的方法。

---

int front_op_compare_mask = 0 🔗

• void set_front_op_compare_mask(value: int)

• int get_front_op_compare_mask()

选择将比较前模板值中的哪些位。

---

StencilOperation front_op_depth_fail = 1 🔗

• void set_front_op_depth_fail(value: StencilOperation)

• StencilOperation get_front_op_depth_fail()

对通过模板测试但未通过深度测试的前像素在模板缓冲区上执行的操作。

---

StencilOperation front_op_fail = 1 🔗

• void set_front_op_fail(value: StencilOperation)

• StencilOperation get_front_op_fail()

对未通过模板测试的前像素在模板缓冲区上执行的操作。

---

StencilOperation front_op_pass = 1 🔗

• void set_front_op_pass(value: StencilOperation)

• StencilOperation get_front_op_pass()

对通过模板测试的前像素在模板缓冲区上执行的操作。

---

int front_op_reference = 0 🔗

• void set_front_op_reference(value: int)

• int get_front_op_reference()

将与前一个模板值进行比较的值。

---

int front_op_write_mask = 0 🔗

• void set_front_op_write_mask(value: int)

• int get_front_op_write_mask()

选择将更改前模板值中的哪些位。