Share via

  • Article

MathHelper.Clamp Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Restricts a value to be within a specified range.

Namespace:  Microsoft.Xna.Framework
Assembly:  Microsoft.Xna.Framework.Math (in Microsoft.Xna.Framework.Math.dll)

Syntax

'Declaration
Public Shared Function Clamp ( _
    value As Single, _
    min As Single, _
    max As Single _
) As Single

public static float Clamp(
    float value,
    float min,
    float max
)

Parameters

  • min
    Type: System.Single
    The minimum value. If value is less than min, min will be returned.
  • max
    Type: System.Single
    The maximum value. If value is greater than max, max will be returned.

Return Value

Type: System.Single
The clamped value.
If value > max, max will be returned.
If value < min, min will be returned.
If min <= value >= max, value will be returned.

Version Information

Silverlight

Supported in: 5

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.