Skip to content
Snippets Groups Projects
SharpDX.Mathematics.xml 858 KiB
Newer Older
SCHAAL CESAR's avatar
SCHAAL CESAR committed
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>SharpDX.Mathematics</name>
    </assembly>
    <members>
        <member name="T:SharpDX.AngleSingle">
            <summary>
            Represents a unit independent angle using a single-precision floating-point
            internal representation.
            </summary>
        </member>
        <member name="F:SharpDX.AngleSingle.Degree">
            <summary>
            A value that specifies the size of a single degree.
            </summary>
        </member>
        <member name="F:SharpDX.AngleSingle.Minute">
            <summary>
            A value that specifies the size of a single minute.
            </summary>
        </member>
        <member name="F:SharpDX.AngleSingle.Second">
            <summary>
            A value that specifies the size of a single second.
            </summary>
        </member>
        <member name="F:SharpDX.AngleSingle.Radian">
            <summary>
            A value that specifies the size of a single radian.
            </summary>
        </member>
        <member name="F:SharpDX.AngleSingle.Milliradian">
            <summary>
            A value that specifies the size of a single milliradian.
            </summary>
        </member>
        <member name="F:SharpDX.AngleSingle.Gradian">
            <summary>
            A value that specifies the size of a single gradian.
            </summary>
        </member>
        <member name="F:SharpDX.AngleSingle.radians">
            <summary>
            The internal representation of the angle.
            </summary>
        </member>
        <member name="M:SharpDX.AngleSingle.#ctor(System.Single,SharpDX.AngleType)">
            <summary>
            Initializes a new instance of the SharpDX.AngleSingle structure with the
            given unit dependant angle and unit type.
            </summary>
            <param name="angle">A unit dependant measure of the angle.</param>
            <param name="type">The type of unit the angle argument is.</param>
        </member>
        <member name="M:SharpDX.AngleSingle.#ctor(System.Single,System.Single)">
            <summary>
            Initializes a new instance of the SharpDX.AngleSingle structure using the
            arc length formula (θ = s/r).
            </summary>
            <param name="arcLength">The measure of the arc.</param>
            <param name="radius">The radius of the circle.</param>
        </member>
        <member name="M:SharpDX.AngleSingle.Wrap">
            <summary>
            Wraps this SharpDX.AngleSingle to be in the range [π, -π].
            </summary>
        </member>
        <member name="M:SharpDX.AngleSingle.WrapPositive">
            <summary>
            Wraps this SharpDX.AngleSingle to be in the range [0, 2π).
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.Revolutions">
            <summary>
            Gets or sets the total number of revolutions this SharpDX.AngleSingle represents.
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.Degrees">
            <summary>
            Gets or sets the total number of degrees this SharpDX.AngleSingle represents.
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.Minutes">
            <summary>
            Gets or sets the minutes component of the degrees this SharpDX.AngleSingle represents.
            When setting the minutes, if the value is in the range (-60, 60) the whole degrees are
            not changed; otherwise, the whole degrees may be changed. Fractional values may set
            the seconds component.
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.Seconds">
            <summary>
            Gets or sets the seconds of the degrees this SharpDX.AngleSingle represents.
            When setting the seconds, if the value is in the range (-60, 60) the whole minutes
            or whole degrees are not changed; otherwise, the whole minutes or whole degrees
            may be changed.
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.Radians">
            <summary>
            Gets or sets the total number of radians this SharpDX.AngleSingle represents.
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.Milliradians">
            <summary>
            Gets or sets the total number of milliradians this SharpDX.AngleSingle represents.
            One milliradian is equal to 1/(2000π).
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.Gradians">
            <summary>
            Gets or sets the total number of gradians this SharpDX.AngleSingle represents.
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.IsRight">
            <summary>
            Gets a System.Boolean that determines whether this SharpDX.Angle
            is a right angle (i.e. 90° or π/2).
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.IsStraight">
            <summary>
            Gets a System.Boolean that determines whether this SharpDX.Angle
            is a straight angle (i.e. 180° or π).
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.IsFullRotation">
            <summary>
            Gets a System.Boolean that determines whether this SharpDX.Angle
            is a full rotation angle (i.e. 360° or 2π).
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.IsOblique">
            <summary>
            Gets a System.Boolean that determines whether this SharpDX.Angle
            is an oblique angle (i.e. is not 90° or a multiple of 90°).
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.IsAcute">
            <summary>
            Gets a System.Boolean that determines whether this SharpDX.Angle
            is an acute angle (i.e. less than 90° but greater than 0°).
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.IsObtuse">
            <summary>
            Gets a System.Boolean that determines whether this SharpDX.Angle
            is an obtuse angle (i.e. greater than 90° but less than 180°).
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.IsReflex">
            <summary>
            Gets a System.Boolean that determines whether this SharpDX.Angle
            is a reflex angle (i.e. greater than 180° but less than 360°).
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.Complement">
            <summary>
            Gets a SharpDX.AngleSingle instance that complements this angle (i.e. the two angles add to 90°).
            </summary>
        </member>
        <member name="P:SharpDX.AngleSingle.Supplement">
            <summary>
            Gets a SharpDX.AngleSingle instance that supplements this angle (i.e. the two angles add to 180°).
            </summary>
        </member>
        <member name="M:SharpDX.AngleSingle.Wrap(SharpDX.AngleSingle)">
            <summary>
            Wraps the SharpDX.AngleSingle given in the value argument to be in the range [π, -π].
            </summary>
            <param name="value">A SharpDX.AngleSingle to wrap.</param>
            <returns>The SharpDX.AngleSingle that is wrapped.</returns>
        </member>
        <member name="M:SharpDX.AngleSingle.WrapPositive(SharpDX.AngleSingle)">
            <summary>
            Wraps the SharpDX.AngleSingle given in the value argument to be in the range [0, 2π).
            </summary>
            <param name="value">A SharpDX.AngleSingle to wrap.</param>
            <returns>The SharpDX.AngleSingle that is wrapped.</returns>
        </member>
        <member name="M:SharpDX.AngleSingle.Min(SharpDX.AngleSingle,SharpDX.AngleSingle)">
            <summary>
            Compares two SharpDX.AngleSingle instances and returns the smaller angle.
            </summary>
            <param name="left">The first SharpDX.AngleSingle instance to compare.</param>
            <param name="right">The second SharpDX.AngleSingle instance to compare.</param>
            <returns>The smaller of the two given SharpDX.AngleSingle instances.</returns>
        </member>
        <member name="M:SharpDX.AngleSingle.Max(SharpDX.AngleSingle,SharpDX.AngleSingle)">
            <summary>
            Compares two SharpDX.AngleSingle instances and returns the greater angle.
            </summary>
            <param name="left">The first SharpDX.AngleSingle instance to compare.</param>
            <param name="right">The second SharpDX.AngleSingle instance to compare.</param>
            <returns>The greater of the two given SharpDX.AngleSingle instances.</returns>
        </member>
        <member name="M:SharpDX.AngleSingle.Add(SharpDX.AngleSingle,SharpDX.AngleSingle)">
            <summary>
            Adds two SharpDX.AngleSingle objects and returns the result.
Loading full blame...