XRInterfaceExtension

Наследует: XRInterface < RefCounted < Object

Базовый класс для расширений интерфейса XR (плагинов).

Описание

Внешние плагины интерфейса XR должны наследовать от этого класса.

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

Методы

void

_end_frame() virtual

bool

_get_anchor_detection_is_enabled() virtual const

int

_get_camera_feed_id() virtual const

Transform3D

_get_camera_transform() virtual

int

_get_capabilities() virtual const

RID

_get_color_texture() virtual

RID

_get_depth_texture() virtual

StringName

_get_name() virtual const

PackedVector3Array

_get_play_area() virtual const

PlayAreaMode

_get_play_area_mode() virtual const

PackedFloat64Array

_get_projection_for_view(view: int, aspect: float, z_near: float, z_far: float) virtual

Vector2

_get_render_target_size() virtual

PackedStringArray

_get_suggested_pose_names(tracker_name: StringName) virtual const

PackedStringArray

_get_suggested_tracker_names() virtual const

Dictionary

_get_system_info() virtual const

TrackingStatus

_get_tracking_status() virtual const

Transform3D

_get_transform_for_view(view: int, cam_transform: Transform3D) virtual

RID

_get_velocity_texture() virtual

int

_get_view_count() virtual

RID

_get_vrs_texture() virtual

VRSTextureFormat

_get_vrs_texture_format() virtual

bool

_initialize() virtual

bool

_is_initialized() virtual const

void

_post_draw_viewport(render_target: RID, screen_rect: Rect2) virtual

bool

_pre_draw_viewport(render_target: RID) virtual

void

_pre_render() virtual

void

_process() virtual

void

_set_anchor_detection_is_enabled(enabled: bool) virtual

bool

_set_play_area_mode(mode: PlayAreaMode) virtual const

bool

_supports_play_area_mode(mode: PlayAreaMode) virtual const

void

_trigger_haptic_pulse(action_name: String, tracker_name: StringName, frequency: float, amplitude: float, duration_sec: float, delay_sec: float) virtual

void

_uninitialize() virtual

void

add_blit(render_target: RID, src_rect: Rect2, dst_rect: Rect2i, use_layer: bool, layer: int, apply_lens_distortion: bool, eye_center: Vector2, k1: float, k2: float, upscale: float, aspect_ratio: float)

RID

get_color_texture()

RID

get_depth_texture()

RID

get_render_target_texture(render_target: RID)

RID

get_velocity_texture()


Описания метода

void _end_frame() virtual 🔗

Вызывается, если интерфейс активен и очереди отправлены.


bool _get_anchor_detection_is_enabled() virtual const 🔗

Возвращает true, если для этого интерфейса включено обнаружение якорей.


int _get_camera_feed_id() virtual const 🔗

Возвращает идентификатор канала камеры для CameraFeed, зарегистрированного на CameraServer, который должен отображаться в качестве фона на устройстве с поддержкой дополненной реальности (если применимо).


Transform3D _get_camera_transform() virtual 🔗

Возвращает Transform3D, который позиционирует XRCamera3D в мире.


int _get_capabilities() virtual const 🔗

Возвращает возможности этого интерфейса.


RID _get_color_texture() virtual 🔗

Возвращает цветовую текстуру, в которую необходимо преобразовать ее (если применимо).


RID _get_depth_texture() virtual 🔗

Возвращает текстуру глубины, в которую следует выполнить рендеринг (если применимо).


StringName _get_name() virtual const 🔗

Возвращает имя этого интерфейса.


PackedVector3Array _get_play_area() virtual const 🔗

Возвращает PackedVector3Array, представляющий границы игровых зон (если применимо).


PlayAreaMode _get_play_area_mode() virtual const 🔗

Возвращает режим игровой зоны, который настраивает нашу игровую зону.


PackedFloat64Array _get_projection_for_view(view: int, aspect: float, z_near: float, z_far: float) virtual 🔗

Возвращает матрицу проекции для заданного вида в виде PackedFloat64Array.


Vector2 _get_render_target_size() virtual 🔗

Возвращает размер нашей цели рендеринга для этого интерфейса, он переопределяет размер Viewport, отмеченного как xr viewport.


