OpenXRExtensionWrapper

public OpenXRApiExtension GetOpenxrApi();

Returns the created OpenXRApiExtension, which can be used to access the OpenXR API.

public void RegisterExtensionWrapper();

Registers the extension. This should happen at core module initialization level. Note: This cannot be called once OpenXR has been initialized.

public virtual Reckfell.Collections.Array<Transform3D> _GetCameraOffsets(StringName trackerName);

Returns an array of offsets for each view rendered for the given camera, if this camera is handled by this extension. tracker_name refers to the camera tracker for which we're retrieving this.

public virtual Reckfell.Collections.Array<Projection> _GetCameraProjections(StringName trackerName, double aspect, double zNear, double zFar);

Returns an array of projections for each view rendered for the given camera, if this camera is handled by this extension. tracker_name refers to the camera tracker for which we're retrieving this.

public virtual ulong _GetCompositionLayer(int index);

Returns a pointer to an XrCompositionLayerBaseHeader struct to provide the given composition layer. This will only be called if the extension previously registered itself with OpenXRApiExtension.RegisterCompositionLayerProvider. Note: This virtual method will be called on the render thread. Additionally, the data it returns will be used shortly after this method is called, so it needs to remain valid until the next time OpenXRExtensionWrapper._OnPreRender runs.

public virtual int _GetCompositionLayerCount();

Returns the number of composition layers this extension wrapper provides via OpenXRExtensionWrapper._GetCompositionLayer. This will only be called if the extension previously registered itself with OpenXRApiExtension.RegisterCompositionLayerProvider. Note: This virtual method will be called on the render thread. Additionally, the data it returns will be used shortly after this method is called, so it needs to remain valid until the next time OpenXRExtensionWrapper._OnPreRender runs.

public virtual int _GetCompositionLayerOrder(int index);

Returns an integer that will be used to sort the given composition layer provided via OpenXRExtensionWrapper._GetCompositionLayer. 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 0, so layers provided by this method should probably be above or below (but not exactly) 0. This will only be called if the extension previously registered itself with OpenXRApiExtension.RegisterCompositionLayerProvider. Note: This virtual method will be called on the render thread. Additionally, the data it returns will be used shortly after this method is called, so it needs to remain valid until the next time OpenXRExtensionWrapper._OnPreRender runs.

public virtual Reckfell.Collections.Dictionary _GetRequestedExtensions(ulong xRVersion);

Returns a Reckfell.Collections.Dictionary of OpenXR extensions related to this extension. xr_version specifies the OpenXR version we're instantiating. This will be zero if the editor requests this list to flag supported features. The Reckfell.Collections.Dictionary should contain the name of the extension, mapped to a bool * cast to an integer:

• If the bool * is a nullptr this extension is mandatory.
• If the bool * points to a boolean, the boolean will be updated to true if the extension is enabled.

public virtual string[] _GetSuggestedTrackerNames();

Returns a string[] of positional tracker names that are used within the extension wrapper.

public virtual Reckfell.Collections.Array<Reckfell.Collections.Dictionary> _GetViewportCompositionLayerExtensionProperties();

Gets an array of Reckfell.Collections.Dictionarys that represent properties, just like ReckfellObject.GetPropertyList, that will be added to OpenXRCompositionLayer nodes. Note: This virtual method will be called on the render thread.

public virtual Reckfell.Collections.Dictionary _GetViewportCompositionLayerExtensionPropertyDefaults();

Gets a Reckfell.Collections.Dictionary containing the default values for the properties returned by OpenXRExtensionWrapper._GetViewportCompositionLayerExtensionProperties.

public virtual void _OnBeforeInstanceCreated();

Called before the OpenXR instance is created. Note: This virtual method will be called on the main thread, however, it will be called before OpenXR becomes involved in rendering, so it is safe to write to data that will be used by the render thread.

public virtual void _OnInstanceCreated(ulong instance);

Called right after the OpenXR instance is created. Note: This virtual method will be called on the main thread, however, it will be called before OpenXR becomes involved in rendering, so it is safe to write to data that will be used by the render thread.

public virtual void _OnInstanceDestroyed();

Called right before the OpenXR instance is destroyed. Note: This virtual method will be called on the main thread, however, it will be called after OpenXR is done being involved in rendering, so it is safe to write to data that was used by the render thread.

public virtual void _OnMainSwapchainsCreated();

Called right after the main swapchains are (re)created. Note: This virtual method will be called on the render thread.

public virtual void _OnPostDrawViewport(Rid viewport);

Called right after the given viewport is rendered. Note: The draw commands might only be queued at this point, not executed. Note: This virtual method will be called on the render thread.

public virtual void _OnPreDrawViewport(Rid viewport);

Called right before the given viewport is rendered. Note: This virtual method will be called on the render thread.

public virtual void _OnPreRender();

Called right before the XR viewports begin their rendering step. Note: This virtual method will be called on the render thread.

public virtual void _OnProcess();

Called as part of the OpenXR process handling. This happens right before general and physics processing steps of the main loop. During this step controller data is queried and made available to game logic.

public virtual void _OnRegisterMetadata(OpenXRInteractionProfileMetadata interactionProfileMetadata);

Allows extensions to register additional controller metadata. This function is called even when the OpenXR API is not constructed as the metadata needs to be available to the editor. Extensions should also provide metadata regardless of whether they are supported on the host system. The controller data is used to setup action maps for users who may have access to the relevant hardware.

public virtual void _OnSessionCreated(ulong session);

Called right after the OpenXR session is created. Note: This virtual method will be called on the main thread, however, it will be called before OpenXR becomes involved in rendering, so it is safe to write to data that will be used by the render thread.

public virtual void _OnSessionDestroyed();

Called right before the OpenXR session is destroyed. Note: This virtual method will be called on the main thread, however, it will be called after OpenXR is done being involved in rendering, so it is safe to write to data that was used by the render thread.

public virtual void _OnStateExiting();

Called when the OpenXR session state is changed to exiting.

public virtual void _OnStateFocused();

Called when the OpenXR session state is changed to focused. This state is the active state when the game runs.

public virtual void _OnStateIdle();

Called when the OpenXR session state is changed to idle.

public virtual void _OnStateLossPending();

Called when the OpenXR session state is changed to loss pending.

public virtual void _OnStateReady();

Called when the OpenXR session state is changed to ready. This means OpenXR is ready to set up the session.

public virtual void _OnStateStopping();

Called when the OpenXR session state is changed to stopping.

public virtual void _OnStateSynchronized();

Called when the OpenXR session state is changed to synchronized. OpenXR also returns to this state when the application loses focus.

public virtual void _OnStateVisible();

Called when the OpenXR session state is changed to visible. This means OpenXR is now ready to receive frames.

public virtual void _OnSyncActions();

Called when OpenXR has performed its action sync.

public virtual void _PrepareViewConfiguration(int viewCount);

Called before _set_view_configuration_and_get_next_pointer to allow the extension to reserve data for the given number of views.

public virtual void _PrintViewConfigurationInfo(int view);

Called to allow an extension to print additional information about its view configuration, if applicable. This will only be called if verbose output is enabled.