Package org.lwjgl.ovr

Class OVRVk


  • public class OVRVk
    extends java.lang.Object
    Native bindings to libOVR, using the Oculus SDK C API.

    This class contains Vulkan specific functionality.

    • Method Detail

      • novr_GetInstanceExtensionsVk

        public static int novr_GetInstanceExtensionsVk​(long luid,
                                                       long extensionNames,
                                                       long inoutExtensionNamesSize)
        Unsafe version of: GetInstanceExtensionsVk
        Parameters:
        inoutExtensionNamesSize - indicates on input the capacity of extensionNames in chars. On output it returns the number of characters written to extensionNames, including the terminating 0 char. In the case of this function returning Error_InsufficientArraySize, the required inoutExtensionNamesSize is returned.
      • ovr_GetInstanceExtensionsVk

        public static int ovr_GetInstanceExtensionsVk​(OVRGraphicsLuid luid,
                                                      java.nio.ByteBuffer extensionNames,
                                                      java.nio.IntBuffer inoutExtensionNamesSize)
        Gets a list of Vulkan vkInstance extensions required for VR.

        Returns a list of strings delimited by a single space identifying Vulkan extensions that must be enabled in order for the VR runtime to support Vulkan-based applications. The returned list reflects the current runtime version and the GPU the VR system is currently connected to.

        Example code:

        
          char extensionNames[4096];
          uint32_t extensionNamesSize = sizeof(extensionNames);
          ovr_GetInstanceExtensionsVk(luid, extensionsnames, &extensionNamesSize);
         
          uint32_t extensionCount = 0;
          const char* extensionNamePtrs[256];
          for(const char* p = extensionNames; *p; ++p) {
              if((p == extensionNames) || (p[-1] == ' ')) {
                  extensionNamePtrs[extensionCount++] = p;
                  if (p[-1] == ' ')
                      p[-1] = '\0';
              }
          }
         
          VkInstanceCreateInfo info = { ... };
          info.enabledExtensionCount = extensionCount;
          info.ppEnabledExtensionNames = extensionNamePtrs;
          [...]
        Parameters:
        luid - specifies the luid for the relevant GPU, which is returned from Create.
        extensionNames - a character buffer which will receive a list of extension name strings, separated by a single space char between each extension
        inoutExtensionNamesSize - indicates on input the capacity of extensionNames in chars. On output it returns the number of characters written to extensionNames, including the terminating 0 char. In the case of this function returning Error_InsufficientArraySize, the required inoutExtensionNamesSize is returned.
        Returns:
        an ovrResult indicating success or failure. In the case of failure, use GetLastErrorInfo to get more information. Returns Error_InsufficientArraySize in the case that inoutExtensionNameSize didn't have enough space, in which case inoutExtensionNameSize will return the required inoutExtensionNamesSize.
      • novr_GetDeviceExtensionsVk

        public static int novr_GetDeviceExtensionsVk​(long luid,
                                                     long extensionNames,
                                                     long inoutExtensionNamesSize)
        Unsafe version of: GetDeviceExtensionsVk
        Parameters:
        inoutExtensionNamesSize - indicates on input the capacity of extensionNames in chars. On output it returns the number of characters written to extensionNames, including the terminating 0 char. In the case of this function returning Error_InsufficientArraySize, the required inoutExtensionNamesSize is returned.
      • ovr_GetDeviceExtensionsVk

        public static int ovr_GetDeviceExtensionsVk​(OVRGraphicsLuid luid,
                                                    java.nio.ByteBuffer extensionNames,
                                                    java.nio.IntBuffer inoutExtensionNamesSize)
        Gets a list of Vulkan vkDevice extensions required for VR.

        Returns a list of strings delimited by a single space identifying Vulkan extensions that must be enabled in order for the VR runtime to support Vulkan-based applications. The returned list reflects the current runtime version and the GPU the VR system is currently connected to.

        Parameters:
        luid - specifies the luid for the relevant GPU, which is returned from Create.
        extensionNames - a character buffer which will receive a list of extension name strings, separated by a single space char between each extension
        inoutExtensionNamesSize - indicates on input the capacity of extensionNames in chars. On output it returns the number of characters written to extensionNames, including the terminating 0 char. In the case of this function returning Error_InsufficientArraySize, the required inoutExtensionNamesSize is returned.
        Returns:
        an ovrResult indicating success or failure. In the case of failure, use GetLastErrorInfo to get more information. Returns Error_InsufficientArraySize in the case that inoutExtensionNameSize didn't have enough space, in which case inoutExtensionNameSize will return the required inoutExtensionNamesSize.
      • novr_GetSessionPhysicalDeviceVk

        public static int novr_GetSessionPhysicalDeviceVk​(long session,
                                                          long luid,
                                                          long instance,
                                                          long out_physicalDevice)
        Unsafe version of: GetSessionPhysicalDeviceVk
      • ovr_GetSessionPhysicalDeviceVk

        public static int ovr_GetSessionPhysicalDeviceVk​(long session,
                                                         OVRGraphicsLuid luid,
                                                         VkInstance instance,
                                                         PointerBuffer out_physicalDevice)
        Finds VkPhysicalDevice matching ovrGraphicsLuid.
        Note

        This function enumerates the current physical devices and returns the one matching the luid. It must be called at least once prior to any CreateTextureSwapChainVk or CreateMirrorTextureWithOptionsVk calls, and the instance must remain valid for the lifetime of the returned objects. It is assumed the VkDevice created by the application will be for the returned physical device.

        Parameters:
        session - an ovrSession previously returned by Create
        luid - the luid returned from Create
        instance - a VkInstance to search for matching luids in
        out_physicalDevice - returns the VkPhysicalDevice matching the instance and luid
        Returns:
        an ovrResult indicating success or failure. In the case of failure, use GetLastErrorInfo to get more information.
      • novr_SetSynchronizationQueueVk

        public static int novr_SetSynchronizationQueueVk​(long session,
                                                         long queue)
        Unsafe version of: SetSynchronizationQueueVk
      • ovr_SetSynchronizationQueueVk

        public static int ovr_SetSynchronizationQueueVk​(long session,
                                                        VkQueue queue)
        Selects VkQueue to block on till rendering is complete.
        Note

        The queue may be changed at any time but only the value at the time SubmitFrame is called will be used. ovr_SetSynchronizationQueueVk must be called with a valid VkQueue created on the same VkDevice the texture sets were created on prior to the first call to SubmitFrame. An internally created VkFence object will be signalled by the completion of operations on queue and waited on to synchronize the VR compositor.

        Parameters:
        session - an ovrSession previously returned by Create
        queue - a VkQueue to add a VkFence operation to and wait on
        Returns:
        an ovrResult indicating success or failure. In the case of failure, use GetLastErrorInfo to get more information.
      • novr_CreateTextureSwapChainVk

        public static int novr_CreateTextureSwapChainVk​(long session,
                                                        long device,
                                                        long desc,
                                                        long out_TextureSwapChain)
        Unsafe version of: CreateTextureSwapChainVk
      • ovr_CreateTextureSwapChainVk

        public static int ovr_CreateTextureSwapChainVk​(long session,
                                                       VkDevice device,
                                                       OVRTextureSwapChainDesc desc,
                                                       PointerBuffer out_TextureSwapChain)
        Creates Texture Swap Chain suitable for use with Vulkan.
        Note

        The texture format provided in desc should be thought of as the format the distortion-compositor will use for the ShaderResourceView when reading the contents of the texture. To that end, it is highly recommended that the application requests texture swapchain formats that are in sRGB-space (e.g. OVR.OVR_FORMAT_R8G8B8A8_UNORM_SRGB) as the compositor does sRGB-correct rendering. As such, the compositor relies on the GPU's hardware sampler to do the sRGB-to-linear conversion. If the application still prefers to render to a linear format (e.g. OVR.OVR_FORMAT_R8G8B8A8_UNORM) while handling the linear-to-gamma conversion via SPIRV code, then the application must still request the corresponding sRGB format and also use the TextureMisc_DX_Typeless flag in the ovrTextureSwapChainDesc's Flag field. This will allow the application to create a RenderTargetView that is the desired linear format while the compositor continues to treat it as sRGB. Failure to do so will cause the compositor to apply unexpected gamma conversions leading to gamma-curve artifacts. The TextureMisc_DX_Typeless flag for depth buffer formats (e.g. OVR.OVR_FORMAT_D32_FLOAT) is ignored as they are always converted to be typeless.

        Parameters:
        session - an ovrSession previously returned by Create
        device - the application's VkDevice to create resources with
        desc - specifies requested texture properties. See notes for more info about texture format.
        out_TextureSwapChain - returns the created ovrTextureSwapChain, which will be valid upon a successful return value, else it will be NULL. This texture chain must be eventually destroyed via DestroyTextureSwapChain before destroying the session with Destroy.
        Returns:
        an ovrResult indicating success or failure. In the case of failure, use GetLastErrorInfo to get more information.
      • novr_GetTextureSwapChainBufferVk

        public static int novr_GetTextureSwapChainBufferVk​(long session,
                                                           long chain,
                                                           int index,
                                                           long out_Image)
        Unsafe version of: GetTextureSwapChainBufferVk
      • ovr_GetTextureSwapChainBufferVk

        public static int ovr_GetTextureSwapChainBufferVk​(long session,
                                                          long chain,
                                                          int index,
                                                          java.nio.LongBuffer out_Image)
        Gets a specific VkImage within the chain.
        Parameters:
        session - an ovrSession previously returned by Create
        chain - an ovrTextureSwapChain previously returned by CreateTextureSwapChainVk
        index - the index within the chain to retrieve. Must be between 0 and length (see GetTextureSwapChainLength), or may pass -1 to get the buffer at the CurrentIndex location (saving a call to GetTextureSwapChainCurrentIndex).
        Returns:
        an ovrResult indicating success or failure. In the case of failure, use GetLastErrorInfo to get more information.
      • novr_CreateMirrorTextureWithOptionsVk

        public static int novr_CreateMirrorTextureWithOptionsVk​(long session,
                                                                long device,
                                                                long desc,
                                                                long out_MirrorTexture)
      • ovr_CreateMirrorTextureWithOptionsVk

        public static int ovr_CreateMirrorTextureWithOptionsVk​(long session,
                                                               VkDevice device,
                                                               OVRMirrorTextureDesc desc,
                                                               PointerBuffer out_MirrorTexture)
        Creates Mirror Texture which is auto-refreshed to mirror Rift contents produced by this application.

        A second call to ovr_CreateMirrorTextureWithOptionsVk for a given ovrSession before destroying the first one is not supported and will result in an error return.

        Note

        The texture format provided in desc should be thought of as the format the compositor will use for the VkImageView when writing into mirror texture. To that end, it is highly recommended that the application requests a mirror texture format that is in sRGB-space (e.g. OVR.OVR_FORMAT_R8G8B8A8_UNORM_SRGB) as the compositor does sRGB-correct rendering. If however the application wants to still read the mirror texture as a linear format (e.g. OVR.OVR_FORMAT_R8G8B8A8_UNORM) and handle the sRGB-to-linear conversion in SPIRV code, then it is recommended the application still requests an sRGB format and also use the TextureMisc_DX_Typeless flag in the ovrMirrorTextureDesc's Flags field. This will allow the application to bind a ShaderResourceView that is a linear format while the compositor continues to treat is as sRGB. Failure to do so will cause the compositor to apply unexpected gamma conversions leading to gamma-curve artifacts.

        Parameters:
        session - an ovrSession previously returned by Create
        device - the VkDevice to create resources with
        desc - specifies requested texture properties. See notes for more info about texture format.
        out_MirrorTexture - returns the created ovrMirrorTexture, which will be valid upon a successful return value, else it will be NULL. This texture must be eventually destroyed via DestroyMirrorTexture before destroying the session with Destroy.
        Returns:
        an ovrResult indicating success or failure. In the case of failure, use GetLastErrorInfo to get more information.
      • novr_GetMirrorTextureBufferVk

        public static int novr_GetMirrorTextureBufferVk​(long session,
                                                        long mirrorTexture,
                                                        long out_Image)
        Unsafe version of: GetMirrorTextureBufferVk
      • ovr_GetMirrorTextureBufferVk

        public static int ovr_GetMirrorTextureBufferVk​(long session,
                                                       long mirrorTexture,
                                                       java.nio.LongBuffer out_Image)
        Gets the underlying mirror VkImage.
        Parameters:
        session - an ovrSession previously returned by Create
        mirrorTexture - an ovrMirrorTexture previously returned by CreateMirrorTextureWithOptionsVk
        out_Image - returns the VkImage pointer retrieved
        Returns:
        an ovrResult indicating success or failure. In the case of failure, use GetLastErrorInfo to get more information.
      • ovr_GetInstanceExtensionsVk

        public static int ovr_GetInstanceExtensionsVk​(OVRGraphicsLuid luid,
                                                      java.nio.ByteBuffer extensionNames,
                                                      int[] inoutExtensionNamesSize)
        Array version of: GetInstanceExtensionsVk
      • ovr_GetDeviceExtensionsVk

        public static int ovr_GetDeviceExtensionsVk​(OVRGraphicsLuid luid,
                                                    java.nio.ByteBuffer extensionNames,
                                                    int[] inoutExtensionNamesSize)
        Array version of: GetDeviceExtensionsVk
      • ovr_GetTextureSwapChainBufferVk

        public static int ovr_GetTextureSwapChainBufferVk​(long session,
                                                          long chain,
                                                          int index,
                                                          long[] out_Image)
        Array version of: GetTextureSwapChainBufferVk
      • ovr_GetMirrorTextureBufferVk

        public static int ovr_GetMirrorTextureBufferVk​(long session,
                                                       long mirrorTexture,
                                                       long[] out_Image)
        Array version of: GetMirrorTextureBufferVk