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

ViewportTexture

Успадковує: Texture2D < Texture < Resource < RefCounted < Object

Забезпечує вміст Перегляд як динамічної текстури.

Опис

ViewportTexture надає вміст Viewport як динамічний Texture2D. Це можна використовувати для поєднання рендерингу вузлів Control, Node2D та Node3D. Наприклад, ви можете використовувати цю текстуру для відображення 3D-сцени всередині TextureRect або 2D-накладання в Sprite3D.

Щоб отримати ViewportTexture в коді, використовуйте метод Viewport.get_texture() на цільовому вікні перегляду.

Примітка: ViewportTexture завжди є локальним для своєї сцени (див. Resource.resource_local_to_scene). Якщо корінь сцени не готовий, він може повертати неправильні дані (див. Node.ready).

Примітка: Створення екземплярів сцен, що містять ViewportTexture з високою роздільною здатністю, може спричинити помітне заїкання.

Примітка: Під час використання Viewport зі значенням Viewport.use_hdr_2d, встановленим на true, повернена текстура буде HDR-зображенням, яке використовує лінійне кодування. Воно може виглядати темнішим, ніж зазвичай, коли відображається безпосередньо на екрані. Щоб перетворити на нелінійне кодування sRGB, ви можете зробити наступне:

img.convert(Image.FORMAT_RGBA8)
img.linear_to_srgb()

Примітка: Деякі вузли, такі як Decal, Light3D та PointLight2D, не підтримують безпосереднє використання ViewportTexture. Щоб використовувати дані текстури з ViewportTexture у цих вузлах, вам потрібно створити ImageTexture, викликавши Texture2D.get_image() на ViewportTexture та передавши результат до ImageTexture.create_from_image(). Це перетворення є повільною операцією, тому його не слід виконувати кожного кадру.

Посібники

Властивості

NodePath

viewport_path

NodePath("")

Описи властивостей

NodePath viewport_path = NodePath("") 🔗

void set_viewport_path_in_scene(value: NodePath)
NodePath get_viewport_path_in_scene()

Шлях до вершини Viewport для відображення. Це відносно кореня локальної сцени (див. Resource.get_local_scene()), not до вузлів, які використовують цю текстуру.

Примітка: У редакторі цей шлях автоматично оновлюється, коли цільовий порт або один з його предків перейменований або переміщений. У режимі runtime цей шлях не може автоматично оновлюватися, якщо корінь сцени не знайдено.