class in UnityEngine.XR
/
Inherits from:IntegratedSubsystem
/
Implemented in:UnityEngine.XRModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseAn 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. |
foveatedRenderingFlags | Controls optional behavior of the foveated rendering system. |
foveatedRenderingLevel | Controls the intensity of the foveated rendering system. |
hdrOutputSettings | The HDROutputSettings for the XR Display Subsystem. |
occlusionMaskScale | A scale applied to the standard occulsion mask. |
reprojectionMode | The kind of reprojection the app requests to stabilize its holographic rendering relative to the user's head motion. |
scaleOfAllRenderTargets | Controls the size of the textures submitted to the display as a multiplier of the display's default resolution. |
scaleOfAllViewports | Controls how much of the allocated display texture should be used for rendering. |
supportedTextureLayouts | Specifies all texture layouts supported by this display subsystem. This var is a bit field that could be combination of XRDisplaySubsystem.TextureLayout. |
textureLayout | Set DisplaySubsystem to use certain texture layout. Should query supported texture layout through XRDisplaySubsystem.supportedTextureLayouts first for the capabilities. |
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. |
BeginRecordingIfLateLatched | This function enables late latching recording of constant buffer memory locations which are later patched with the latest pose data. |
EndRecordingIfLateLatched | This function disables late latching recording of constant buffer locations. |
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. |
GetRenderTexture | Given the UnityXRRenderTextureID returned by IUnityXRDisplayInterface::CreateTexture, return the managed UnityEngine.RenderTexture instance. |
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. |
GetSharedDepthTextureForRenderPass | Given a render pass, return the shared depth buffer RenderTexture instance backing that render pass. If the render pass is invalid, or if the render texture does not exist, return null. |
MarkTransformLateLatched | This marks a given GameObject's transform to be late latched in the next frame. Once marked for late latching, the GameObject transform and its descendants will be updated with the latest VR pose updates before rendering is submitted to the GPU. |
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. |
SetMSAALevel | Set MSAA level for the DisplaySubsystem's render texture. |
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.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.