godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/XRInterface.xml

180 lines
9.5 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="XRInterface" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
Base class for an XR interface implementation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Remove unused GDNative code This has been superseded by GDExtension so this code is no longer useful nor usable. There's still some GDNative-related stuff in platform export code which needs to be adapted for GDExtension (e.g. to include GDExtension libraries in exports).
2022-03-09 12:56:14 +00:00
This class needs to be implemented to make an AR or VR platform available to Godot and these should be implemented as C++ modules or GDExtension modules. Part of the interface is exposed to GDScript so you can detect, enable and configure an AR or VR platform.
Renaming all ARVR nodes to XR
2020-04-08 14:47:36 +00:00
Interfaces should be written in such a way that simply enabling them will give us a working setup. You can query the available interfaces through [XRServer].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 09:43:07 +00:00
<link title="VR documentation index">$DOCS_URL/tutorials/vr/index.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
<method name="get_camera_feed_id">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
If this is an AR interface that requires displaying a camera feed as the background, this method returns the feed ID in the [CameraServer] for this interface.
Adding a new Camera Server implementation to Godot. This is a new singleton where camera sources such as webcams or cameras on a mobile phone can register themselves with the Server. Other parts of Godot can interact with this to obtain images from the camera as textures. This work includes additions to the Visual Server to use this functionality to present the camera image in the background. This is specifically targetted at AR applications.
2017-08-20 14:17:24 +00:00
</description>
</method>
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
<method name="get_capabilities" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
<description>
Docs: ARVRController and ARVRInterface This commit clarifies a few methods and members in the AR/VR docs. It also updates some wording according to the style guide and fixes a couple typos.
2019-12-05 21:58:58 +00:00
Returns a combination of [enum Capabilities] flags providing information about the capabilities of this interface.
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
Returns the name of this interface (OpenXR, OpenVR, OpenHMD, ARKit, etc).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Add support for returning the play area from XRInterface
2021-06-27 11:51:30 +00:00
<method name="get_play_area" qualifiers="const">
<return type="PackedVector3Array" />
<description>
Returns an array of vectors that denotes the physical play area mapped to the virtual space around the [XROrigin3D] point. The points form a convex polygon that can be used to react to or visualise the play area. This returns an empty array if this feature is not supported or if the information is not yet available.
</description>
</method>
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
<method name="get_render_target_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.
</description>
</method>
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
<method name="get_tracking_status" qualifiers="const">
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
<return type="int" enum="XRInterface.TrackingStatus" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Add stereoscopic rendering through multiview
2021-05-07 13:19:04 +00:00
<method name="get_view_count">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Add stereoscopic rendering through multiview
2021-05-07 13:19:04 +00:00
<description>
Returns the number of views that need to be rendered for this device. 1 for Monoscopic, 2 for Stereoscopic.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="initialize">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output.
Remove trailing whitespace With `sed -i $(rg -l '[[:blank:]]*$' -g'!thirdparty') -e 's/[[:blank:]]*$//g'` (+ manual revert of some thirdparty code under `platform/android`).
2018-11-20 10:14:07 +00:00
After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence.
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
[b]Note:[/b] You must enable the XR mode on the main viewport for any device that uses the main output of Godot, such as for mobile VR.
Docs: ARVRController and ARVRInterface This commit clarifies a few methods and members in the AR/VR docs. It also updates some wording according to the style guide and fixes a couple typos.
2019-12-05 21:58:58 +00:00
If you do this for a platform that handles its own output (such as OpenVR) Godot will show just one eye without distortion on screen. Alternatively, you can add a separate viewport node to your scene and enable AR/VR on that viewport. It will be used to output to the HMD, leaving you free to do anything you like in the main window, such as using a separate camera as a spectator camera or rendering something completely different.
While currently not used, you can activate additional interfaces. You may wish to do this if you want to track controllers from other platforms. However, at this point in time only one interface can render to an HMD.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
<method name="is_initialized" qualifiers="const">
<return type="bool" />
<description>
Is [code]true[/code] if this interface has been initialised.
</description>
</method>
Add support for returning the play area from XRInterface
2021-06-27 11:51:30 +00:00
<method name="set_play_area_mode">
<return type="bool" />
<argument index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" />
<description>
Sets the active play area mode, will return [code]false[/code] if the mode can't be used with this interface.
</description>
</method>
<method name="supports_play_area_mode">
<return type="bool" />
<argument index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" />
<description>
Call this to find out if a given play area mode is supported by this interface.
</description>
</method>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<method name="trigger_haptic_pulse">
<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>
Triggers a haptic pulse on a device associated with this interface.
[code]action_name[/code] is the name of the action for this pulse.
[code]tracker_name[/code] is optional and can be used to direct the pulse to a specific device provided that device is bound to this haptic.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="uninitialize">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Turns the interface off.
</description>
</method>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="ar_is_anchor_detection_enabled" type="bool" setter="set_anchor_detection_is_enabled" getter="get_anchor_detection_is_enabled" default="false">
Docs: ARVRController and ARVRInterface This commit clarifies a few methods and members in the AR/VR docs. It also updates some wording according to the style guide and fixes a couple typos.
2019-12-05 21:58:58 +00:00
On an AR interface, [code]true[/code] if anchor detection is enabled.
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
</member>
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
<member name="interface_is_primary" type="bool" setter="set_primary" getter="is_primary" default="false">
Docs: ARVRController and ARVRInterface This commit clarifies a few methods and members in the AR/VR docs. It also updates some wording according to the style guide and fixes a couple typos.
2019-12-05 21:58:58 +00:00
[code]true[/code] if this is the primary interface.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Add support for returning the play area from XRInterface
2021-06-27 11:51:30 +00:00
<member name="xr_play_area_mode" type="int" setter="set_play_area_mode" getter="get_play_area_mode" enum="XRInterface.PlayAreaMode" default="0">
The play area mode for this interface.
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</members>
Add support for returning the play area from XRInterface
2021-06-27 11:51:30 +00:00
<signals>
<signal name="play_area_changed">
<argument index="0" name="mode" type="int" />
<description>
Emitted when the play area is changed. This can be a result of the player resetting the boundary or entering a new play area, the player changing the play area mode, the world scale changing or the player resetting their headset orientation.
</description>
</signal>
</signals>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<constants>
Renaming all ARVR nodes to XR
2020-04-08 14:47:36 +00:00
<constant name="XR_NONE" value="0" enum="Capabilities">
No XR capabilities.
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
</constant>
Renaming all ARVR nodes to XR
2020-04-08 14:47:36 +00:00
<constant name="XR_MONO" value="1" enum="Capabilities">
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
This interface can work with normal rendering output (non-HMD based AR).
</constant>
Renaming all ARVR nodes to XR
2020-04-08 14:47:36 +00:00
<constant name="XR_STEREO" value="2" enum="Capabilities">
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
This interface supports stereoscopic rendering.
</constant>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<constant name="XR_QUAD" value="4" enum="Capabilities">
This interface supports quad rendering (not yet supported by Godot).
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
</constant>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<constant name="XR_VR" value="8" enum="Capabilities">
this interface supports VR.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<constant name="XR_AR" value="16" enum="Capabilities">
This interface supports AR (video background and real world tracking).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<constant name="XR_EXTERNAL" value="32" enum="Capabilities">
This interface outputs to an external device. If the main viewport is used, the on screen output is an unmodified buffer of either the left or right eye (stretched if the viewport size is not changed to the same aspect ratio of [method get_render_target_size]). Using a separate viewport node frees up the main viewport for other purposes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
<constant name="XR_NORMAL_TRACKING" value="0" enum="TrackingStatus">
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
Tracking is behaving as expected.
</constant>
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
<constant name="XR_EXCESSIVE_MOTION" value="1" enum="TrackingStatus">
Docs: ARVRController and ARVRInterface This commit clarifies a few methods and members in the AR/VR docs. It also updates some wording according to the style guide and fixes a couple typos.
2019-12-05 21:58:58 +00:00
Tracking is hindered by excessive motion (the player is moving faster than tracking can keep up).
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
</constant>
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
<constant name="XR_INSUFFICIENT_FEATURES" value="2" enum="TrackingStatus">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Tracking is hindered by insufficient features, it's too dark (for camera-based tracking), player is blocked, etc.
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
</constant>
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
<constant name="XR_UNKNOWN_TRACKING" value="3" enum="TrackingStatus">
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
We don't know the status of the tracking or this interface does not provide feedback.
</constant>
Adding GDExtension support to XRInterface
2021-08-23 05:23:16 +00:00
<constant name="XR_NOT_TRACKING" value="4" enum="TrackingStatus">
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 10:14:14 +00:00
Tracking is not functional (camera not plugged in or obscured, lighthouses turned off, etc.).
Made a few tweaks to the interface
2017-09-29 11:36:27 +00:00
</constant>
Add support for returning the play area from XRInterface
2021-06-27 11:51:30 +00:00
<constant name="XR_PLAY_AREA_UNKNOWN" value="0" enum="PlayAreaMode">
Play area mode not set or not available.
</constant>
<constant name="XR_PLAY_AREA_3DOF" value="1" enum="PlayAreaMode">
Play area only supports orientation tracking, no positional tracking, area will center around player.
</constant>
<constant name="XR_PLAY_AREA_SITTING" value="2" enum="PlayAreaMode">
Player is in seated position, limited positional tracking, fixed guardian around player.
</constant>
<constant name="XR_PLAY_AREA_ROOMSCALE" value="3" enum="PlayAreaMode">
Player is free to move around, full positional tracking.
</constant>
<constant name="XR_PLAY_AREA_STAGE" value="4" enum="PlayAreaMode">
Same as roomscale but origin point is fixed to the center of the physical space, XRServer.center_on_hmd disabled.
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>