Version: 2018.2 (switch to 2018.1 or 2017.4)
LanguageEnglish
  • C#

Sprite.Create

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 static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot, float pixelsPerUnit, uint extrude);
public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot, float pixelsPerUnit, uint extrude, SpriteMeshType meshType);
public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot, float pixelsPerUnit, uint extrude, SpriteMeshType meshType, Vector4 border, bool generateFallbackPhysicsShape);
public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot, float pixelsPerUnit, uint extrude, SpriteMeshType meshType, Vector4 border);
public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot);
public static Sprite Create(Texture2D texture, Rect rect, Vector2 pivot, float pixelsPerUnit);

Parameters

textureTexture from which to obtain the sprite graphic.
rectRectangular section of the texture to use for the sprite.
pivotSprite's pivot point relative to its graphic rectangle.
pixelsPerUnitThe number of pixels in the sprite that correspond to one unit in world space.
extrudeAmount by which the sprite mesh should be expanded outwards.
meshTypeControls the type of mesh generated for the sprite.
borderThe border sizes of the sprite (X=left, Y=bottom, Z=right, W=top).
generateFallbackPhysicsShapeGenerates a default physics shape for the sprite.

Description

Create a new Sprite object.

Sprite.Create creates a new Sprite which can be used in game applications. A texture needs to be loaded and assigned to Create in order to control how the new Sprite will look. In the script example below a new Sprite is displayed when the button is pressed. The new sprite is created in Start.

The second argument rect defines the sub-texture used. The rect argument is defined in pixels of the texture. A Rect(50.0f, 10.0f, 200.0f, 140.0f) would create a left to right range from 50.0f to 50.0f + 200.0f = 250.0f. The bottom to top range would be 10.0f to 10.0f + 140.0f = 150.0f. The third argument pivot determines what becomes the center of the Sprite. This is a Vector2 relative to the rect where Vector2(0.0f, 0.0f) is the bottom left and Vector2(1.0f, 1.0f) is the top right. The pixelsPerUnit value controls the size of the sprite. Reducing this below 100 pixels per world increases the size of the sprite. The extrude value defines the number of pixels which surround the Sprite. This is useful if the Sprite is included in an atlas. meshType selects whether FullRect or Tight is used. Finally border determines the rectangle size of the Sprite. The Sprite can be provided spaces around it.

See Also: SpriteRenderer class.

// Create a Sprite at start-up.
// Assign a texture to the sprite when the button is pressed.

using UnityEngine;

public class spriteCreate : MonoBehaviour { public Texture2D tex; private Sprite mySprite; private SpriteRenderer sr;

void Awake() { sr = gameObject.AddComponent<SpriteRenderer>() as SpriteRenderer; sr.color = new Color(0.9f, 0.9f, 0.9f, 1.0f);

transform.position = new Vector3(1.5f, 1.5f, 0.0f); }

void Start() { mySprite = Sprite.Create(tex, new Rect(0.0f, 0.0f, tex.width, tex.height), new Vector2(0.5f, 0.5f), 100.0f); }

void OnGUI() { if (GUI.Button(new Rect(10, 10, 100, 30), "Add sprite")) { sr.sprite = mySprite; } } }

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