Index · Object → RefCounted → RDPipelineDepthStencilState

RDPipelineDepthStencilState

Pipeline depth/stencil state (used by RenderingDevice).

Class Description

RDPipelineDepthStencilState controls the way depth and stencil comparisons are performed when sampling those values using RenderingDevice.

Properties

var back_op_compare: RenderingDevice.CompareOperator = 7

The method used for comparing the previous back stencil value and back_op_reference.

var back_op_compare_mask: int = 0

Selects which bits from the back stencil value will be compared.

var back_op_depth_fail: RenderingDevice.StencilOperation = 1

The operation to perform on the stencil buffer for back pixels that pass the stencil test but fail the depth test.

var back_op_fail: RenderingDevice.StencilOperation = 1

The operation to perform on the stencil buffer for back pixels that fail the stencil test.

var back_op_pass: RenderingDevice.StencilOperation = 1

The operation to perform on the stencil buffer for back pixels that pass the stencil test.

var back_op_reference: int = 0

The value the previous back stencil value will be compared to.

var back_op_write_mask: int = 0

Selects which bits from the back stencil value will be changed.

var depth_compare_operator: RenderingDevice.CompareOperator = 7

The method used for comparing the previous and current depth values.

var depth_range_max: float = 0.0

The maximum depth that returns true for enable_depth_range.

var depth_range_min: float = 0.0

The minimum depth that returns true for enable_depth_range.

var enable_depth_range: bool = false

If true, each depth value will be tested to see if it is between depth_range_min and depth_range_max. If it is outside of these values, it is discarded.

var enable_depth_test: bool = false

If true, enables depth testing which allows objects to be automatically occluded by other objects based on their depth. This also allows objects to be partially occluded by other objects. If false, objects will appear in the order they were drawn (like in Godot's 2D renderer).

var enable_depth_write: bool = false

If true, writes to the depth buffer whenever the depth test returns true. Only works when enable_depth_test is also true.

var enable_stencil: bool = false

If true, enables stencil testing. There are separate stencil buffers for front-facing triangles and back-facing triangles. See properties that begin with "front_op" and properties with "back_op" for each.

var front_op_compare: RenderingDevice.CompareOperator = 7

The method used for comparing the previous front stencil value and front_op_reference.

var front_op_compare_mask: int = 0

Selects which bits from the front stencil value will be compared.

var front_op_depth_fail: RenderingDevice.StencilOperation = 1

The operation to perform on the stencil buffer for front pixels that pass the stencil test but fail the depth test.

var front_op_fail: RenderingDevice.StencilOperation = 1

The operation to perform on the stencil buffer for front pixels that fail the stencil test.

var front_op_pass: RenderingDevice.StencilOperation = 1

The operation to perform on the stencil buffer for front pixels that pass the stencil test.

var front_op_reference: int = 0

The value the previous front stencil value will be compared to.

var front_op_write_mask: int = 0

Selects which bits from the front stencil value will be changed.

Methods

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)