PackedStringArray _get_suggested_pose_names(tracker_name: StringName) virtual const 🔗

Возвращает PackedStringArray с именами поз, настроенными этим интерфейсом. Обратите внимание, что конфигурация пользователя может переопределить этот список.


PackedStringArray _get_suggested_tracker_names() virtual const 🔗

Возвращает PackedStringArray с именами трекеров, настроенными этим интерфейсом. Обратите внимание, что конфигурация пользователя может переопределить этот список.


Dictionary _get_system_info() virtual const 🔗

Возвращает Dictionary с системной информацией, связанной с этим интерфейсом.


TrackingStatus _get_tracking_status() virtual const 🔗

Возвращает текущий статус отслеживания.


Transform3D _get_transform_for_view(view: int, cam_transform: Transform3D) virtual 🔗

Возвращает Transform3D для заданного вида.


RID _get_velocity_texture() virtual 🔗

Возвращает текстуру скорости, в которую нужно рендерить (если применимо).


int _get_view_count() virtual 🔗

Возвращает количество представлений, требуемых для этого интерфейса: 1 для моно, 2 для стереоскопического.


RID _get_vrs_texture() virtual 🔗

There is currently no description for this method. Please help us by contributing one!


VRSTextureFormat _get_vrs_texture_format() virtual 🔗

Возвращает формат текстуры, возвращаемой _get_vrs_texture().


bool _initialize() virtual 🔗

Инициализирует интерфейс, возвращает true в случае успеха.


bool _is_initialized() virtual const 🔗

Возвращает true, если этот интерфейс был инициализирован.


void _post_draw_viewport(render_target: RID, screen_rect: Rect2) virtual 🔗

Вызывается после завершения логики отрисовки XR Viewport.


bool _pre_draw_viewport(render_target: RID) virtual 🔗

Вызывается, если это наш основной XRInterfaceExtension перед тем, как мы начнем обрабатывать Viewport для каждого активного XR Viewport, возвращает true, если этот viewport должен быть отрисован. Интерфейс XR может вернуть false, если пользователь снял гарнитуру и мы можем приостановить отрисовку.


void _pre_render() virtual 🔗

Вызывается, если этот XRInterfaceExtension активен до начала рендеринга. Большинство интерфейсов XR синхронизируют отслеживание в этот момент времени.


void _process() virtual 🔗

Вызывается, если этот XRInterfaceExtension активен до того, как вызывается наш физический и игровой процесс. Большинство интерфейсов XR обновят свои XRPositionalTracker в этот момент времени.


void _set_anchor_detection_is_enabled(enabled: bool) virtual 🔗

Включает обнаружение якорей на этом интерфейсе, если поддерживается.


bool _set_play_area_mode(mode: PlayAreaMode) virtual const 🔗

Установите режим игровой зоны для этого интерфейса.


bool _supports_play_area_mode(mode: PlayAreaMode) virtual const 🔗

Возвращает true, если этот интерфейс поддерживает этот режим игровой зоны.


void _trigger_haptic_pulse(action_name: String, tracker_name: StringName, frequency: float, amplitude: float, duration_sec: float, delay_sec: float) virtual 🔗

Запускает тактильный импульс, отправляемый на указанный трекер.


void _uninitialize() virtual 🔗

Разблокировать интерфейс.


void add_blit(render_target: RID, src_rect: Rect2, dst_rect: Rect2i, use_layer: bool, layer: int, apply_lens_distortion: bool, eye_center: Vector2, k1: float, k2: float, upscale: float, aspect_ratio: float) 🔗

Выводит наши результаты рендеринга на экран, опционально применяя искажение линзы. Это можно вызвать только во время обработки _commit_views.


RID get_color_texture() 🔗

There is currently no description for this method. Please help us by contributing one!


RID get_depth_texture() 🔗

There is currently no description for this method. Please help us by contributing one!


RID get_render_target_texture(render_target: RID) 🔗

Возвращает допустимый RID для текстуры, в которую следует отрисовать текущий кадр, если это поддерживается интерфейсом.


RID get_velocity_texture() 🔗

There is currently no description for this method. Please help us by contributing one!