Version: 2019.1 (switch to 2018.3 or 2017.4)
LanguageEnglish
  • C#

ARBackgroundRenderer

class in UnityEngine.XR

Other Versions
Leave feedback
Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Description

Class 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.

Properties

backgroundMaterialThe Material used for AR rendering.
backgroundTextureAn optional Texture used for AR rendering. If this property is not set then the texture set in ARBackgroundRenderer.backgroundMaterial as "_MainTex" is used.
cameraAn 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.
modeWhen 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.

Protected Methods

DisableARBackgroundRenderingDisables 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.

Events

backgroundRendererChangedCalled when any of the public properties of this class have been changed.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2019 Unity Technologies. Publication: 2019.1-002V. Built: 2019-04-15.
TutorialsCommunity AnswersKnowledge BaseForumsAsset Store