An XRDisplaySubsystem controls rendering to a head tracked display.
contentProtectionEnabled | Sets or gets the state of content protection for the current active provider. For most providers, content protection allows you to use write only textures for rendering. This stops the ability for apps to read textures from the graphics card and view/record images that may be protected in some way. |
disableLegacyRenderer | Disables the legacy renderer while this XRDisplaySubsystem is active. |
displayOpaque | Determines if the current attached device has an opaque display. Most VR devices are opaque in order to increase the immersive experience, AR devices are transparent to allow for interaction with an augmentation of the current environment. |
reprojectionMode | The kind of reprojection the app requests to stabilize its holographic rendering relative to the user's head motion. |
singlePassRenderingDisabled | Returns true when single pass stereo rendering is disabled and returns false if otherwise. |
zFar | Set DisplaySubsystem to use zFar for rendering. |
zNear | Set DisplaySubsystem to use zNear for rendering. |
AddGraphicsThreadMirrorViewBlit | This function records the display subsystem's native blit event to the target command buffer. This function is typically called by a scriptable rendering pipeline. |
GetCullingParameters | Gets culling parameters for a specific culling pass index. |
GetMirrorViewBlitDesc | Get a mirror view blit operation descriptor from the current display subsystem. |
GetPreferredMirrorBlitMode | Returns the XR display's preferred mirror blit mode. |
GetRenderPass | Gets an XRRenderPass of a specific index. |
GetRenderPassCount | The number of XRRenderPass entries for this XR Display. |
GetRenderTextureForRenderPass | Given a render pass, return the RenderTexture instance backing that render pass. If the render pass is invalid, or if the render texture does not exist, return null. |
SetFocusPlane | Sets a point in 3D space that acts as the focal point of the Scene for this frame. This helps to improve the visual fidelity of content around this point. You must set this value every frame. Note that specifying body-locked content in focus improves the fidelity of body-locked content at the expense of content not locked to the body. This is especially apparent when the user moves. |
SetPreferredMirrorBlitMode | Override the XR display's preferred mirror blit mode from the script. |
TryGetAppGPUTimeLastFrame | Retrieves the time the GPU has spent on executing commands from the application's last frame, as reported by the XR Plugin. Measured in seconds. |
TryGetCompositorGPUTimeLastFrame | Retrieves the amount of time that the GPU spent executing the compositor renderer during the last frame, as reported by the XR Plugin. Measured in seconds. |
TryGetDisplayRefreshRate | Retrieves the refresh rate of the display as reported by the XR Plugin. |
TryGetDroppedFrameCount | Retrieves the number of dropped frames reported by the XR Plugin. |
TryGetFramePresentCount | Retrieves the number of times the current frame has been drawn to the device as reported by the XR Plugin. |
TryGetMotionToPhoton | Retrieves the motion-to-photon value as reported by the XR Plugin. |
displayFocusChanged | Event sent when XR display focus changes. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.