summaryrefslogtreecommitdiff
path: root/doc/classes/XRInterfaceExtension.xml
blob: 4328488cedc351b486e18db6e75eeb26e6472e9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<?xml version="1.0" encoding="UTF-8" ?>
<class name="XRInterfaceExtension" inherits="XRInterface" version="4.0">
	<brief_description>
		Base class for XR interface extensions (plugins).
	</brief_description>
	<description>
		External XR interface plugins should inherit from this class.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="_commit_views" qualifiers="virtual">
			<return type="void" />
			<argument index="0" name="render_target" type="RID" />
			<argument index="1" name="screen_rect" type="Rect2" />
			<description>
			</description>
		</method>
		<method name="_get_anchor_detection_is_enabled" qualifiers="virtual const">
			<return type="bool" />
			<description>
			</description>
		</method>
		<method name="_get_camera_feed_id" qualifiers="virtual const">
			<return type="int" />
			<description>
			</description>
		</method>
		<method name="_get_camera_transform" qualifiers="virtual">
			<return type="Transform3D" />
			<description>
			</description>
		</method>
		<method name="_get_capabilities" qualifiers="virtual const">
			<return type="int" />
			<description>
			</description>
		</method>
		<method name="_get_name" qualifiers="virtual const">
			<return type="StringName" />
			<description>
			</description>
		</method>
		<method name="_get_projection_for_view" qualifiers="virtual">
			<return type="PackedFloat64Array" />
			<argument index="0" name="view" type="int" />
			<argument index="1" name="aspect" type="float" />
			<argument index="2" name="z_near" type="float" />
			<argument index="3" name="z_far" type="float" />
			<description>
			</description>
		</method>
		<method name="_get_render_target_size" qualifiers="virtual">
			<return type="Vector2" />
			<description>
			</description>
		</method>
		<method name="_get_suggested_pose_names" qualifiers="virtual const">
			<return type="PackedStringArray" />
			<argument index="0" name="tracker_name" type="StringName" />
			<description>
			</description>
		</method>
		<method name="_get_suggested_tracker_names" qualifiers="virtual const">
			<return type="PackedStringArray" />
			<description>
			</description>
		</method>
		<method name="_get_tracking_status" qualifiers="virtual const">
			<return type="int" />
			<description>
			</description>
		</method>
		<method name="_get_transform_for_view" qualifiers="virtual">
			<return type="Transform3D" />
			<argument index="0" name="view" type="int" />
			<argument index="1" name="cam_transform" type="Transform3D" />
			<description>
			</description>
		</method>
		<method name="_get_view_count" qualifiers="virtual">
			<return type="int" />
			<description>
			</description>
		</method>
		<method name="_initialize" qualifiers="virtual">
			<return type="bool" />
			<description>
			</description>
		</method>
		<method name="_is_initialized" qualifiers="virtual const">
			<return type="bool" />
			<description>
			</description>
		</method>
		<method name="_notification" qualifiers="virtual">
			<return type="void" />
			<argument index="0" name="what" type="int" />
			<description>
			</description>
		</method>
		<method name="_process" qualifiers="virtual">
			<return type="void" />
			<description>
			</description>
		</method>
		<method name="_set_anchor_detection_is_enabled" qualifiers="virtual">
			<return type="void" />
			<argument index="0" name="enabled" type="bool" />
			<description>
			</description>
		</method>
		<method name="_trigger_haptic_pulse" qualifiers="virtual">
			<return type="void" />
			<argument index="0" name="action_name" type="String" />
			<argument index="1" name="tracker_name" type="StringName" />
			<argument index="2" name="frequency" type="float" />
			<argument index="3" name="amplitude" type="float" />
			<argument index="4" name="duration_sec" type="float" />
			<argument index="5" name="delay_sec" type="float" />
			<description>
			</description>
		</method>
		<method name="_uninitialize" qualifiers="virtual">
			<return type="void" />
			<description>
			</description>
		</method>
		<method name="add_blit">
			<return type="void" />
			<argument index="0" name="render_target" type="RID" />
			<argument index="1" name="src_rect" type="Rect2" />
			<argument index="2" name="dst_rect" type="Rect2i" />
			<argument index="3" name="use_layer" type="bool" />
			<argument index="4" name="layer" type="int" />
			<argument index="5" name="apply_lens_distortion" type="bool" />
			<argument index="6" name="eye_center" type="Vector2" />
			<argument index="7" name="k1" type="float" />
			<argument index="8" name="k2" type="float" />
			<argument index="9" name="upscale" type="float" />
			<argument index="10" name="aspect_ratio" type="float" />
			<description>
				Blits our render results to screen optionally applying lens distortion. This can only be called while processing [code]_commit_views[/code].
			</description>
		</method>
		<method name="get_render_target_texture">
			<return type="RID" />
			<argument index="0" name="render_target" type="RID" />
			<description>
			</description>
		</method>
	</methods>
</class>