diff options
| author | David Snopek <dsnopek@gmail.com> | 2023-05-09 23:29:13 +1000 |
|---|---|---|
| committer | David Snopek <dsnopek@gmail.com> | 2024-03-13 17:53:15 -0500 |
| commit | 308a6a4734f38f79ac505e41e6f61c51df111748 (patch) | |
| tree | d8952063e94700e517f81328e28e73048f6cc428 /modules/openxr/doc_classes | |
| parent | da945ce6266ce27ba63b6b08dc0eb2414594f7cb (diff) | |
| download | redot-engine-308a6a4734f38f79ac505e41e6f61c51df111748.tar.gz | |
OpenXR: Allow GDExtensions to provide multiple, ordered composition layers
Co-authored-by: Bastiaan Olij <mux213@gmail.com>
Diffstat (limited to 'modules/openxr/doc_classes')
| -rw-r--r-- | modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml b/modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml index 20ce1c42bf..9d6b197ee1 100644 --- a/modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml +++ b/modules/openxr/doc_classes/OpenXRExtensionWrapperExtension.xml @@ -11,8 +11,25 @@ <methods> <method name="_get_composition_layer" qualifiers="virtual"> <return type="int" /> + <param index="0" name="index" type="int" /> <description> - Returns a pointer to an [code]XrCompositionLayerBaseHeader[/code] struct to provide a composition layer. This will only be called if the extension previously registered itself with [method OpenXRAPIExtension.register_composition_layer_provider]. + Returns a pointer to an [code]XrCompositionLayerBaseHeader[/code] struct to provide the given composition layer. + This will only be called if the extension previously registered itself with [method OpenXRAPIExtension.register_composition_layer_provider]. + </description> + </method> + <method name="_get_composition_layer_count" qualifiers="virtual"> + <return type="int" /> + <description> + Returns the number of composition layers this extension wrapper provides via [method _get_composition_layer]. + This will only be called if the extension previously registered itself with [method OpenXRAPIExtension.register_composition_layer_provider]. + </description> + </method> + <method name="_get_composition_layer_order" qualifiers="virtual"> + <return type="int" /> + <param index="0" name="index" type="int" /> + <description> + Returns an integer that will be used to sort the given composition layer provided via [method _get_composition_layer]. Lower numbers will move the layer to the front of the list, and higher numbers to the end. The default projection layer has an order of [code]0[/code], so layers provided by this method should probably be above or below (but not exactly) [code]0[/code]. + This will only be called if the extension previously registered itself with [method OpenXRAPIExtension.register_composition_layer_provider]. </description> </method> <method name="_get_requested_extensions" qualifiers="virtual"> |