Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

Sprite.GetPhysicsOutline

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

Switch to Manual

Declaration

public ReadOnlySpan<Vector2> GetPhysicsOutline(int outlineIndex);

Parameters

Parameter Description
outlineIndex The index of the physics outline to retrieve.

Returns

ReadOnlySpan<Vector2> The physics outline as a span of vertices. It is recommended that you immediately extract what information you need and not directly reference the returned data as any subsequent change to the physics outline(s) could result in a crash when iterating the span.

Description

Gets a physics outline from the Sprite by its index.

A physics outline is a cyclic sequence of line segments between points that define the outline of the Sprite used for physics. Since the Sprite can have holes and discontinuous parts, it can be made up of more than one physics outline.


Declaration

public int GetPhysicsOutline(int outlineIndex, List<Vector2> physicsOutline);

Parameters

Parameter Description
outlineIndex The index of the physics outline to retrieve.
physicsOutline An ordered list of the points in the selected physics outline to store points in.

Returns

int The number of points stored in the given list.

Description

Gets a physics outline from the Sprite by its index.

A physics outline is a cyclic sequence of line segments between points that define the outline of the Sprite used for physics. Since the Sprite can have holes and discontinuous parts, it can be made up of more than one physics outline.