Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ObjectPreview.OnPreviewGUI

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public function OnPreviewGUI(r: Rect, background: GUIStyle): void;
public void OnPreviewGUI(Rect r, GUIStyle background);

Parameters

rRectangle in which to draw the preview.
backgroundBackground image.

Description

Implement to create your own custom preview for the preview area of the inspector, primary editor headers and the object selector.

If you implement OnInteractivePreviewGUI then this will only be called for non-interactive custom previews. The overidden method should use the rectangle passed in and render a preview of the asset into it. The default implementation is a no-op.

See Also: OnInteractivePreviewGUI.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download