-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Finish filling in all of the API docs (#165)
- Loading branch information
Showing
24 changed files
with
174 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
doc_classes/OpenXRFbCompositionLayerAlphaBlendExtensionWrapper.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,31 @@ | ||
<?xml version="1.0" encoding="UTF-8" ?> | ||
<class name="OpenXRFbCompositionLayerAlphaBlendExtensionWrapper" inherits="OpenXRExtensionWrapperExtension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd"> | ||
<brief_description> | ||
Wraps the [code]XR_FB_composition_layer_alpha_blend[/code] extension. | ||
</brief_description> | ||
<description> | ||
Wraps the [code]XR_FB_composition_layer_alpha_blend[/code] extension. | ||
</description> | ||
<tutorials> | ||
</tutorials> | ||
<constants> | ||
<constant name="BLEND_FACTOR_ZERO" value="0" enum="BlendFactor"> | ||
Blending factor set to zero, resulting in no contribution from the source. | ||
</constant> | ||
<constant name="BLEND_FACTOR_ONE" value="1" enum="BlendFactor"> | ||
Blending factor set to one, resulting in full contribution from the source. | ||
</constant> | ||
<constant name="BLEND_FACTOR_SRC_ALPHA" value="2" enum="BlendFactor"> | ||
Blending factor using the source alpha value. | ||
</constant> | ||
<constant name="BLEND_FACTOR_ONE_MINUS_SRC_ALPHA" value="3" enum="BlendFactor"> | ||
Blending factor using one minus the source alpha value. | ||
</constant> | ||
<constant name="BLEND_FACTOR_DST_ALPHA" value="4" enum="BlendFactor"> | ||
Blending factor using the destination alpha value. | ||
</constant> | ||
<constant name="BLEND_FACTOR_ONE_MINUS_DST_ALPHA" value="5" enum="BlendFactor"> | ||
Blending factor using one minus the destination alpha value. | ||
</constant> | ||
</constants> | ||
</class> |
2 changes: 2 additions & 0 deletions
2
doc_classes/OpenXRFbCompositionLayerSecureContentExtensionWrapper.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
doc_classes/OpenXRFbCompositionLayerSettingsExtensionWrapper.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,31 @@ | ||
<?xml version="1.0" encoding="UTF-8" ?> | ||
<class name="OpenXRFbCompositionLayerSettingsExtensionWrapper" inherits="OpenXRExtensionWrapperExtension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd"> | ||
<brief_description> | ||
Wraps the [code]XR_FB_composition_layer_settings[/code] extension. | ||
</brief_description> | ||
<description> | ||
Wraps the [code]XR_FB_composition_layer_settings[/code] extension. | ||
</description> | ||
<tutorials> | ||
</tutorials> | ||
<constants> | ||
<constant name="SUPERSAMPLING_MODE_DISABLED" value="0" enum="SupersamplingMode"> | ||
Disable supersampling. | ||
</constant> | ||
<constant name="SUPERSAMPLING_MODE_NORMAL" value="1" enum="SupersamplingMode"> | ||
Normal supersampling. | ||
</constant> | ||
<constant name="SUPERSAMPLING_MODE_QUALITY" value="2" enum="SupersamplingMode"> | ||
Quality supersampling. | ||
</constant> | ||
<constant name="SHARPENING_MODE_DISABLED" value="0" enum="SharpeningMode"> | ||
Disable sharpening. | ||
</constant> | ||
<constant name="SHARPENING_MODE_NORMAL" value="1" enum="SharpeningMode"> | ||
Normal sharpening. | ||
</constant> | ||
<constant name="SHARPENING_MODE_QUALITY" value="2" enum="SharpeningMode"> | ||
Quality sharpening. | ||
</constant> | ||
</constants> | ||
</class> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,46 @@ | ||
<?xml version="1.0" encoding="UTF-8" ?> | ||
<class name="OpenXRFbHandTrackingMesh" inherits="Skeleton3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd"> | ||
<brief_description> | ||
A skinned mesh representing the player's hand (retreived using the [code]XR_FB_hand_tracking_mesh[/code] extension). | ||
</brief_description> | ||
<description> | ||
A skinned mesh representing the player's hand. | ||
The mesh will be retreived using the [code]XR_FB_hand_tracking_mesh[/code] extension (if supported by the OpenXR runtime and headset) sometime after the OpenXR session has begun. | ||
It can be animated using [XRHandModifier3D]. | ||
</description> | ||
<tutorials> | ||
</tutorials> | ||
<methods> | ||
<method name="get_mesh_instance" qualifiers="const"> | ||
<return type="MeshInstance3D" /> | ||
<description> | ||
Gets the [MeshInstance3D] node, if it has been created. | ||
</description> | ||
</method> | ||
</methods> | ||
<members> | ||
<member name="hand" type="int" setter="set_hand" getter="get_hand" enum="OpenXRFbHandTrackingMesh.Hand" default="0"> | ||
The hand to retrieve the mesh for. | ||
</member> | ||
<member name="material" type="Material" setter="set_material" getter="get_material"> | ||
The material assigned to the hand mesh. | ||
</member> | ||
<member name="scale_override" type="float" setter="set_scale_override" getter="get_scale_override"> | ||
A scale multiplier to apply to the mesh. | ||
Only used if [member use_scale_override] is [code]true[/code]. | ||
[b]Note: This is a global value that applies to all [OpenXRFbHandTrackingMesh] nodes, which is only provided here for convenience.[/b] | ||
</member> | ||
<member name="use_scale_override" type="bool" setter="set_use_scale_override" getter="get_use_scale_override"> | ||
Indicates whether or not [member scale_override] should be used. | ||
[b]Note: This is a global value that applies to all [OpenXRFbHandTrackingMesh] nodes, which is only provided here for convenience.[/b] | ||
</member> | ||
</members> | ||
<constants> | ||
<constant name="Hand::HAND_LEFT" value="0" enum="Hand"> | ||
Left hand. | ||
</constant> | ||
<constant name="Hand::HAND_RIGHT" value="1" enum="Hand"> | ||
Right hand. | ||
</constant> | ||
</constants> | ||
</class> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.