From 50f62624c440f11aa256975e4640a6d41c60b819 Mon Sep 17 00:00:00 2001 From: Stephen Gold Date: Tue, 26 Feb 2019 12:53:57 -0800 Subject: [PATCH] jme3-vr JavaDoc corrections (comments only) --- .../main/java/com/jme3/app/VRAppState.java | 6 +- .../main/java/com/jme3/app/VREnvironment.java | 1 - .../java/com/jme3/input/vr/VRViewManager.java | 2 +- .../jme3/input/vr/osvr/OSVRViewManager.java | 2 +- .../jme3/shadow/AbstractShadowFilterVR.java | 4 +- .../jme3/shadow/AbstractShadowRendererVR.java | 6 +- .../DirectionalLightShadowRendererVR.java | 6 +- .../CameraVideoStreamFrameHeader_t.java | 2 +- .../jme3/system/jopenvr/JOpenVRLibrary.java | 2 - .../com/jme3/system/jopenvr/Texture_t.java | 2 - .../system/jopenvr/TrackedDevicePose_t.java | 1 - .../system/jopenvr/VREvent_Property_t.java | 1 - .../VROverlayIntersectionMaskPrimitive_t.java | 1 - .../VROverlayIntersectionParams_t.java | 2 +- .../osvrclientkit/OsvrClientKitLibrary.java | 148 ++++++--- .../OsvrClientReportTypesLibrary.java | 8 +- .../osvr/osvrdisplay/OsvrDisplayLibrary.java | 284 ++++++++++-------- .../OsvrMatrixConventionsLibrary.java | 54 ++-- .../OsvrRenderManagerLibrary.java | 4 +- .../OSVR_OpenResultsOpenGL.java | 1 - .../OsvrRenderManagerOpenGLLibrary.java | 8 +- .../osvrtimevalue/OsvrTimeValueLibrary.java | 18 +- 22 files changed, 323 insertions(+), 240 deletions(-) diff --git a/jme3-vr/src/main/java/com/jme3/app/VRAppState.java b/jme3-vr/src/main/java/com/jme3/app/VRAppState.java index cd00f40df..e4b3f1825 100644 --- a/jme3-vr/src/main/java/com/jme3/app/VRAppState.java +++ b/jme3-vr/src/main/java/com/jme3/app/VRAppState.java @@ -1,7 +1,7 @@ package com.jme3.app; /* - * Copyright (c) 2009-2018 jMonkeyEngine + * Copyright (c) 2009-2019 jMonkeyEngine * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -291,7 +291,7 @@ public class VRAppState extends AbstractAppState { } /** - * Get the scene observer. If no observer has been set, this method return the application {@link #getCamera() camera}. + * Get the scene observer. If no observer has been set, this method returns the application camera. * @return the scene observer. * @see #setObserver(Spatial) */ @@ -300,7 +300,7 @@ public class VRAppState extends AbstractAppState { } /** - * Set the scene observer. The VR headset will be linked to it. If no observer is set, the VR headset is linked to the application {@link #getCamera() camera}. + * Set the scene observer. The VR headset will be linked to it. If no observer is set, the VR headset is linked to the application camera. * @param observer the scene observer. */ public void setObserver(Spatial observer) { diff --git a/jme3-vr/src/main/java/com/jme3/app/VREnvironment.java b/jme3-vr/src/main/java/com/jme3/app/VREnvironment.java index aaf5249ca..e6dc64d48 100644 --- a/jme3-vr/src/main/java/com/jme3/app/VREnvironment.java +++ b/jme3-vr/src/main/java/com/jme3/app/VREnvironment.java @@ -97,7 +97,6 @@ public class VREnvironment { /** * Set the VR bounds. - * @return the VR bounds. * @see #getVRBounds() */ public void setVRBounds(VRBounds bounds){ diff --git a/jme3-vr/src/main/java/com/jme3/input/vr/VRViewManager.java b/jme3-vr/src/main/java/com/jme3/input/vr/VRViewManager.java index 96b3eda95..87aaadff9 100644 --- a/jme3-vr/src/main/java/com/jme3/input/vr/VRViewManager.java +++ b/jme3-vr/src/main/java/com/jme3/input/vr/VRViewManager.java @@ -161,7 +161,7 @@ public interface VRViewManager { * Send the rendering result as textures to the two eyes. * This method should be called after all the rendering operations * (for example at the end of the {@link AppState#postRender() postRender()} method of the attached app state.) - * @see #preRender() + * @see #render() */ public void postRender(); diff --git a/jme3-vr/src/main/java/com/jme3/input/vr/osvr/OSVRViewManager.java b/jme3-vr/src/main/java/com/jme3/input/vr/osvr/OSVRViewManager.java index e3f1df53a..12eef2ca9 100644 --- a/jme3-vr/src/main/java/com/jme3/input/vr/osvr/OSVRViewManager.java +++ b/jme3-vr/src/main/java/com/jme3/input/vr/osvr/OSVRViewManager.java @@ -441,7 +441,7 @@ public class OSVRViewManager extends AbstractVRViewManager{ /** * Update the VR view manager. - * This method is called by the attached {@link VRApplication VR application} and should not be called manually. + * This method is called by the attached VR application and should not be called manually. * @param tpf the time per frame. */ public void update(float tpf) { diff --git a/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowFilterVR.java b/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowFilterVR.java index 9c6d355c9..aa9401f3e 100644 --- a/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowFilterVR.java +++ b/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowFilterVR.java @@ -1,7 +1,7 @@ package com.jme3.shadow; /* - * Copyright (c) 2009-2018 jMonkeyEngine + * Copyright (c) 2009-2019 jMonkeyEngine * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -69,8 +69,6 @@ public abstract class AbstractShadowFilterVR * @param manager the application asset manager * @param shadowMapSize the size of the rendered shadowmaps (512,1024,2048, * etc...) - * @param nbShadowMaps the number of shadow maps rendered (the more shadow - * maps the more quality, the less fps). * @param shadowRenderer the shadowRenderer to use for this Filter */ @SuppressWarnings("all") diff --git a/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowRendererVR.java b/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowRendererVR.java index 296855e5a..6b30a2812 100644 --- a/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowRendererVR.java +++ b/jme3-vr/src/main/java/com/jme3/shadow/AbstractShadowRendererVR.java @@ -1,7 +1,7 @@ package com.jme3.shadow; /* - * Copyright (c) 2009-2018 jMonkeyEngine + * Copyright (c) 2009-2019 jMonkeyEngine * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -364,7 +364,7 @@ public abstract class AbstractShadowRendererVR implements SceneProcessor, Savabl * * @param shadowMapIndex the index of the shadow map being rendered * @param shadowMapOccluders the list of occluders - * @return + * @return a list of occluders */ protected abstract GeometryList getOccludersToRender(int shadowMapIndex, GeometryList shadowMapOccluders); @@ -684,7 +684,7 @@ public abstract class AbstractShadowRendererVR implements SceneProcessor, Savabl /** * returns true if the light source bounding box is in the view frustum - * @return + * @return true if box in frustum */ protected abstract boolean checkCulling(Camera viewCam); diff --git a/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowRendererVR.java b/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowRendererVR.java index 4c87a39d7..04b42b7d4 100644 --- a/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowRendererVR.java +++ b/jme3-vr/src/main/java/com/jme3/shadow/DirectionalLightShadowRendererVR.java @@ -1,7 +1,7 @@ package com.jme3.shadow; /* - * Copyright (c) 2009-2018 jMonkeyEngine + * Copyright (c) 2009-2019 jMonkeyEngine * All rights reserved. * * Redistribution and use in source and binary forms, with or without @@ -293,9 +293,9 @@ public class DirectionalLightShadowRendererVR extends AbstractShadowRendererVR { } /** - * Directional light are always in the view frustum + * Directional light is always in the view frustum * @param viewCam - * @return + * @return true */ @Override protected boolean checkCulling(Camera viewCam) { diff --git a/jme3-vr/src/main/java/com/jme3/system/jopenvr/CameraVideoStreamFrameHeader_t.java b/jme3-vr/src/main/java/com/jme3/system/jopenvr/CameraVideoStreamFrameHeader_t.java index d7f7f690b..138ad020a 100644 --- a/jme3-vr/src/main/java/com/jme3/system/jopenvr/CameraVideoStreamFrameHeader_t.java +++ b/jme3-vr/src/main/java/com/jme3/system/jopenvr/CameraVideoStreamFrameHeader_t.java @@ -11,7 +11,7 @@ import java.util.List; */ public class CameraVideoStreamFrameHeader_t extends Structure { /** - * @see EVRTrackedCameraFrameType
+ * C type : EVRTrackedCameraFrameType */ public int eFrameType; diff --git a/jme3-vr/src/main/java/com/jme3/system/jopenvr/JOpenVRLibrary.java b/jme3-vr/src/main/java/com/jme3/system/jopenvr/JOpenVRLibrary.java index 2a3b99733..554cc5de2 100644 --- a/jme3-vr/src/main/java/com/jme3/system/jopenvr/JOpenVRLibrary.java +++ b/jme3-vr/src/main/java/com/jme3/system/jopenvr/JOpenVRLibrary.java @@ -33,7 +33,6 @@ public class JOpenVRLibrary implements Library { */ /** * Init the native binding to the underlying system library. - * @return true if the link is effective and false otherwise. */ public static void init() throws UnsatisfiedLinkError { Native.unregister(JOpenVRLibrary.class); @@ -1817,7 +1816,6 @@ public class JOpenVRLibrary implements Library { /** * Original signature : intptr_t VR_GetGenericInterface(const char*, EVRInitError*)
* native declaration : headers\openvr_capi.h:1929
- * @deprecated use the safer methods {@link #VR_GetGenericInterface(java.lang.String, java.nio.IntBuffer)} and {@link #VR_GetGenericInterface(com.sun.jna.Pointer, com.sun.jna.ptr.IntByReference)} instead */ @Deprecated public static native IntByReference VR_GetGenericInterface(Pointer pchInterfaceVersion, IntByReference peError); diff --git a/jme3-vr/src/main/java/com/jme3/system/jopenvr/Texture_t.java b/jme3-vr/src/main/java/com/jme3/system/jopenvr/Texture_t.java index a9f326f09..cfca69578 100644 --- a/jme3-vr/src/main/java/com/jme3/system/jopenvr/Texture_t.java +++ b/jme3-vr/src/main/java/com/jme3/system/jopenvr/Texture_t.java @@ -16,12 +16,10 @@ public class Texture_t extends Structure { */ public int handle; /** - * @see ETextureType
* C type : ETextureType */ public int eType; /** - * @see EColorSpace
* C type : EColorSpace */ public int eColorSpace; diff --git a/jme3-vr/src/main/java/com/jme3/system/jopenvr/TrackedDevicePose_t.java b/jme3-vr/src/main/java/com/jme3/system/jopenvr/TrackedDevicePose_t.java index 9ccdab58a..35e50422d 100644 --- a/jme3-vr/src/main/java/com/jme3/system/jopenvr/TrackedDevicePose_t.java +++ b/jme3-vr/src/main/java/com/jme3/system/jopenvr/TrackedDevicePose_t.java @@ -17,7 +17,6 @@ public class TrackedDevicePose_t extends Structure { /** C type : HmdVector3_t */ public HmdVector3_t vAngularVelocity; /** - * @see ETrackingResult
* C type : ETrackingResult */ public int eTrackingResult; diff --git a/jme3-vr/src/main/java/com/jme3/system/jopenvr/VREvent_Property_t.java b/jme3-vr/src/main/java/com/jme3/system/jopenvr/VREvent_Property_t.java index 0b9664778..97d4d6efa 100644 --- a/jme3-vr/src/main/java/com/jme3/system/jopenvr/VREvent_Property_t.java +++ b/jme3-vr/src/main/java/com/jme3/system/jopenvr/VREvent_Property_t.java @@ -13,7 +13,6 @@ public class VREvent_Property_t extends Structure { /** C type : PropertyContainerHandle_t */ public long container; /** - * @see ETrackedDeviceProperty
* C type : ETrackedDeviceProperty */ public int prop; diff --git a/jme3-vr/src/main/java/com/jme3/system/jopenvr/VROverlayIntersectionMaskPrimitive_t.java b/jme3-vr/src/main/java/com/jme3/system/jopenvr/VROverlayIntersectionMaskPrimitive_t.java index 962fbe340..136d5f2a9 100644 --- a/jme3-vr/src/main/java/com/jme3/system/jopenvr/VROverlayIntersectionMaskPrimitive_t.java +++ b/jme3-vr/src/main/java/com/jme3/system/jopenvr/VROverlayIntersectionMaskPrimitive_t.java @@ -11,7 +11,6 @@ import java.util.List; */ public class VROverlayIntersectionMaskPrimitive_t extends Structure { /** - * @see EVROverlayIntersectionMaskPrimitiveType
* C type : EVROverlayIntersectionMaskPrimitiveType */ public int m_nPrimitiveType; diff --git a/jme3-vr/src/main/java/com/jme3/system/jopenvr/VROverlayIntersectionParams_t.java b/jme3-vr/src/main/java/com/jme3/system/jopenvr/VROverlayIntersectionParams_t.java index ce72360f7..08bc09a02 100644 --- a/jme3-vr/src/main/java/com/jme3/system/jopenvr/VROverlayIntersectionParams_t.java +++ b/jme3-vr/src/main/java/com/jme3/system/jopenvr/VROverlayIntersectionParams_t.java @@ -15,7 +15,7 @@ public class VROverlayIntersectionParams_t extends Structure { /** C type : HmdVector3_t */ public HmdVector3_t vDirection; /** - * @see ETrackingUniverseOrigin
+ * C type : ETrackingUniverseOrigin */ public int eOrigin; diff --git a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrclientkit/OsvrClientKitLibrary.java b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrclientkit/OsvrClientKitLibrary.java index 6c5b32e03..dd8792e39 100644 --- a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrclientkit/OsvrClientKitLibrary.java +++ b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrclientkit/OsvrClientKitLibrary.java @@ -19,41 +19,45 @@ public class OsvrClientKitLibrary implements Library { Native.register(OsvrClientKitLibrary.class, OsvrClientKitLibrary.JNA_NATIVE_LIB); } /** - * @brief Initialize the library.
+ * Initialize the library. * @param applicationIdentifier A null terminated string identifying your
* application. Reverse DNS format strongly suggested.
* @param flags initialization options (reserved) - pass 0 for now.
- * @returns Client context - will be needed for subsequent calls
+ * @return Client context - will be needed for subsequent calls
* Original signature : OSVR_ClientContext osvrClientInit(const char[], uint32_t)
- * @deprecated use the safer methods {@link #osvrClientInit(byte[], int)} and {@link #osvrClientInit(com.sun.jna.Pointer, int)} instead + * @deprecated use the safer method + * {@link #osvrClientInit(byte[], int)} + * instead */ @Deprecated public static native OsvrClientKitLibrary.OSVR_ClientContext osvrClientInit(Pointer applicationIdentifier, int flags); /** - * @brief Initialize the library.
+ * Initialize the library. * @param applicationIdentifier A null terminated string identifying your
* application. Reverse DNS format strongly suggested.
* @param flags initialization options (reserved) - pass 0 for now.
- * @returns Client context - will be needed for subsequent calls
+ * @return Client context - will be needed for subsequent calls
* Original signature : OSVR_ClientContext osvrClientInit(const char[], uint32_t) */ public static native OsvrClientKitLibrary.OSVR_ClientContext osvrClientInit(byte applicationIdentifier[], int flags); /** - * @brief Updates the state of the context - call regularly in your mainloop.
+ * Updates the state of the context - call regularly in your mainloop. * @param ctx Client context
* Original signature : OSVR_ReturnCode osvrClientUpdate(OSVR_ClientContext)
- * @deprecated use the safer methods {@link #osvrClientUpdate(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext)} and {@link #osvrClientUpdate(com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientUpdate(OsvrClientKitLibrary.OSVR_ClientContext)} + * instead */ @Deprecated public static native byte osvrClientUpdate(Pointer ctx); /** - * @brief Updates the state of the context - call regularly in your mainloop.
+ * Updates the state of the context - call regularly in your mainloop. * @param ctx Client context
* Original signature : OSVR_ReturnCode osvrClientUpdate(OSVR_ClientContext) */ public static native byte osvrClientUpdate(OsvrClientKitLibrary.OSVR_ClientContext ctx); /** - * @brief Checks to see if the client context is fully started up and connected
+ * Checks to see if the client context is fully started up and connected * properly to a server.
* If this reports that the client context is not OK, there may not be a server
* running, or you may just have to call osvrClientUpdate() a few times to
@@ -63,12 +67,14 @@ public class OsvrClientKitLibrary implements Library { * @return OSVR_RETURN_FAILURE if not yet fully connected/initialized, or if
* some other error (null context) occurs.
* Original signature : OSVR_ReturnCode osvrClientCheckStatus(OSVR_ClientContext)
- * @deprecated use the safer methods {@link #osvrClientCheckStatus(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext)} and {@link #osvrClientCheckStatus(com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientCheckStatus(com.jme3.system.osvr.osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext)} + * instead */ @Deprecated public static native byte osvrClientCheckStatus(Pointer ctx); /** - * @brief Checks to see if the client context is fully started up and connected
+ * Checks to see if the client context is fully started up and connected * properly to a server.
* If this reports that the client context is not OK, there may not be a server
* running, or you may just have to call osvrClientUpdate() a few times to
@@ -81,77 +87,85 @@ public class OsvrClientKitLibrary implements Library { */ public static native byte osvrClientCheckStatus(OsvrClientKitLibrary.OSVR_ClientContext ctx); /** - * @brief Shutdown the library.
+ * Shut down the library. * @param ctx Client context
* Original signature : OSVR_ReturnCode osvrClientShutdown(OSVR_ClientContext)
- * @deprecated use the safer methods {@link #osvrClientShutdown(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext)} and {@link #osvrClientShutdown(com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientShutdown(OsvrClientKitLibrary.OSVR_ClientContext)} + * instead */ @Deprecated public static native byte osvrClientShutdown(Pointer ctx); /** - * @brief Shutdown the library.
+ * Shut down the library. * @param ctx Client context
* Original signature : OSVR_ReturnCode osvrClientShutdown(OSVR_ClientContext) */ public static native byte osvrClientShutdown(OsvrClientKitLibrary.OSVR_ClientContext ctx); /** - * @brief Log a message from the client.
+ * Log a message from the client. * Original signature : void osvrClientLog(OSVR_ClientContext, OSVR_LogLevel, const char*)
- * @deprecated use the safer methods {@link #osvrClientLog(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext, int, java.lang.String)} and {@link #osvrClientLog(com.sun.jna.Pointer, int, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientLog(com.jme3.system.osvr.osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext, int, java.lang.String)} + * instead */ @Deprecated public static native void osvrClientLog(Pointer ctx, int severity, Pointer message); /** - * @brief Log a message from the client.
+ * Log a message from the client. * Original signature : void osvrClientLog(OSVR_ClientContext, OSVR_LogLevel, const char*) */ public static native void osvrClientLog(OsvrClientKitLibrary.OSVR_ClientContext ctx, int severity, String message); /** - * @brief Get the interface associated with the given path.
+ * Get the interface associated with the given path. * @param ctx Client context
* @param path A resource path (null-terminated string)
- * @param[out] iface The interface object. May be freed when no longer needed,
+ * @param iface The interface object. May be freed when no longer needed,
* otherwise it will be freed when the context is closed.
* Original signature : OSVR_ReturnCode osvrClientGetInterface(OSVR_ClientContext, const char[], OSVR_ClientInterface*)
- * @deprecated use the safer methods {@link #osvrClientGetInterface(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext, byte[], com.sun.jna.ptr.PointerByReference)} and {@link #osvrClientGetInterface(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.ptr.PointerByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetInterface(com.jme3.system.osvr.osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext, byte[], com.sun.jna.ptr.PointerByReference)} + * instead */ @Deprecated public static native byte osvrClientGetInterface(Pointer ctx, Pointer path, Pointer iface); /** - * @brief Get the interface associated with the given path.
+ * Get the interface associated with the given path. * @param ctx Client context
* @param path A resource path (null-terminated string)
- * @param[out] iface The interface object. May be freed when no longer needed,
+ * @param iface The interface object. May be freed when no longer needed,
* otherwise it will be freed when the context is closed.
* Original signature : OSVR_ReturnCode osvrClientGetInterface(OSVR_ClientContext, const char[], OSVR_ClientInterface*) */ public static native byte osvrClientGetInterface(OsvrClientKitLibrary.OSVR_ClientContext ctx, byte path[], PointerByReference iface); /** - * @brief Get the interface associated with the given path.
+ * Get the interface associated with the given path. * @param ctx Client context
* @param path A resource path (null-terminated string)
- * @param[out] iface The interface object. May be freed when no longer needed,
+ * @param iface The interface object. May be freed when no longer needed,
* otherwise it will be freed when the context is closed.
* Original signature : OSVR_ReturnCode osvrClientGetInterface(OSVR_ClientContext, const char[], OSVR_ClientInterface*) */ public static native byte osvrClientGetInterface(Pointer ctx, Pointer path, PointerByReference iface); /** - * @brief Free an interface object before context closure.
+ * Free an interface object before context closure. * @param ctx Client context
* @param iface The interface object
- * @returns OSVR_RETURN_SUCCESS unless a null context or interface was passed
+ * @return OSVR_RETURN_SUCCESS unless a null context or interface was passed
* or the given interface was not found in the context (i.e. had already been
* freed)
* Original signature : OSVR_ReturnCode osvrClientFreeInterface(OSVR_ClientContext, OSVR_ClientInterface)
- * @deprecated use the safer methods {@link #osvrClientFreeInterface(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext, osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface)} and {@link #osvrClientFreeInterface(com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientFreeInterface(com.jme3.system.osvr.osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext, com.jme3.system.osvr.osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface)} + * instead */ @Deprecated public static native byte osvrClientFreeInterface(Pointer ctx, Pointer iface); /** - * @brief Free an interface object before context closure.
+ * Free an interface object before context closure. * @param ctx Client context
* @param iface The interface object
- * @returns OSVR_RETURN_SUCCESS unless a null context or interface was passed
+ * @return OSVR_RETURN_SUCCESS unless a null context or interface was passed
* or the given interface was not found in the context (i.e. had already been
* freed)
* Original signature : OSVR_ReturnCode osvrClientFreeInterface(OSVR_ClientContext, OSVR_ClientInterface) @@ -159,7 +173,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrClientFreeInterface(OsvrClientKitLibrary.OSVR_ClientContext ctx, OsvrClientKitLibrary.OSVR_ClientInterface iface); /** * Original signature : OSVR_ReturnCode osvrRegisterPoseCallback(OSVR_ClientInterface, OSVR_PoseCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterPoseCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterPoseCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterPoseCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterPoseCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -167,7 +183,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterPoseCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterPositionCallback(OSVR_ClientInterface, OSVR_PositionCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterPositionCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterPositionCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterPositionCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterPositionCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -175,7 +193,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterPositionCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterOrientationCallback(OSVR_ClientInterface, OSVR_OrientationCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterOrientationCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterOrientationCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterOrientationCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterOrientationCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -183,7 +203,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterOrientationCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterVelocityCallback(OSVR_ClientInterface, OSVR_VelocityCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterVelocityCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterVelocityCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterVelocityCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterVelocityCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -191,7 +213,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterVelocityCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterLinearVelocityCallback(OSVR_ClientInterface, OSVR_LinearVelocityCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterLinearVelocityCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterLinearVelocityCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterLinearVelocityCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterLinearVelocityCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -199,7 +223,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterLinearVelocityCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterAngularVelocityCallback(OSVR_ClientInterface, OSVR_AngularVelocityCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterAngularVelocityCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterAngularVelocityCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterAngularVelocityCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterAngularVelocityCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -207,7 +233,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterAngularVelocityCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterAccelerationCallback(OSVR_ClientInterface, OSVR_AccelerationCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterAccelerationCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterAccelerationCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterAccelerationCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterAccelerationCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -215,7 +243,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterAccelerationCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterLinearAccelerationCallback(OSVR_ClientInterface, OSVR_LinearAccelerationCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterLinearAccelerationCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterLinearAccelerationCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterLinearAccelerationCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterLinearAccelerationCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -223,7 +253,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterLinearAccelerationCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterAngularAccelerationCallback(OSVR_ClientInterface, OSVR_AngularAccelerationCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterAngularAccelerationCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterAngularAccelerationCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterAngularAccelerationCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterAngularAccelerationCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -231,7 +263,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterAngularAccelerationCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterButtonCallback(OSVR_ClientInterface, OSVR_ButtonCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterButtonCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterButtonCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterButtonCallback(com.jme3.system.osvr.osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Callback, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterButtonCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -239,7 +273,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterButtonCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Callback cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterAnalogCallback(OSVR_ClientInterface, OSVR_AnalogCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterAnalogCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterAnalogCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterAnalogCallback(com.jme3.system.osvr.osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Callback, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterAnalogCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -247,7 +283,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterAnalogCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Callback cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterImagingCallback(OSVR_ClientInterface, OSVR_ImagingCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterImagingCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterImagingCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterImagingCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterImagingCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -255,7 +293,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterImagingCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterLocation2DCallback(OSVR_ClientInterface, OSVR_Location2DCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterLocation2DCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterLocation2DCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterLocation2DCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterLocation2DCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -263,7 +303,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterLocation2DCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterDirectionCallback(OSVR_ClientInterface, OSVR_DirectionCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterDirectionCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterDirectionCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterDirectionCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterDirectionCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -271,7 +313,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterDirectionCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterEyeTracker2DCallback(OSVR_ClientInterface, OSVR_EyeTracker2DCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterEyeTracker2DCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterEyeTracker2DCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterEyeTracker2DCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterEyeTracker2DCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -279,7 +323,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterEyeTracker2DCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterEyeTracker3DCallback(OSVR_ClientInterface, OSVR_EyeTracker3DCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterEyeTracker3DCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterEyeTracker3DCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterEyeTracker3DCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterEyeTracker3DCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -287,7 +333,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterEyeTracker3DCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterEyeTrackerBlinkCallback(OSVR_ClientInterface, OSVR_EyeTrackerBlinkCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterEyeTrackerBlinkCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterEyeTrackerBlinkCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterEyeTrackerBlinkCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterEyeTrackerBlinkCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -295,7 +343,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterEyeTrackerBlinkCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterNaviVelocityCallback(OSVR_ClientInterface, OSVR_NaviVelocityCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterNaviVelocityCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterNaviVelocityCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterNaviVelocityCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterNaviVelocityCallback(Pointer iface, Pointer cb, Pointer userdata); @@ -303,7 +353,9 @@ public class OsvrClientKitLibrary implements Library { public static native byte osvrRegisterNaviVelocityCallback(OsvrClientKitLibrary.OSVR_ClientInterface iface, Pointer cb, Pointer userdata); /** * Original signature : OSVR_ReturnCode osvrRegisterNaviPositionCallback(OSVR_ClientInterface, OSVR_NaviPositionCallback, void*)
- * @deprecated use the safer methods {@link #osvrRegisterNaviPositionCallback(osvrclientkit.OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} and {@link #osvrRegisterNaviPositionCallback(com.sun.jna.Pointer, com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrRegisterNaviPositionCallback(OsvrClientKitLibrary.OSVR_ClientInterface, com.sun.jna.Pointer, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrRegisterNaviPositionCallback(Pointer iface, Pointer cb, Pointer userdata); diff --git a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrclientreporttypes/OsvrClientReportTypesLibrary.java b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrclientreporttypes/OsvrClientReportTypesLibrary.java index 7933cdefe..9f8f1ea76 100644 --- a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrclientreporttypes/OsvrClientReportTypesLibrary.java +++ b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrclientreporttypes/OsvrClientReportTypesLibrary.java @@ -33,7 +33,7 @@ public class OsvrClientReportTypesLibrary implements Library { /** Original signature : void osvrVec3SetZ(OSVR_Vec3*, double) */ public static native void osvrVec3SetZ(OSVR_Vec3 v, double val); /** - * @brief Set a Vec3 to the zero vector
+ * Set a Vec3 to the zero vector. * Original signature : void osvrVec3Zero(OSVR_Vec3*) */ public static native void osvrVec3Zero(OSVR_Vec3 v); @@ -54,12 +54,12 @@ public class OsvrClientReportTypesLibrary implements Library { /** Original signature : void osvrQuatSetZ(OSVR_Quaternion*, double) */ public static native void osvrQuatSetZ(OSVR_Quaternion q, double val); /** - * @brief Set a quaternion to the identity rotation
+ * Set a quaternion to the identity rotation. * Original signature : void osvrQuatSetIdentity(OSVR_Quaternion*) */ public static native void osvrQuatSetIdentity(OSVR_Quaternion q); /** - * @brief Set a pose to identity
+ * Set a pose to identity. * Original signature : void osvrPose3SetIdentity(OSVR_Pose3*) */ public static native void osvrPose3SetIdentity(OSVR_Pose3 pose); @@ -72,7 +72,7 @@ public class OsvrClientReportTypesLibrary implements Library { /** Original signature : void osvrVec2SetY(OSVR_Vec2*, double) */ public static native void osvrVec2SetY(OSVR_Vec2 v, double val); /** - * @brief Set a Vec2 to the zero vector
+ * Set a Vec2 to the zero vector. * Original signature : void osvrVec2Zero(OSVR_Vec2*) */ public static native void osvrVec2Zero(OSVR_Vec2 v); diff --git a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrdisplay/OsvrDisplayLibrary.java b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrdisplay/OsvrDisplayLibrary.java index 38489ecdf..f3ef25140 100644 --- a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrdisplay/OsvrDisplayLibrary.java +++ b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrdisplay/OsvrDisplayLibrary.java @@ -27,7 +27,7 @@ public class OsvrDisplayLibrary implements Library { Native.register(OsvrDisplayLibrary.class, OsvrDisplayLibrary.JNA_NATIVE_LIB); } /** - * @brief Allocates a display configuration object populated with data from the
+ * Allocates a display configuration object populated with data from the
* OSVR system.
* Before this call will succeed, your application will need to be correctly
* and fully connected to an OSVR server. You may consider putting this call in
@@ -55,19 +55,21 @@ public class OsvrDisplayLibrary implements Library { * practice, typically more) osvrClientUpdate() must be performed before a new
* tracker report is available to populate that state. See
* osvrClientCheckDisplayStartup() to query if all startup data is available.
- * @todo Decide if relative viewport should be constant in a display config,
+ * todo Decide if relative viewport should be constant in a display config,
* and update docs accordingly.
- * @todo Decide if distortion params should be constant in a display config,
+ * todo Decide if distortion params should be constant in a display config,
* and update docs accordingly.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed or some other
* error occurred, in which case the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetDisplay(OSVR_ClientContext, OSVR_DisplayConfig*)
- * @deprecated use the safer methods {@link #osvrClientGetDisplay(osvrdisplay.OsvrDisplayLibrary.OSVR_ClientContext, com.sun.jna.ptr.PointerByReference)} and {@link #osvrClientGetDisplay(com.sun.jna.Pointer, com.sun.jna.ptr.PointerByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetDisplay(com.jme3.system.osvr.osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext, com.sun.jna.ptr.PointerByReference)} + * instead */ @Deprecated public static native byte osvrClientGetDisplay(Pointer ctx, Pointer disp); /** - * @brief Allocates a display configuration object populated with data from the
+ * Allocates a display configuration object populated with data from the
* OSVR system.
* Before this call will succeed, your application will need to be correctly
* and fully connected to an OSVR server. You may consider putting this call in
@@ -95,9 +97,9 @@ public class OsvrDisplayLibrary implements Library { * practice, typically more) osvrClientUpdate() must be performed before a new
* tracker report is available to populate that state. See
* osvrClientCheckDisplayStartup() to query if all startup data is available.
- * @todo Decide if relative viewport should be constant in a display config,
+ * todo Decide if relative viewport should be constant in a display config,
* and update docs accordingly.
- * @todo Decide if distortion params should be constant in a display config,
+ * todo Decide if distortion params should be constant in a display config,
* and update docs accordingly.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed or some other
* error occurred, in which case the output argument is unmodified.
@@ -105,7 +107,7 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientGetDisplay(OsvrClientKitLibrary.OSVR_ClientContext ctx, PointerByReference disp); /** - * @brief Allocates a display configuration object populated with data from the
+ * Allocates a display configuration object populated with data from the
* OSVR system.
* Before this call will succeed, your application will need to be correctly
* and fully connected to an OSVR server. You may consider putting this call in
@@ -133,9 +135,9 @@ public class OsvrDisplayLibrary implements Library { * practice, typically more) osvrClientUpdate() must be performed before a new
* tracker report is available to populate that state. See
* osvrClientCheckDisplayStartup() to query if all startup data is available.
- * @todo Decide if relative viewport should be constant in a display config,
+ * todo Decide if relative viewport should be constant in a display config,
* and update docs accordingly.
- * @todo Decide if distortion params should be constant in a display config,
+ * todo Decide if distortion params should be constant in a display config,
* and update docs accordingly.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed or some other
* error occurred, in which case the output argument is unmodified.
@@ -143,19 +145,21 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientGetDisplay(Pointer ctx, PointerByReference disp); /** - * @brief Frees a display configuration object. The corresponding context must
+ * Frees a display configuration object. The corresponding context must
* still be open.
* If you fail to call this, it will be automatically called as part of
* clean-up when the corresponding context is closed.
* @return OSVR_RETURN_FAILURE if a null config was passed, or if the given
* display object was already freed.
* Original signature : OSVR_ReturnCode osvrClientFreeDisplay(OSVR_DisplayConfig)
- * @deprecated use the safer methods {@link #osvrClientFreeDisplay(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig)} and {@link #osvrClientFreeDisplay(com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientFreeDisplay(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig)} + * instead */ @Deprecated public static native byte osvrClientFreeDisplay(Pointer disp); /** - * @brief Frees a display configuration object. The corresponding context must
+ * Frees a display configuration object. The corresponding context must
* still be open.
* If you fail to call this, it will be automatically called as part of
* clean-up when the corresponding context is closed.
@@ -165,7 +169,7 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientFreeDisplay(OsvrDisplayLibrary.OSVR_DisplayConfig disp); /** - * @brief Checks to see if a display is fully configured and ready, including
+ * Checks to see if a display is fully configured and ready, including
* having received its first pose update.
* Once this first succeeds, it will continue to succeed for the lifetime of
* the display config object, so it is not necessary to keep calling once you
@@ -173,12 +177,14 @@ public class OsvrDisplayLibrary implements Library { * @return OSVR_RETURN_FAILURE if a null config was passed, or if the given
* display config object was otherwise not ready for full use.
* Original signature : OSVR_ReturnCode osvrClientCheckDisplayStartup(OSVR_DisplayConfig)
- * @deprecated use the safer methods {@link #osvrClientCheckDisplayStartup(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig)} and {@link #osvrClientCheckDisplayStartup(com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientCheckDisplayStartup(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig)} + * instead */ @Deprecated public static native byte osvrClientCheckDisplayStartup(Pointer disp); /** - * @brief Checks to see if a display is fully configured and ready, including
+ * Checks to see if a display is fully configured and ready, including
* having received its first pose update.
* Once this first succeeds, it will continue to succeed for the lifetime of
* the display config object, so it is not necessary to keep calling once you
@@ -189,97 +195,97 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientCheckDisplayStartup(OsvrDisplayLibrary.OSVR_DisplayConfig disp); /** - * @brief A display config can have one or more display inputs to pass pixels
+ * A display config can have one or more display inputs to pass pixels
* over (HDMI/DVI connections, etc): retrieve the number of display inputs in
* the current configuration.
* @param disp Display config object.
- * @param[out] numDisplayInputs Number of display inputs in the logical display
+ * @param numDisplayInputs Number of display inputs in the logical display
* topology, **constant** throughout the active, valid lifetime of a display
* config object.
- * @sa OSVR_DisplayInputCount
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in
* which case the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetNumDisplayInputs(OSVR_DisplayConfig, OSVR_DisplayInputCount*)
- * @deprecated use the safer methods {@link #osvrClientGetNumDisplayInputs(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, java.nio.ByteBuffer)} and {@link #osvrClientGetNumDisplayInputs(com.sun.jna.Pointer, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientGetNumDisplayInputs(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, java.nio.ByteBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetNumDisplayInputs(Pointer disp, Pointer numDisplayInputs); /** - * @brief A display config can have one or more display inputs to pass pixels
+ * A display config can have one or more display inputs to pass pixels
* over (HDMI/DVI connections, etc): retrieve the number of display inputs in
* the current configuration.
* @param disp Display config object.
- * @param[out] numDisplayInputs Number of display inputs in the logical display
+ * @param numDisplayInputs Number of display inputs in the logical display
* topology, **constant** throughout the active, valid lifetime of a display
* config object.
- * @sa OSVR_DisplayInputCount
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in
* which case the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetNumDisplayInputs(OSVR_DisplayConfig, OSVR_DisplayInputCount*) */ public static native byte osvrClientGetNumDisplayInputs(OsvrDisplayLibrary.OSVR_DisplayConfig disp, ByteBuffer numDisplayInputs); /** - * @brief Retrieve the pixel dimensions of a given display input for a display
+ * Retrieve the pixel dimensions of a given display input for a display
* config
* @param disp Display config object.
* @param displayInputIndex The zero-based index of the display input.
- * @param[out] width Width (in pixels) of the display input.
- * @param[out] height Height (in pixels) of the display input.
+ * @param width Width (in pixels) of the display input.
+ * @param height Height (in pixels) of the display input.
* The out parameters are **constant** throughout the active, valid lifetime of
* a display config object.
- * @sa OSVR_DisplayDimension
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in
* which case the output arguments are unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetDisplayDimensions(OSVR_DisplayConfig, OSVR_DisplayInputCount, OSVR_DisplayDimension*, OSVR_DisplayDimension*)
- * @deprecated use the safer methods {@link #osvrClientGetDisplayDimensions(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, byte, java.nio.IntBuffer, java.nio.IntBuffer)} and {@link #osvrClientGetDisplayDimensions(com.sun.jna.Pointer, byte, com.sun.jna.ptr.IntByReference, com.sun.jna.ptr.IntByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetDisplayDimensions(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, byte, java.nio.IntBuffer, java.nio.IntBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetDisplayDimensions(Pointer disp, byte displayInputIndex, IntByReference width, IntByReference height); /** - * @brief Retrieve the pixel dimensions of a given display input for a display
+ * Retrieve the pixel dimensions of a given display input for a display
* config
* @param disp Display config object.
* @param displayInputIndex The zero-based index of the display input.
- * @param[out] width Width (in pixels) of the display input.
- * @param[out] height Height (in pixels) of the display input.
+ * @param width Width (in pixels) of the display input.
+ * @param height Height (in pixels) of the display input.
* The out parameters are **constant** throughout the active, valid lifetime of
* a display config object.
- * @sa OSVR_DisplayDimension
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in
* which case the output arguments are unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetDisplayDimensions(OSVR_DisplayConfig, OSVR_DisplayInputCount, OSVR_DisplayDimension*, OSVR_DisplayDimension*) */ public static native byte osvrClientGetDisplayDimensions(OsvrDisplayLibrary.OSVR_DisplayConfig disp, byte displayInputIndex, IntBuffer width, IntBuffer height); /** - * @brief A display config can have one (or theoretically more) viewers:
+ * A display config can have one (or theoretically more) viewers:
* retrieve the viewer count.
* @param disp Display config object.
- * @param[out] viewers Number of viewers in the logical display topology,
+ * @param viewers Number of viewers in the logical display topology,
* *constant** throughout the active, valid lifetime of a display config
* object.
- * @sa OSVR_ViewerCount
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetNumViewers(OSVR_DisplayConfig, OSVR_ViewerCount*)
- * @deprecated use the safer methods {@link #osvrClientGetNumViewers(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, java.nio.IntBuffer)} and {@link #osvrClientGetNumViewers(com.sun.jna.Pointer, com.sun.jna.ptr.IntByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetNumViewers(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, java.nio.IntBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetNumViewers(Pointer disp, IntByReference viewers); /** - * @brief A display config can have one (or theoretically more) viewers:
+ * A display config can have one (or theoretically more) viewers:
* retrieve the viewer count.
* @param disp Display config object.
- * @param[out] viewers Number of viewers in the logical display topology,
+ * @param viewers Number of viewers in the logical display topology,
* *constant** throughout the active, valid lifetime of a display config
* object.
- * @sa OSVR_ViewerCount
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetNumViewers(OSVR_DisplayConfig, OSVR_ViewerCount*) */ public static native byte osvrClientGetNumViewers(OsvrDisplayLibrary.OSVR_DisplayConfig disp, IntBuffer viewers); /** - * @brief Get the pose of a viewer in a display config.
+ * Get the pose of a viewer in a display config.
* Note that there may not necessarily be any surfaces rendered from this pose
* (it's the unused "center" eye in a stereo configuration, for instance) so
* only use this if it makes integration into your engine or existing
@@ -288,12 +294,14 @@ public class OsvrDisplayLibrary implements Library { * @return OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
* yet available, in which case the pose argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerPose(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_Pose3*)
- * @deprecated use the safer methods {@link #osvrClientGetViewerPose(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, com.sun.jna.Pointer)} and {@link #osvrClientGetViewerPose(com.sun.jna.Pointer, int, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientGetViewerPose(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrClientGetViewerPose(Pointer disp, int viewer, Pointer pose); /** - * @brief Get the pose of a viewer in a display config.
+ * Get the pose of a viewer in a display config.
* Note that there may not necessarily be any surfaces rendered from this pose
* (it's the unused "center" eye in a stereo configuration, for instance) so
* only use this if it makes integration into your engine or existing
@@ -305,89 +313,93 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientGetViewerPose(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, Pointer pose); /** - * @brief Each viewer in a display config can have one or more "eyes" which
+ * Each viewer in a display config can have one or more "eyes" which
* have a substantially similar pose: get the count.
* @param disp Display config object.
* @param viewer Viewer ID
- * @param[out] eyes Number of eyes for this viewer in the logical display
+ * @param eyes Number of eyes for this viewer in the logical display
* topology, **constant** throughout the active, valid lifetime of a display
* config object
- * @sa OSVR_EyeCount
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetNumEyesForViewer(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount*)
- * @deprecated use the safer methods {@link #osvrClientGetNumEyesForViewer(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, java.nio.ByteBuffer)} and {@link #osvrClientGetNumEyesForViewer(com.sun.jna.Pointer, int, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientGetNumEyesForViewer(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, java.nio.ByteBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetNumEyesForViewer(Pointer disp, int viewer, Pointer eyes); /** - * @brief Each viewer in a display config can have one or more "eyes" which
+ * Each viewer in a display config can have one or more "eyes" which
* have a substantially similar pose: get the count.
* @param disp Display config object.
* @param viewer Viewer ID
- * @param[out] eyes Number of eyes for this viewer in the logical display
+ * @param eyes Number of eyes for this viewer in the logical display
* topology, **constant** throughout the active, valid lifetime of a display
* config object
- * @sa OSVR_EyeCount
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetNumEyesForViewer(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount*) */ public static native byte osvrClientGetNumEyesForViewer(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, ByteBuffer eyes); /** - * @brief Get the "viewpoint" for the given eye of a viewer in a display
+ * Get the "viewpoint" for the given eye of a viewer in a display
* config.
* Will only succeed if osvrClientCheckDisplayStartup() succeeds.
* @param disp Display config object
* @param viewer Viewer ID
* @param eye Eye ID
- * @param[out] pose Room-space pose (not relative to pose of the viewer)
+ * @param pose Room-space pose (not relative to pose of the viewer)
* @return OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
* yet available, in which case the pose argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyePose(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_Pose3*)
- * @deprecated use the safer methods {@link #osvrClientGetViewerEyePose(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, com.sun.jna.Pointer)} and {@link #osvrClientGetViewerEyePose(com.sun.jna.Pointer, int, byte, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientGetViewerEyePose(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrClientGetViewerEyePose(Pointer disp, int viewer, byte eye, Pointer pose); /** - * @brief Get the "viewpoint" for the given eye of a viewer in a display
+ * Get the "viewpoint" for the given eye of a viewer in a display
* config.
* Will only succeed if osvrClientCheckDisplayStartup() succeeds.
* @param disp Display config object
* @param viewer Viewer ID
* @param eye Eye ID
- * @param[out] pose Room-space pose (not relative to pose of the viewer)
+ * @param pose Room-space pose (not relative to pose of the viewer)
* @return OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
* yet available, in which case the pose argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyePose(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_Pose3*) */ public static native byte osvrClientGetViewerEyePose(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, Pointer pose); /** - * @brief Get the view matrix (inverse of pose) for the given eye of a
+ * Get the view matrix (inverse of pose) for the given eye of a
* viewer in a display config - matrix of **doubles**.
* Will only succeed if osvrClientCheckDisplayStartup() succeeds.
* @param disp Display config object
* @param viewer Viewer ID
* @param eye Eye ID
* @param flags Bitwise OR of matrix convention flags (see @ref MatrixFlags)
- * @param[out] mat Pass a double[::OSVR_MATRIX_SIZE] to get the transformation
+ * @param mat Pass a double[::OSVR_MATRIX_SIZE] to get the transformation
* matrix from room space to eye space (not relative to pose of the viewer)
* @return OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
* yet available, in which case the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyeViewMatrixd(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_MatrixConventions, double*)
- * @deprecated use the safer methods {@link #osvrClientGetViewerEyeViewMatrixd(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, short, java.nio.DoubleBuffer)} and {@link #osvrClientGetViewerEyeViewMatrixd(com.sun.jna.Pointer, int, byte, short, com.sun.jna.ptr.DoubleByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetViewerEyeViewMatrixd(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, short, java.nio.DoubleBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetViewerEyeViewMatrixd(Pointer disp, int viewer, byte eye, short flags, DoubleByReference mat); /** - * @brief Get the view matrix (inverse of pose) for the given eye of a
+ * Get the view matrix (inverse of pose) for the given eye of a
* viewer in a display config - matrix of **doubles**.
* Will only succeed if osvrClientCheckDisplayStartup() succeeds.
* @param disp Display config object
* @param viewer Viewer ID
* @param eye Eye ID
* @param flags Bitwise OR of matrix convention flags (see @ref MatrixFlags)
- * @param[out] mat Pass a double[::OSVR_MATRIX_SIZE] to get the transformation
+ * @param mat Pass a double[::OSVR_MATRIX_SIZE] to get the transformation
* matrix from room space to eye space (not relative to pose of the viewer)
* @return OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
* yet available, in which case the output argument is unmodified.
@@ -395,31 +407,33 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientGetViewerEyeViewMatrixd(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, short flags, DoubleBuffer mat); /** - * @brief Get the view matrix (inverse of pose) for the given eye of a
+ * Get the view matrix (inverse of pose) for the given eye of a
* viewer in a display config - matrix of **floats**.
* Will only succeed if osvrClientCheckDisplayStartup() succeeds.
* @param disp Display config object
* @param viewer Viewer ID
* @param eye Eye ID
* @param flags Bitwise OR of matrix convention flags (see @ref MatrixFlags)
- * @param[out] mat Pass a float[::OSVR_MATRIX_SIZE] to get the transformation
+ * @param mat Pass a float[::OSVR_MATRIX_SIZE] to get the transformation
* matrix from room space to eye space (not relative to pose of the viewer)
* @return OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
* yet available, in which case the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyeViewMatrixf(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_MatrixConventions, float*)
- * @deprecated use the safer methods {@link #osvrClientGetViewerEyeViewMatrixf(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, short, java.nio.FloatBuffer)} and {@link #osvrClientGetViewerEyeViewMatrixf(com.sun.jna.Pointer, int, byte, short, com.sun.jna.ptr.FloatByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetViewerEyeViewMatrixf(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, short, java.nio.FloatBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetViewerEyeViewMatrixf(Pointer disp, int viewer, byte eye, short flags, FloatByReference mat); /** - * @brief Get the view matrix (inverse of pose) for the given eye of a
+ * Get the view matrix (inverse of pose) for the given eye of a
* viewer in a display config - matrix of **floats**.
* Will only succeed if osvrClientCheckDisplayStartup() succeeds.
* @param disp Display config object
* @param viewer Viewer ID
* @param eye Eye ID
* @param flags Bitwise OR of matrix convention flags (see @ref MatrixFlags)
- * @param[out] mat Pass a float[::OSVR_MATRIX_SIZE] to get the transformation
+ * @param mat Pass a float[::OSVR_MATRIX_SIZE] to get the transformation
* matrix from room space to eye space (not relative to pose of the viewer)
* @return OSVR_RETURN_FAILURE if invalid parameters were passed or no pose was
* yet available, in which case the output argument is unmodified.
@@ -427,39 +441,39 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientGetViewerEyeViewMatrixf(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, short flags, FloatBuffer mat); /** - * @brief Each eye of each viewer in a display config has one or more surfaces
+ * Each eye of each viewer in a display config has one or more surfaces
* (aka "screens") on which content should be rendered.
* @param disp Display config object
* @param viewer Viewer ID
* @param eye Eye ID
- * @param[out] surfaces Number of surfaces (numbered [0, surfaces - 1]) for the
+ * @param surfaces Number of surfaces (numbered [0, surfaces - 1]) for the
* given viewer and eye. **Constant** throughout the active, valid lifetime of
* a display config object.
- * @sa OSVR_SurfaceCount
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetNumSurfacesForViewerEye(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount*)
- * @deprecated use the safer methods {@link #osvrClientGetNumSurfacesForViewerEye(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, java.nio.IntBuffer)} and {@link #osvrClientGetNumSurfacesForViewerEye(com.sun.jna.Pointer, int, byte, com.sun.jna.ptr.IntByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetNumSurfacesForViewerEye(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, java.nio.IntBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetNumSurfacesForViewerEye(Pointer disp, int viewer, byte eye, IntByReference surfaces); /** - * @brief Each eye of each viewer in a display config has one or more surfaces
+ * Each eye of each viewer in a display config has one or more surfaces
* (aka "screens") on which content should be rendered.
* @param disp Display config object
* @param viewer Viewer ID
* @param eye Eye ID
- * @param[out] surfaces Number of surfaces (numbered [0, surfaces - 1]) for the
+ * @param surfaces Number of surfaces (numbered [0, surfaces - 1]) for the
* given viewer and eye. **Constant** throughout the active, valid lifetime of
* a display config object.
- * @sa OSVR_SurfaceCount
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetNumSurfacesForViewerEye(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount*) */ public static native byte osvrClientGetNumSurfacesForViewerEye(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, IntBuffer surfaces); /** - * @brief Get the dimensions/location of the viewport **within the display
+ * Get the dimensions/location of the viewport **within the display
* input** for a surface seen by an eye of a viewer in a display config. (This
* does not include other video inputs that may be on a single virtual desktop,
* etc. or explicitly account for display configurations that use multiple
@@ -470,21 +484,23 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] left Output: Distance in pixels from the left of the video input
+ * @param left Output: Distance in pixels from the left of the video input
* to the left of the viewport.
- * @param[out] bottom Output: Distance in pixels from the bottom of the video
+ * @param bottom Output: Distance in pixels from the bottom of the video
* input to the bottom of the viewport.
- * @param[out] width Output: Width of viewport in pixels.
- * @param[out] height Output: Height of viewport in pixels.
+ * @param width Output: Width of viewport in pixels.
+ * @param height Output: Height of viewport in pixels.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output arguments are unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetRelativeViewportForViewerEyeSurface(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_ViewportDimension*, OSVR_ViewportDimension*, OSVR_ViewportDimension*, OSVR_ViewportDimension*)
- * @deprecated use the safer methods {@link #osvrClientGetRelativeViewportForViewerEyeSurface(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.IntBuffer, java.nio.IntBuffer, java.nio.IntBuffer, java.nio.IntBuffer)} and {@link #osvrClientGetRelativeViewportForViewerEyeSurface(com.sun.jna.Pointer, int, byte, int, com.sun.jna.ptr.IntByReference, com.sun.jna.ptr.IntByReference, com.sun.jna.ptr.IntByReference, com.sun.jna.ptr.IntByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetRelativeViewportForViewerEyeSurface(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.IntBuffer, java.nio.IntBuffer, java.nio.IntBuffer, java.nio.IntBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetRelativeViewportForViewerEyeSurface(Pointer disp, int viewer, byte eye, int surface, IntByReference left, IntByReference bottom, IntByReference width, IntByReference height); /** - * @brief Get the dimensions/location of the viewport **within the display
+ * Get the dimensions/location of the viewport **within the display
* input** for a surface seen by an eye of a viewer in a display config. (This
* does not include other video inputs that may be on a single virtual desktop,
* etc. or explicitly account for display configurations that use multiple
@@ -495,19 +511,19 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] left Output: Distance in pixels from the left of the video input
+ * @param left Output: Distance in pixels from the left of the video input
* to the left of the viewport.
- * @param[out] bottom Output: Distance in pixels from the bottom of the video
+ * @param bottom Output: Distance in pixels from the bottom of the video
* input to the bottom of the viewport.
- * @param[out] width Output: Width of viewport in pixels.
- * @param[out] height Output: Height of viewport in pixels.
+ * @param width Output: Width of viewport in pixels.
+ * @param height Output: Height of viewport in pixels.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output arguments are unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetRelativeViewportForViewerEyeSurface(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_ViewportDimension*, OSVR_ViewportDimension*, OSVR_ViewportDimension*, OSVR_ViewportDimension*) */ public static native byte osvrClientGetRelativeViewportForViewerEyeSurface(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, IntBuffer left, IntBuffer bottom, IntBuffer width, IntBuffer height); /** - * @brief Get the index of the display input for a surface seen by an eye of a
+ * Get the index of the display input for a surface seen by an eye of a
* viewer in a display config.
* This is the OSVR-assigned display input: it may not (and in practice,
* usually will not) match any platform-specific display indices. This function
@@ -517,21 +533,23 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] displayInput Zero-based index of the display input pixels for
+ * @param displayInput Zero-based index of the display input pixels for
* this surface are tranmitted over.
* This association is **constant** throughout the active, valid lifetime of a
* display config object.
- * @sa osvrClientGetNumDisplayInputs(),
- * osvrClientGetRelativeViewportForViewerEyeSurface()
+ * @see #osvrClientGetNumDisplayInputs(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, java.nio.ByteBuffer) + * @see #osvrClientGetRelativeViewportForViewerEyeSurface(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.IntBuffer, java.nio.IntBuffer, java.nio.IntBuffer, java.nio.IntBuffer) * @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which
* case the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceDisplayInputIndex(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_DisplayInputCount*)
- * @deprecated use the safer methods {@link #osvrClientGetViewerEyeSurfaceDisplayInputIndex(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.ByteBuffer)} and {@link #osvrClientGetViewerEyeSurfaceDisplayInputIndex(com.sun.jna.Pointer, int, byte, int, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientGetViewerEyeSurfaceDisplayInputIndex(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.ByteBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetViewerEyeSurfaceDisplayInputIndex(Pointer disp, int viewer, byte eye, int surface, Pointer displayInput); /** - * @brief Get the index of the display input for a surface seen by an eye of a
+ * Get the index of the display input for a surface seen by an eye of a
* viewer in a display config.
* This is the OSVR-assigned display input: it may not (and in practice,
* usually will not) match any platform-specific display indices. This function
@@ -541,19 +559,19 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] displayInput Zero-based index of the display input pixels for
+ * @param displayInput Zero-based index of the display input pixels for
* this surface are tranmitted over.
* This association is **constant** throughout the active, valid lifetime of a
* display config object.
- * @sa osvrClientGetNumDisplayInputs(),
- * osvrClientGetRelativeViewportForViewerEyeSurface()
+ * @see #osvrClientGetNumDisplayInputs(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, java.nio.ByteBuffer) + * @see #osvrClientGetRelativeViewportForViewerEyeSurface(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.IntBuffer, java.nio.IntBuffer, java.nio.IntBuffer, java.nio.IntBuffer) * @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which
* case the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceDisplayInputIndex(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_DisplayInputCount*) */ public static native byte osvrClientGetViewerEyeSurfaceDisplayInputIndex(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, ByteBuffer displayInput); /** - * @brief Get the projection matrix for a surface seen by an eye of a viewer
+ * Get the projection matrix for a surface seen by an eye of a viewer
* in a display config. (double version)
* @param disp Display config object
* @param viewer Viewer ID
@@ -564,17 +582,19 @@ public class OsvrDisplayLibrary implements Library { * @param far Distance from viewpoint to far clipping plane - must be positive
* and not equal to near, typically greater than near.
* @param flags Bitwise OR of matrix convention flags (see @ref MatrixFlags)
- * @param[out] matrix Output projection matrix: supply an array of 16
+ * @param matrix Output projection matrix: supply an array of 16
* (::OSVR_MATRIX_SIZE) doubles.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionMatrixd(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, double, double, OSVR_MatrixConventions, double*)
- * @deprecated use the safer methods {@link #osvrClientGetViewerEyeSurfaceProjectionMatrixd(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, double, double, short, java.nio.DoubleBuffer)} and {@link #osvrClientGetViewerEyeSurfaceProjectionMatrixd(com.sun.jna.Pointer, int, byte, int, double, double, short, com.sun.jna.ptr.DoubleByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetViewerEyeSurfaceProjectionMatrixd(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, double, double, short, java.nio.DoubleBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetViewerEyeSurfaceProjectionMatrixd(Pointer disp, int viewer, byte eye, int surface, double near, double far, short flags, DoubleByReference matrix); /** - * @brief Get the projection matrix for a surface seen by an eye of a viewer
+ * Get the projection matrix for a surface seen by an eye of a viewer
* in a display config. (double version)
* @param disp Display config object
* @param viewer Viewer ID
@@ -585,7 +605,7 @@ public class OsvrDisplayLibrary implements Library { * @param far Distance from viewpoint to far clipping plane - must be positive
* and not equal to near, typically greater than near.
* @param flags Bitwise OR of matrix convention flags (see @ref MatrixFlags)
- * @param[out] matrix Output projection matrix: supply an array of 16
+ * @param matrix Output projection matrix: supply an array of 16
* (::OSVR_MATRIX_SIZE) doubles.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
@@ -593,7 +613,7 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientGetViewerEyeSurfaceProjectionMatrixd(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, double near, double far, short flags, DoubleBuffer matrix); /** - * @brief Get the projection matrix for a surface seen by an eye of a viewer
+ * Get the projection matrix for a surface seen by an eye of a viewer
* in a display config. (float version)
* @param disp Display config object
* @param viewer Viewer ID
@@ -604,17 +624,19 @@ public class OsvrDisplayLibrary implements Library { * @param far Distance to far clipping plane - must be nonzero, typically
* positive and greater than near.
* @param flags Bitwise OR of matrix convention flags (see @ref MatrixFlags)
- * @param[out] matrix Output projection matrix: supply an array of 16
+ * @param matrix Output projection matrix: supply an array of 16
* (::OSVR_MATRIX_SIZE) floats.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionMatrixf(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, float, float, OSVR_MatrixConventions, float*)
- * @deprecated use the safer methods {@link #osvrClientGetViewerEyeSurfaceProjectionMatrixf(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, float, float, short, java.nio.FloatBuffer)} and {@link #osvrClientGetViewerEyeSurfaceProjectionMatrixf(com.sun.jna.Pointer, int, byte, int, float, float, short, com.sun.jna.ptr.FloatByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetViewerEyeSurfaceProjectionMatrixf(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, float, float, short, java.nio.FloatBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetViewerEyeSurfaceProjectionMatrixf(Pointer disp, int viewer, byte eye, int surface, float near, float far, short flags, FloatByReference matrix); /** - * @brief Get the projection matrix for a surface seen by an eye of a viewer
+ * Get the projection matrix for a surface seen by an eye of a viewer
* in a display config. (float version)
* @param disp Display config object
* @param viewer Viewer ID
@@ -625,7 +647,7 @@ public class OsvrDisplayLibrary implements Library { * @param far Distance to far clipping plane - must be nonzero, typically
* positive and greater than near.
* @param flags Bitwise OR of matrix convention flags (see @ref MatrixFlags)
- * @param[out] matrix Output projection matrix: supply an array of 16
+ * @param matrix Output projection matrix: supply an array of 16
* (::OSVR_MATRIX_SIZE) floats.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
@@ -633,7 +655,7 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientGetViewerEyeSurfaceProjectionMatrixf(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, float near, float far, short flags, FloatBuffer matrix); /** - * @brief Get the clipping planes (positions at unit distance) for a surface
+ * Get the clipping planes (positions at unit distance) for a surface
* seen by an eye of a viewer
* in a display config.
* This is only for use in integrations that cannot accept a fully-formulated
@@ -648,19 +670,21 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] left Distance to left clipping plane
- * @param[out] right Distance to right clipping plane
- * @param[out] bottom Distance to bottom clipping plane
- * @param[out] top Distance to top clipping plane
+ * @param left Distance to left clipping plane
+ * @param right Distance to right clipping plane
+ * @param bottom Distance to bottom clipping plane
+ * @param top Distance to top clipping plane
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output arguments are unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, double*, double*, double*, double*)
- * @deprecated use the safer methods {@link #osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.DoubleBuffer, java.nio.DoubleBuffer, java.nio.DoubleBuffer, java.nio.DoubleBuffer)} and {@link #osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(com.sun.jna.Pointer, int, byte, int, com.sun.jna.ptr.DoubleByReference, com.sun.jna.ptr.DoubleByReference, com.sun.jna.ptr.DoubleByReference, com.sun.jna.ptr.DoubleByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.DoubleBuffer, java.nio.DoubleBuffer, java.nio.DoubleBuffer, java.nio.DoubleBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(Pointer disp, int viewer, byte eye, int surface, DoubleByReference left, DoubleByReference right, DoubleByReference bottom, DoubleByReference top); /** - * @brief Get the clipping planes (positions at unit distance) for a surface
+ * Get the clipping planes (positions at unit distance) for a surface
* seen by an eye of a viewer
* in a display config.
* This is only for use in integrations that cannot accept a fully-formulated
@@ -675,17 +699,17 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] left Distance to left clipping plane
- * @param[out] right Distance to right clipping plane
- * @param[out] bottom Distance to bottom clipping plane
- * @param[out] top Distance to top clipping plane
+ * @param left Distance to left clipping plane
+ * @param right Distance to right clipping plane
+ * @param bottom Distance to bottom clipping plane
+ * @param top Distance to top clipping plane
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output arguments are unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, double*, double*, double*, double*) */ public static native byte osvrClientGetViewerEyeSurfaceProjectionClippingPlanes(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, DoubleBuffer left, DoubleBuffer right, DoubleBuffer bottom, DoubleBuffer top); /** - * @brief Determines if a surface seen by an eye of a viewer in a display
+ * Determines if a surface seen by an eye of a viewer in a display
* config requests some distortion to be performed.
* This simply reports true or false, and does not specify which kind of
* distortion implementations have been parameterized for this display. For
@@ -695,18 +719,20 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] distortionRequested Output parameter: whether distortion is
+ * @param distortionRequested Output parameter: whether distortion is
* requested. **Constant** throughout the active, valid lifetime of a display
* config object.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientDoesViewerEyeSurfaceWantDistortion(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_CBool*)
- * @deprecated use the safer methods {@link #osvrClientDoesViewerEyeSurfaceWantDistortion(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.ByteBuffer)} and {@link #osvrClientDoesViewerEyeSurfaceWantDistortion(com.sun.jna.Pointer, int, byte, int, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientDoesViewerEyeSurfaceWantDistortion(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.ByteBuffer)} + * instead */ @Deprecated public static native byte osvrClientDoesViewerEyeSurfaceWantDistortion(Pointer disp, int viewer, byte eye, int surface, Pointer distortionRequested); /** - * @brief Determines if a surface seen by an eye of a viewer in a display
+ * Determines if a surface seen by an eye of a viewer in a display
* config requests some distortion to be performed.
* This simply reports true or false, and does not specify which kind of
* distortion implementations have been parameterized for this display. For
@@ -716,7 +742,7 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] distortionRequested Output parameter: whether distortion is
+ * @param distortionRequested Output parameter: whether distortion is
* requested. **Constant** throughout the active, valid lifetime of a display
* config object.
* @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
@@ -725,7 +751,7 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientDoesViewerEyeSurfaceWantDistortion(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, ByteBuffer distortionRequested); /** - * @brief Returns the priority/availability of radial distortion parameters for
+ * Returns the priority/availability of radial distortion parameters for
* a surface seen by an eye of a viewer in a display config.
* If osvrClientDoesViewerEyeSurfaceWantDistortion() reports false, then the
* display does not request distortion of any sort, and thus neither this nor
@@ -735,7 +761,7 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] priority Output: the priority level. Negative values
+ * @param priority Output: the priority level. Negative values
* (canonically OSVR_DISTORTION_PRIORITY_UNAVAILABLE) indicate this technique
* not available, higher values indicate higher preference for the given
* technique based on the device's description. **Constant** throughout the
@@ -743,12 +769,14 @@ public class OsvrDisplayLibrary implements Library { * @return OSVR_RETURN_FAILURE if invalid parameters were passed, in which case
* the output argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceRadialDistortionPriority(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_DistortionPriority*)
- * @deprecated use the safer methods {@link #osvrClientGetViewerEyeSurfaceRadialDistortionPriority(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.IntBuffer)} and {@link #osvrClientGetViewerEyeSurfaceRadialDistortionPriority(com.sun.jna.Pointer, int, byte, int, com.sun.jna.ptr.IntByReference)} instead + * @deprecated use the safer method + * {@link #osvrClientGetViewerEyeSurfaceRadialDistortionPriority(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, java.nio.IntBuffer)} + * instead */ @Deprecated public static native byte osvrClientGetViewerEyeSurfaceRadialDistortionPriority(Pointer disp, int viewer, byte eye, int surface, IntByReference priority); /** - * @brief Returns the priority/availability of radial distortion parameters for
+ * Returns the priority/availability of radial distortion parameters for
* a surface seen by an eye of a viewer in a display config.
* If osvrClientDoesViewerEyeSurfaceWantDistortion() reports false, then the
* display does not request distortion of any sort, and thus neither this nor
@@ -758,7 +786,7 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] priority Output: the priority level. Negative values
+ * @param priority Output: the priority level. Negative values
* (canonically OSVR_DISTORTION_PRIORITY_UNAVAILABLE) indicate this technique
* not available, higher values indicate higher preference for the given
* technique based on the device's description. **Constant** throughout the
@@ -769,7 +797,7 @@ public class OsvrDisplayLibrary implements Library { */ public static native byte osvrClientGetViewerEyeSurfaceRadialDistortionPriority(OsvrDisplayLibrary.OSVR_DisplayConfig disp, int viewer, byte eye, int surface, IntBuffer priority); /** - * @brief Returns the radial distortion parameters, if known/requested, for a
+ * Returns the radial distortion parameters, if known/requested, for a
* surface seen by an eye of a viewer in a display config.
* Will only succeed if osvrClientGetViewerEyeSurfaceRadialDistortionPriority()
* reports a non-negative priority.
@@ -777,17 +805,19 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] params Output: the parameters for radial distortion
+ * @param params Output: the parameters for radial distortion
* @return OSVR_RETURN_FAILURE if this surface does not have these parameters
* described, or if invalid parameters were passed, in which case the output
* argument is unmodified.
* Original signature : OSVR_ReturnCode osvrClientGetViewerEyeSurfaceRadialDistortion(OSVR_DisplayConfig, OSVR_ViewerCount, OSVR_EyeCount, OSVR_SurfaceCount, OSVR_RadialDistortionParameters*)
- * @deprecated use the safer methods {@link #osvrClientGetViewerEyeSurfaceRadialDistortion(osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, com.sun.jna.Pointer)} and {@link #osvrClientGetViewerEyeSurfaceRadialDistortion(com.sun.jna.Pointer, int, byte, int, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrClientGetViewerEyeSurfaceRadialDistortion(com.jme3.system.osvr.osvrdisplay.OsvrDisplayLibrary.OSVR_DisplayConfig, int, byte, int, com.sun.jna.Pointer)} + * instead */ @Deprecated public static native byte osvrClientGetViewerEyeSurfaceRadialDistortion(Pointer disp, int viewer, byte eye, int surface, Pointer params); /** - * @brief Returns the radial distortion parameters, if known/requested, for a
+ * Returns the radial distortion parameters, if known/requested, for a
* surface seen by an eye of a viewer in a display config.
* Will only succeed if osvrClientGetViewerEyeSurfaceRadialDistortionPriority()
* reports a non-negative priority.
@@ -795,7 +825,7 @@ public class OsvrDisplayLibrary implements Library { * @param viewer Viewer ID
* @param eye Eye ID
* @param surface Surface ID
- * @param[out] params Output: the parameters for radial distortion
+ * @param params Output: the parameters for radial distortion
* @return OSVR_RETURN_FAILURE if this surface does not have these parameters
* described, or if invalid parameters were passed, in which case the output
* argument is unmodified.
diff --git a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrmatrixconventions/OsvrMatrixConventionsLibrary.java b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrmatrixconventions/OsvrMatrixConventionsLibrary.java index e32f3813a..dde9fe410 100644 --- a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrmatrixconventions/OsvrMatrixConventionsLibrary.java +++ b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrmatrixconventions/OsvrMatrixConventionsLibrary.java @@ -63,7 +63,7 @@ public class OsvrMatrixConventionsLibrary implements Library { /** Original signature : void osvrVec3SetZ(OSVR_Vec3*, double) */ public static native void osvrVec3SetZ(OSVR_Vec3 v, double val); /** - * @brief Set a Vec3 to the zero vector
+ * Set a Vec3 to the zero vector
* Original signature : void osvrVec3Zero(OSVR_Vec3*) */ public static native void osvrVec3Zero(OSVR_Vec3 v); @@ -84,89 +84,99 @@ public class OsvrMatrixConventionsLibrary implements Library { /** Original signature : void osvrQuatSetZ(OSVR_Quaternion*, double) */ public static native void osvrQuatSetZ(OSVR_Quaternion q, double val); /** - * @brief Set a quaternion to the identity rotation
+ * Set a quaternion to the identity rotation
* Original signature : void osvrQuatSetIdentity(OSVR_Quaternion*) */ public static native void osvrQuatSetIdentity(OSVR_Quaternion q); /** - * @brief Set a pose to identity
+ * Set a pose to identity
* Original signature : void osvrPose3SetIdentity(OSVR_Pose3*) */ public static native void osvrPose3SetIdentity(OSVR_Pose3 pose); /** - * @brief Set a matrix of doubles based on a Pose3.
+ * Set a matrix of doubles based on a Pose3.
* @param pose The Pose3 to convert
* @param flags Memory ordering flag - see @ref MatrixFlags
- * @param[out] mat an array of 16 doubles
+ * @param mat an array of 16 doubles
* Original signature : OSVR_ReturnCode osvrPose3ToMatrixd(const OSVR_Pose3*, OSVR_MatrixConventions, double*)
- * @deprecated use the safer methods {@link #osvrPose3ToMatrixd(osvrmatrixconventions.OSVR_Pose3, short, java.nio.DoubleBuffer)} and {@link #osvrPose3ToMatrixd(osvrmatrixconventions.OSVR_Pose3, short, com.sun.jna.ptr.DoubleByReference)} instead + * @deprecated use the safer method + * {@link #osvrPose3ToMatrixd(com.jme3.system.osvr.osvrmatrixconventions.OSVR_Pose3, short, java.nio.DoubleBuffer)} + * instead */ @Deprecated public static native byte osvrPose3ToMatrixd(OSVR_Pose3 pose, short flags, DoubleByReference mat); /** - * @brief Set a matrix of doubles based on a Pose3.
+ * Set a matrix of doubles based on a Pose3.
* @param pose The Pose3 to convert
* @param flags Memory ordering flag - see @ref MatrixFlags
- * @param[out] mat an array of 16 doubles
+ * @param mat an array of 16 doubles
* Original signature : OSVR_ReturnCode osvrPose3ToMatrixd(const OSVR_Pose3*, OSVR_MatrixConventions, double*) */ public static native byte osvrPose3ToMatrixd(OSVR_Pose3 pose, short flags, DoubleBuffer mat); /** - * @brief Set a matrix of floats based on a Pose3.
+ * Set a matrix of floats based on a Pose3.
* @param pose The Pose3 to convert
* @param flags Memory ordering flag - see @ref MatrixFlags
- * @param[out] mat an array of 16 floats
+ * @param mat an array of 16 floats
* Original signature : OSVR_ReturnCode osvrPose3ToMatrixf(const OSVR_Pose3*, OSVR_MatrixConventions, float*)
- * @deprecated use the safer methods {@link #osvrPose3ToMatrixf(osvrmatrixconventions.OSVR_Pose3, short, java.nio.FloatBuffer)} and {@link #osvrPose3ToMatrixf(osvrmatrixconventions.OSVR_Pose3, short, com.sun.jna.ptr.FloatByReference)} instead + * @deprecated use the safer method + * {@link #osvrPose3ToMatrixf(com.jme3.system.osvr.osvrmatrixconventions.OSVR_Pose3, short, java.nio.FloatBuffer)} + * instead */ @Deprecated public static native byte osvrPose3ToMatrixf(OSVR_Pose3 pose, short flags, FloatByReference mat); /** - * @brief Set a matrix of floats based on a Pose3.
+ * Set a matrix of floats based on a Pose3.
* @param pose The Pose3 to convert
* @param flags Memory ordering flag - see @ref MatrixFlags
- * @param[out] mat an array of 16 floats
+ * @param mat an array of 16 floats
* Original signature : OSVR_ReturnCode osvrPose3ToMatrixf(const OSVR_Pose3*, OSVR_MatrixConventions, float*) */ public static native byte osvrPose3ToMatrixf(OSVR_Pose3 pose, short flags, FloatBuffer mat); /** - * @brief Set a matrix based on a Pose3. (C++-only overload - detecting scalar
+ * Set a matrix based on a Pose3. (C++-only overload - detecting scalar
* type)
* Original signature : OSVR_ReturnCode osvrPose3ToMatrix(const OSVR_Pose3*, OSVR_MatrixConventions, double*)
- * @deprecated use the safer methods {@link #osvrPose3ToMatrix(osvrmatrixconventions.OSVR_Pose3, short, java.nio.DoubleBuffer)} and {@link #osvrPose3ToMatrix(osvrmatrixconventions.OSVR_Pose3, short, com.sun.jna.ptr.DoubleByReference)} instead + * @deprecated use the safer method + * {@link #osvrPose3ToMatrix(com.jme3.system.osvr.osvrmatrixconventions.OSVR_Pose3, short, java.nio.DoubleBuffer)} + * instead */ @Deprecated public static native byte osvrPose3ToMatrix(OSVR_Pose3 pose, short flags, DoubleByReference mat); /** - * @brief Set a matrix based on a Pose3. (C++-only overload - detecting scalar
+ * Set a matrix based on a Pose3. (C++-only overload - detecting scalar
* type)
* Original signature : OSVR_ReturnCode osvrPose3ToMatrix(const OSVR_Pose3*, OSVR_MatrixConventions, double*) */ public static native byte osvrPose3ToMatrix(OSVR_Pose3 pose, short flags, DoubleBuffer mat); /** - * @brief Set a matrix based on a Pose3. (C++-only overload - detecting scalar
+ * Set a matrix based on a Pose3. (C++-only overload - detecting scalar
* type)
* Original signature : OSVR_ReturnCode osvrPose3ToMatrix(const OSVR_Pose3*, OSVR_MatrixConventions, float*)
- * @deprecated use the safer methods {@link #osvrPose3ToMatrix(osvrmatrixconventions.OSVR_Pose3, short, java.nio.FloatBuffer)} and {@link #osvrPose3ToMatrix(osvrmatrixconventions.OSVR_Pose3, short, com.sun.jna.ptr.FloatByReference)} instead + * @deprecated use the safer method + * {@link #osvrPose3ToMatrix(com.jme3.system.osvr.osvrmatrixconventions.OSVR_Pose3, short, java.nio.FloatBuffer)} + * instead */ @Deprecated public static native byte osvrPose3ToMatrix(OSVR_Pose3 pose, short flags, FloatByReference mat); /** - * @brief Set a matrix based on a Pose3. (C++-only overload - detecting scalar
+ * Set a matrix based on a Pose3. (C++-only overload - detecting scalar
* type)
* Original signature : OSVR_ReturnCode osvrPose3ToMatrix(const OSVR_Pose3*, OSVR_MatrixConventions, float*) */ public static native byte osvrPose3ToMatrix(OSVR_Pose3 pose, short flags, FloatBuffer mat); /** - * @brief Set a matrix based on a Pose3. (C++-only overload - detects scalar
+ * Set a matrix based on a Pose3. (C++-only overload - detects scalar
* and takes array rather than pointer)
* Original signature : OSVR_ReturnCode osvrPose3ToMatrix(const OSVR_Pose3*, OSVR_MatrixConventions, Scalar[OSVR_MATRIX_SIZE])
- * @deprecated use the safer methods {@link #osvrPose3ToMatrix(osvrmatrixconventions.OSVR_Pose3, short, osvrmatrixconventions.OsvrMatrixConventionsLibrary.Scalar[])} and {@link #osvrPose3ToMatrix(osvrmatrixconventions.OSVR_Pose3, short, com.sun.jna.Pointer)} instead + * @deprecated use the safer method + * {@link #osvrPose3ToMatrix(com.jme3.system.osvr.osvrmatrixconventions.OSVR_Pose3, short, java.nio.DoubleBuffer)} + * instead */ @Deprecated public static native byte osvrPose3ToMatrix(OSVR_Pose3 pose, short flags, Pointer mat); /** - * @brief Set a matrix based on a Pose3. (C++-only overload - detects scalar
+ * Set a matrix based on a Pose3. (C++-only overload - detects scalar
* and takes array rather than pointer)
* Original signature : OSVR_ReturnCode osvrPose3ToMatrix(const OSVR_Pose3*, OSVR_MatrixConventions, Scalar[OSVR_MATRIX_SIZE]) */ diff --git a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanager/OsvrRenderManagerLibrary.java b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanager/OsvrRenderManagerLibrary.java index 64e71afc6..649c222d2 100644 --- a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanager/OsvrRenderManagerLibrary.java +++ b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanager/OsvrRenderManagerLibrary.java @@ -28,12 +28,12 @@ public class OsvrRenderManagerLibrary implements Library { public static final int OSVR_OPEN_STATUS_COMPLETE = 2; }; /** - * @todo OSVR_RenderTimingInfo
+ * todo OSVR_RenderTimingInfo. * Original signature : OSVR_ReturnCode osvrDestroyRenderManager(OSVR_RenderManager) */ public static native byte osvrDestroyRenderManager(Pointer renderManager); /** - * @todo Make this actually cache, for now it does not.
+ * todo Make this actually cache, for now it does not.
* Original signature : OSVR_ReturnCode osvrRenderManagerGetNumRenderInfo(OSVR_RenderManager, OSVR_RenderParams, OSVR_RenderInfoCount*) */ public static native byte osvrRenderManagerGetNumRenderInfo(Pointer renderManager, OSVR_RenderParams.ByValue renderParams, NativeSizeByReference numRenderInfoOut); diff --git a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanageropengl/OSVR_OpenResultsOpenGL.java b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanageropengl/OSVR_OpenResultsOpenGL.java index 7032d8457..e2bd8e7d6 100644 --- a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanageropengl/OSVR_OpenResultsOpenGL.java +++ b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanageropengl/OSVR_OpenResultsOpenGL.java @@ -10,7 +10,6 @@ import java.util.List; */ public class OSVR_OpenResultsOpenGL extends Structure { /** - * @see OSVR_OpenStatus
* C type : OSVR_OpenStatus */ public int status; diff --git a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanageropengl/OsvrRenderManagerOpenGLLibrary.java b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanageropengl/OsvrRenderManagerOpenGLLibrary.java index 2e706c31d..6b3a02f06 100644 --- a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanageropengl/OsvrRenderManagerOpenGLLibrary.java +++ b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrrendermanageropengl/OsvrRenderManagerOpenGLLibrary.java @@ -33,12 +33,12 @@ public class OsvrRenderManagerOpenGLLibrary implements Library { public static final int OSVR_OPEN_STATUS_COMPLETE = 2; }; /** - * @todo OSVR_RenderTimingInfo
+ * todo OSVR_RenderTimingInfo
* Original signature : OSVR_ReturnCode osvrDestroyRenderManager(OSVR_RenderManager) */ public static native byte osvrDestroyRenderManager(Pointer renderManager); /** - * @todo Make this actually cache, for now it does not.
+ * todo Make this actually cache, for now it does not.
* Original signature : OSVR_ReturnCode osvrRenderManagerGetNumRenderInfo(OSVR_RenderManager, OSVR_RenderParams, OSVR_RenderInfoCount*) */ public static native byte osvrRenderManagerGetNumRenderInfo(Pointer renderManager, OSVR_RenderParams.ByValue renderParams, NativeSizeByReference numRenderInfoOut); @@ -121,7 +121,9 @@ public class OsvrRenderManagerOpenGLLibrary implements Library { public static native byte OSVR_Projection_to_Unreal(FloatBuffer Unreal_out, com.jme3.system.osvr.osvrrendermanageropengl.OSVR_ProjectionMatrix.ByValue projection_in); /** * Original signature : OSVR_ReturnCode osvrCreateRenderManagerOpenGL(OSVR_ClientContext, const char[], OSVR_GraphicsLibraryOpenGL, OSVR_RenderManager*, OSVR_RenderManagerOpenGL*)
- * @deprecated use the safer methods {@link #osvrCreateRenderManagerOpenGL(com.jme3.system.osvr.osvrrendermanageropengl.OsvrRenderManagerOpenGLLibrary.OSVR_ClientContext, byte[], com.jme3.system.osvr.osvrrendermanageropengl.OSVR_GraphicsLibraryOpenGL.ByValue, com.sun.jna.ptr.PointerByReference, com.sun.jna.ptr.PointerByReference)} and {@link #osvrCreateRenderManagerOpenGL(com.sun.jna.Pointer, com.sun.jna.Pointer, com.jme3.system.osvr.osvrrendermanageropengl.OSVR_GraphicsLibraryOpenGL.ByValue, com.sun.jna.ptr.PointerByReference, com.sun.jna.ptr.PointerByReference)} instead + * @deprecated use the safer method + * {@link #osvrCreateRenderManagerOpenGL(com.jme3.system.osvr.osvrclientkit.OsvrClientKitLibrary.OSVR_ClientContext, byte[], com.jme3.system.osvr.osvrrendermanageropengl.OSVR_GraphicsLibraryOpenGL.ByValue, com.sun.jna.ptr.PointerByReference, com.sun.jna.ptr.PointerByReference)} + * instead */ @Deprecated public static native byte osvrCreateRenderManagerOpenGL(Pointer clientContext, Pointer graphicsLibraryName, com.jme3.system.osvr.osvrrendermanageropengl.OSVR_GraphicsLibraryOpenGL.ByValue graphicsLibrary, PointerByReference renderManagerOut, PointerByReference renderManagerOpenGLOut); diff --git a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrtimevalue/OsvrTimeValueLibrary.java b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrtimevalue/OsvrTimeValueLibrary.java index 886c16d8f..36382c7ae 100644 --- a/jme3-vr/src/main/java/com/jme3/system/osvr/osvrtimevalue/OsvrTimeValueLibrary.java +++ b/jme3-vr/src/main/java/com/jme3/system/osvr/osvrtimevalue/OsvrTimeValueLibrary.java @@ -19,12 +19,12 @@ public class OsvrTimeValueLibrary implements Library { public static final int OSVR_TRUE = (int)(1); public static final int OSVR_FALSE = (int)(0); /** - * @brief Gets the current time in the TimeValue. Parallel to gettimeofday.
+ * Gets the current time in the TimeValue. Parallel to gettimeofday. * Original signature : void osvrTimeValueGetNow(OSVR_TimeValue*) */ public static native void osvrTimeValueGetNow(OSVR_TimeValue dest); /** - * @brief Converts from a TimeValue struct to your system's struct timeval.
+ * Converts from a TimeValue struct to your system's struct timeval. * @param dest Pointer to an empty struct timeval for your platform.
* @param src A pointer to an OSVR_TimeValue you'd like to convert from.
* If either parameter is NULL, the function will return without doing
@@ -33,7 +33,7 @@ public class OsvrTimeValueLibrary implements Library { */ public static native void osvrTimeValueToStructTimeval(OsvrTimeValueLibrary.timeval dest, OSVR_TimeValue src); /** - * @brief Converts from a TimeValue struct to your system's struct timeval.
+ * Converts from a TimeValue struct to your system's struct timeval. * @param dest An OSVR_TimeValue destination pointer.
* @param src Pointer to a struct timeval you'd like to convert from.
* The result is normalized.
@@ -43,7 +43,7 @@ public class OsvrTimeValueLibrary implements Library { */ public static native void osvrStructTimevalToTimeValue(OSVR_TimeValue dest, OsvrTimeValueLibrary.timeval src); /** - * @brief "Normalizes" a time value so that the absolute number of microseconds
+ * "Normalizes" a time value so that the absolute number of microseconds * is less than 1,000,000, and that the sign of both components is the same.
* @param tv Address of a struct TimeValue to normalize in place.
* If the given pointer is NULL, this function returns without doing anything.
@@ -51,7 +51,7 @@ public class OsvrTimeValueLibrary implements Library { */ public static native void osvrTimeValueNormalize(OSVR_TimeValue tv); /** - * @brief Sums two time values, replacing the first with the result.
+ * Sums two time values, replacing the first with the result. * @param tvA Destination and first source.
* @param tvB second source
* If a given pointer is NULL, this function returns without doing anything.
@@ -60,7 +60,7 @@ public class OsvrTimeValueLibrary implements Library { */ public static native void osvrTimeValueSum(OSVR_TimeValue tvA, OSVR_TimeValue tvB); /** - * @brief Computes the difference between two time values, replacing the first
+ * Computes the difference between two time values, replacing the first * with the result.
* Effectively, `*tvA = *tvA - *tvB`
* @param tvA Destination and first source.
@@ -71,7 +71,7 @@ public class OsvrTimeValueLibrary implements Library { */ public static native void osvrTimeValueDifference(OSVR_TimeValue tvA, OSVR_TimeValue tvB); /** - * @brief Compares two time values (assumed to be normalized), returning
+ * Compares two time values (assumed to be normalized), returning * the same values as strcmp
* @return <0 if A is earlier than B, 0 if they are the same, and >0 if A
* is later than B.
@@ -79,7 +79,7 @@ public class OsvrTimeValueLibrary implements Library { */ public static native int osvrTimeValueCmp(OSVR_TimeValue tvA, OSVR_TimeValue tvB); /** - * @brief Compute the difference between the two time values, returning the
+ * Compute the difference between the two time values, returning the * duration as a double-precision floating-point number of seconds.
* Effectively, `ret = *tvA - *tvB`
* @param tvA first source.
@@ -89,7 +89,7 @@ public class OsvrTimeValueLibrary implements Library { */ public static native double osvrTimeValueDurationSeconds(OSVR_TimeValue tvA, OSVR_TimeValue tvB); /** - * @brief True if A is later than B
+ * True if A is later than B. * Original signature : OSVR_CBool osvrTimeValueGreater(const OSVR_TimeValue*, const OSVR_TimeValue*) */ public static native byte osvrTimeValueGreater(OSVR_TimeValue tvA, OSVR_TimeValue tvB);