Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

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 🔗

Метод, используемый для сравнения предыдущего значения обратного трафарета и 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 🔗

Операция, выполняемая над буфером трафарета для пикселей заднего плана, которые прошли тест трафарета, но не прошли тест глубины.

StencilOperation back_op_fail = 1 🔗

Операция, выполняемая над буфером трафарета для пикселей заднего плана, не прошедших тест трафарета.

StencilOperation back_op_pass = 1 🔗

Операция, выполняемая над буфером трафарета для пикселей заднего плана, прошедших тест трафарета.

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 🔗

Метод, используемый для сравнения предыдущих и текущих значений глубины.

float depth_range_max = 0.0 🔗

  • void set_depth_range_max(value: float)

  • float get_depth_range_max()

Максимальная глубина, которая возвращает true для enable_depth_range.

float depth_range_min = 0.0 🔗

  • void set_depth_range_min(value: float)

  • float get_depth_range_min()

Минимальная глубина, которая возвращает true для enable_depth_range.

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, объекты будут отображаться в том порядке, в котором они были нарисованы (как в 2D-рендере Godot).

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 🔗

Метод, используемый для сравнения предыдущего значения трафарета front и 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 🔗

Операция, выполняемая над буфером трафарета для передних пикселей, которые прошли тест трафарета, но не прошли тест глубины.

StencilOperation front_op_fail = 1 🔗

Операция, выполняемая над буфером трафарета для передних пикселей, не прошедших тест трафарета.

StencilOperation front_op_pass = 1 🔗

Операция, выполняемая над буфером трафарета для передних пикселей, прошедших тест трафарета.

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()

Выбирает, какие биты из значения переднего трафарета будут изменены.