Version: 2019.1 (switch to 2018.3 or 2017.4)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

ISpriteEditor.SetPreviewTexture

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

public void SetPreviewTexture(Texture2D texture, int width, int height);

Parameters

textureThe custom preview texture.
widthThe width dimension to render the preview texture.
heightThe height dimension to render the preview texture.

Description

Sets a custom texture to be used by the ISpriteEditor during setup of the editing space.

When the method is called, the editing space's dimensions are set to the width and height values, affecting operations such as Zoom and Pan in the ISpriteEditor view. The preview texture is rendered as the background of the editing space.

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