Version: 2021.3
LanguageEnglish
  • C#

Handles.SnapValue

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

Declaration

public static float SnapValue(float value, float snap);

Parameters

value The value to snap.
snap The increment to snap to.

Returns

float If snapping is active, rounds value to the closest multiple of snap (snap can only be positive).

Description

Rounds value to the closest multiple of snap if snapping is active. Note that snap can only be positive.


Declaration

public static Vector3 SnapValue(Vector3 value, Vector3 snap);

Parameters

value The value to snap.
snap The increment to snap to.

Returns

Vector3 If snapping is active, rounds value to the closest multiple of snap (snap can only be positive).

Description

Rounds value to the closest multiple of snap if snapping is active. Note that snap can only be positive.


Declaration

public static Vector2 SnapValue(Vector2 value, Vector2 snap);

Parameters

value The value to snap.
snap The increment to snap to.

Returns

Vector2 If snapping is active, rounds value to the closest multiple of snap (snap can only be positive).

Description

Rounds value to the closest multiple of snap if snapping is active. Note that snap can only be positive.