summaryrefslogtreecommitdiff
path: root/doc/classes/ARVRScriptInterface.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ARVRScriptInterface.xml')
-rw-r--r--doc/classes/ARVRScriptInterface.xml118
1 files changed, 0 insertions, 118 deletions
diff --git a/doc/classes/ARVRScriptInterface.xml b/doc/classes/ARVRScriptInterface.xml
deleted file mode 100644
index 182147a015..0000000000
--- a/doc/classes/ARVRScriptInterface.xml
+++ /dev/null
@@ -1,118 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="ARVRScriptInterface" inherits="ARVRInterface" category="Core" version="3.0.alpha.custom_build">
- <brief_description>
- Base class for GDNative based ARVR interfaces.
- </brief_description>
- <description>
- This class is used as a base class/interface class for implementing GDNative based ARVR interfaces and as a result exposes more of the internals of the ARVR server.
- </description>
- <tutorials>
- </tutorials>
- <demos>
- </demos>
- <methods>
- <method name="_get_projection_for_eye" qualifiers="virtual">
- <return type="void">
- </return>
- <description>
- Should return the projection 4x4 matrix for the requested eye.
- </description>
- </method>
- <method name="commit_for_eye" qualifiers="virtual">
- <return type="void">
- </return>
- <argument index="0" name="eye" type="int">
- </argument>
- <argument index="1" name="render_target" type="RID">
- </argument>
- <description>
- Outputs a finished render buffer to the AR/VR device for the given eye.
- </description>
- </method>
- <method name="get_anchor_detection_is_enabled" qualifiers="virtual">
- <return type="bool">
- </return>
- <description>
- Returns true if achor detection is enabled (AR only).
- </description>
- </method>
- <method name="get_capabilities" qualifiers="virtual">
- <return type="int">
- </return>
- <description>
- Returns a combination of flags providing information about the capabilities of this interface.
- </description>
- </method>
- <method name="get_recommended_render_targetsize" qualifiers="virtual">
- <return type="Vector2">
- </return>
- <description>
- Returns the size at which we should render our scene to get optimal quality on the output device.
- </description>
- </method>
- <method name="get_tracking_status" qualifiers="virtual">
- <return type="int">
- </return>
- <description>
- 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.
- </description>
- </method>
- <method name="get_transform_for_eye" qualifiers="virtual">
- <return type="Transform">
- </return>
- <argument index="0" name="eye" type="int">
- </argument>
- <argument index="1" name="cam_transform" type="Transform">
- </argument>
- <description>
- Get the location and orientation transform used when rendering a specific eye.
- </description>
- </method>
- <method name="initialize" qualifiers="virtual">
- <return type="bool">
- </return>
- <description>
- Initialize this interface.
- </description>
- </method>
- <method name="is_initialized" qualifiers="virtual">
- <return type="bool">
- </return>
- <description>
- Returns true if this interface has been initialized and is active.
- </description>
- </method>
- <method name="is_stereo" qualifiers="virtual">
- <return type="bool">
- </return>
- <description>
- Returns true if we require stereoscopic rendering for this interface.
- </description>
- </method>
- <method name="process" qualifiers="virtual">
- <return type="void">
- </return>
- <description>
- Gets called before rendering each frame so tracking data gets updated in time.
- </description>
- </method>
- <method name="set_anchor_detection_is_enabled" qualifiers="virtual">
- <return type="void">
- </return>
- <argument index="0" name="enabled" type="bool">
- </argument>
- <description>
- Enables anchor detection, this is used on AR interfaces and enables the extra logic that will detect planes, features, objects, etc. and adds/modifies anchor points.
- </description>
- </method>
- <method name="uninitialize" qualifiers="virtual">
- <return type="void">
- </return>
- <description>
- Turn this interface off.
- </description>
- </method>
- </methods>
- <constants>
- </constants>
-</class>