Legacy Documentation: Version 5.4
LanguageEnglish
  • C#
  • JS

Script language

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

SpriteMetaData.pivot

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

public var pivot: Vector2;
public Vector2 pivot;

Description

The pivot point of the Sprite, relative to its bounding rectangle.

The pivot point is usually specified in (x, y) values within a range of (0-1). For example: The upper left of the rectangle is (0,0); the bottom right of the rectangle is (1,1), and the center of the rectangle is (0.5,0.5).

The pivot point can also be placed outside the bounding rectangle. Do this by using values outside the (0-1) range. For example: A position central but far above the bounding rectangle is (0.5,-2). A position in line with the bottom of the bounding rectangle and to the far right outside the bounding rectangle is (3,1).