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...

SubViewport

Наследует: Viewport < Node < Object

Интерфейс к игровому миру, который не создает окно и не выводит изображение на экран напрямую.

Описание

SubViewport Изолирует прямоугольную область сцены для независимого отображения. Это можно использовать, например, для отображения пользовательского интерфейса в трехмерном пространстве.

Примечание: SubViewport — это Viewport, который не является Window, т. е. он сам по себе ничего не рисует. Чтобы что-либо отобразить, SubViewport должен иметь ненулевой размер и быть либо помещен в SubViewportContainer, либо назначен ViewportTexture.

Примечание: InputEvent по умолчанию не передаются в автономный SubViewport. Чтобы обеспечить распространение InputEvent, SubViewport можно поместить внутрь SubViewportContainer.

Обучающие материалы

• Использовать Viewports

• Преобразования области просмотра и холста

• Демонстрация графического интерфейса пользователя в 3D-окне просмотра

• Демонстрация 3D в 2D-виде

• Демонстрация 2D в 3D-виде

• Демо-версия захвата экрана

• Демонстрация динамического разделения экрана

• Демонстрация масштабирования 3D-разрешения

Свойства

ClearMode	render_target_clear_mode	0
UpdateMode	render_target_update_mode	2
Vector2i	size	Vector2i(512, 512)
Vector2i	size_2d_override	Vector2i(0, 0)
bool	size_2d_override_stretch	false
int	view_count	1

---

Перечисления

enum ClearMode: 🔗

ClearMode CLEAR_MODE_ALWAYS = 0

Всегда очищайте цель рендеринга перед рисованием.

ClearMode CLEAR_MODE_NEVER = 1

Никогда не очищайте цель рендеринга.

ClearMode CLEAR_MODE_ONCE = 2

Очистите цель рендеринга на следующем кадре, затем переключитесь на CLEAR_MODE_NEVER.

---

enum UpdateMode: 🔗

UpdateMode UPDATE_DISABLED = 0

Не обновляйте цель рендеринга.

UpdateMode UPDATE_ONCE = 1

Обновите цель рендеринга один раз, затем переключитесь на UPDATE_DISABLED.

UpdateMode UPDATE_WHEN_VISIBLE = 2

Обновлять цель рендеринга только тогда, когда он виден. Это значение по умолчанию.

UpdateMode UPDATE_WHEN_PARENT_VISIBLE = 3

Обновляйте цель рендеринга только тогда, когда его родительский объект виден.

UpdateMode UPDATE_ALWAYS = 4

Всегда обновляйте цель рендеринга.

---

Описания свойств

ClearMode render_target_clear_mode = 0 🔗

• void set_clear_mode(value: ClearMode)

• ClearMode get_clear_mode()

Режим очистки, когда в качестве цели рендеринга используется подокно просмотра.

Примечание: Это свойство предназначено для использования в 2D.

---

UpdateMode render_target_update_mode = 2 🔗

• void set_update_mode(value: UpdateMode)

• UpdateMode get_update_mode()

Режим обновления, когда в качестве цели рендеринга используется подокно просмотра.

---

Vector2i size = Vector2i(512, 512) 🔗

• void set_size(value: Vector2i)

• Vector2i get_size()

Ширина и высота подокна просмотра. Должны быть установлены на значение больше или равное 2 пикселям в обоих сторонах. В противном случае ничего не будет отображено.

Примечание: Если родительский узел — SubViewportContainer, а его SubViewportContainer.stretch — true, размер окна просмотра нельзя изменить вручную.

---

Vector2i size_2d_override = Vector2i(0, 0) 🔗

• void set_size_2d_override(value: Vector2i)

• Vector2i get_size_2d_override()

Переопределение размера 2D подокна просмотра. Если ширина или высота равна 0, переопределение отключено.

---

bool size_2d_override_stretch = false 🔗

• void set_size_2d_override_stretch(value: bool)

• bool is_size_2d_override_stretch_enabled()

Если true, переопределение размера 2D также влияет на растяжение.

---

int view_count = 1 🔗

• void set_view_count(value: int)

• int get_view_count()

The number of view layers we are rendering to. Set this to 2 to enable stereo rendering.