Home Explore Help
Sign In
godotengine
/
godot-docs
mirror of https://github.com/godotengine/godot-docs
Watch 1
Star 1
Fork 0
Files
Tree: 9ffd5f53c4
Branches Tags
godot-docs
/
classes
/
class_xrcamera3d.rst

class_xrcamera3d.rst 2.2 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRCamera3D.xml.
    7. 

  7. 

  8. .. _class_XRCamera3D:
    9. 

  9. 

  10. XRCamera3D
    11. 

  11. ==========
    12. 

  12. 

  13. **Inherits:** :ref:`Camera3D<class_Camera3D>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. A camera node with a few overrules for AR/VR applied, such as location tracking.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. This is a helper 3D node for our camera. Note that, if stereoscopic rendering is applicable (VR-HMD), most of the camera properties are ignored, as the HMD information overrides them. The only properties that can be trusted are the near and far planes.
    23. 

  23. 

  24. The position and orientation of this node is automatically updated by the XR Server to represent the location of the HMD if such tracking is available and can thus be used by game logic. Note that, in contrast to the XR Controller, the render thread has access to the most up-to-date tracking data of the HMD and the location of the XRCamera3D can lag a few milliseconds behind what is used for rendering as a result.
    25. 

  25. 

  26. .. rst-class:: classref-introduction-group
    27. 

  27. 

  28. Tutorials
    29. 

  29. ---------
    30. 

  30. 

  31. - :doc:`XR documentation index <../tutorials/xr/index>`
    32. 

  32. 

  33. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    34. 

  34. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    35. 

  35. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    36. 

  36. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    37. 

  37. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    38. 

  38. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    39. 

  39. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    40. 

  40. .. |void| replace:: :abbr:`void (No return value.)`
    41. 

  41.