class in UnityEngine.XR
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.
CloseClass used to override a camera's default background rendering path to instead render a given Texture and/or Material. This will typically be used with images from the color camera for rendering the AR background on mobile devices.
backgroundMaterial | The Material used for AR rendering. |
backgroundTexture | An optional Texture used for AR rendering. If this property is not set then the texture set in ARBackgroundRenderer.backgroundMaterial as "_MainTex" is used. |
camera | An optional Camera whose background rendering will be overridden by this class. If this property is not set then the main Camera in the Scene is used. |
mode | When set to ARRenderMode.StandardBackground (default) the camera is not overridden to display the background image. Setting this property to ARRenderMode.MaterialAsBackground will render the texture specified by ARBackgroundRenderer.backgroundMaterial and or ARBackgroundRenderer.backgroundTexture as the background. |
DisableARBackgroundRendering | Disables AR background rendering. This method is called internally but can be overridden by users who wish to subclass ARBackgroundRenderer to customize handling of AR background rendering. |
backgroundRendererChanged | Called when any of the public properties of this class have been changed. |
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:
Thanks for helping to make the Unity documentation better!