|
- <?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.
- </summary>
- <param name="left">The first object to add.</param>
- <param name="right">The second object to add.</param>
- <returns>The value of the two objects added together.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.Subtract(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Subtracts two SharpDX.AngleSingle objects and returns the result.
- </summary>
- <param name="left">The first object to subtract.</param>
- <param name="right">The second object to subtract.</param>
- <returns>The value of the two objects subtracted.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.Multiply(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Multiplies two SharpDX.AngleSingle objects and returns the result.
- </summary>
- <param name="left">The first object to multiply.</param>
- <param name="right">The second object to multiply.</param>
- <returns>The value of the two objects multiplied together.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.Divide(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Divides two SharpDX.AngleSingle objects and returns the result.
- </summary>
- <param name="left">The numerator object.</param>
- <param name="right">The denominator object.</param>
- <returns>The value of the two objects divided.</returns>
- </member>
- <member name="P:SharpDX.AngleSingle.ZeroAngle">
- <summary>
- Gets a new SharpDX.AngleSingle instance that represents the zero angle (i.e. 0°).
- </summary>
- </member>
- <member name="P:SharpDX.AngleSingle.RightAngle">
- <summary>
- Gets a new SharpDX.AngleSingle instance that represents the right angle (i.e. 90° or π/2).
- </summary>
- </member>
- <member name="P:SharpDX.AngleSingle.StraightAngle">
- <summary>
- Gets a new SharpDX.AngleSingle instance that represents the straight angle (i.e. 180° or π).
- </summary>
- </member>
- <member name="P:SharpDX.AngleSingle.FullRotationAngle">
- <summary>
- Gets a new SharpDX.AngleSingle instance that represents the full rotation angle (i.e. 360° or 2π).
- </summary>
- </member>
- <member name="M:SharpDX.AngleSingle.op_Equality(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Returns a System.Boolean that indicates whether the values of two SharpDX.Angle
- objects are equal.
- </summary>
- <param name="left">The first object to compare.</param>
- <param name="right">The second object to compare.</param>
- <returns>True if the left and right parameters have the same value; otherwise, false.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_Inequality(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Returns a System.Boolean that indicates whether the values of two SharpDX.Angle
- objects are not equal.
- </summary>
- <param name="left">The first object to compare.</param>
- <param name="right">The second object to compare.</param>
- <returns>True if the left and right parameters do not have the same value; otherwise, false.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_LessThan(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Returns a System.Boolean that indicates whether a SharpDX.Angle
- object is less than another SharpDX.AngleSingle object.
- </summary>
- <param name="left">The first object to compare.</param>
- <param name="right">The second object to compare.</param>
- <returns>True if left is less than right; otherwise, false.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_GreaterThan(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Returns a System.Boolean that indicates whether a SharpDX.Angle
- object is greater than another SharpDX.AngleSingle object.
- </summary>
- <param name="left">The first object to compare.</param>
- <param name="right">The second object to compare.</param>
- <returns>True if left is greater than right; otherwise, false.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_LessThanOrEqual(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Returns a System.Boolean that indicates whether a SharpDX.Angle
- object is less than or equal to another SharpDX.AngleSingle object.
- </summary>
- <param name="left">The first object to compare.</param>
- <param name="right">The second object to compare.</param>
- <returns>True if left is less than or equal to right; otherwise, false.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_GreaterThanOrEqual(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Returns a System.Boolean that indicates whether a SharpDX.Angle
- object is greater than or equal to another SharpDX.AngleSingle object.
- </summary>
- <param name="left">The first object to compare.</param>
- <param name="right">The second object to compare.</param>
- <returns>True if left is greater than or equal to right; otherwise, false.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_UnaryPlus(SharpDX.AngleSingle)">
- <summary>
- Returns the value of the SharpDX.AngleSingle operand. (The sign of
- the operand is unchanged.)
- </summary>
- <param name="value">A SharpDX.AngleSingle object.</param>
- <returns>The value of the value parameter.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_UnaryNegation(SharpDX.AngleSingle)">
- <summary>
- Returns the the negated value of the SharpDX.AngleSingle operand.
- </summary>
- <param name="value">A SharpDX.AngleSingle object.</param>
- <returns>The negated value of the value parameter.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_Addition(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Adds two SharpDX.AngleSingle objects and returns the result.
- </summary>
- <param name="left">The first object to add.</param>
- <param name="right">The second object to add.</param>
- <returns>The value of the two objects added together.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_Subtraction(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Subtracts two SharpDX.AngleSingle objects and returns the result.
- </summary>
- <param name="left">The first object to subtract</param>
- <param name="right">The second object to subtract.</param>
- <returns>The value of the two objects subtracted.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_Multiply(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Multiplies two SharpDX.AngleSingle objects and returns the result.
- </summary>
- <param name="left">The first object to multiply.</param>
- <param name="right">The second object to multiply.</param>
- <returns>The value of the two objects multiplied together.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.op_Division(SharpDX.AngleSingle,SharpDX.AngleSingle)">
- <summary>
- Divides two SharpDX.AngleSingle objects and returns the result.
- </summary>
- <param name="left">The numerator object.</param>
- <param name="right">The denominator object.</param>
- <returns>The value of the two objects divided.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.CompareTo(System.Object)">
- <summary>
- Compares this instance to a specified object and returns an integer that
- indicates whether the value of this instance is less than, equal to, or greater
- than the value of the specified object.
- </summary>
- <param name="other">The object to compare.</param>
- <returns>
- A signed integer that indicates the relationship of the current instance
- to the obj parameter. If the value is less than zero, the current instance
- is less than the other. If the value is zero, the current instance is equal
- to the other. If the value is greater than zero, the current instance is
- greater than the other.
- </returns>
- </member>
- <member name="M:SharpDX.AngleSingle.CompareTo(SharpDX.AngleSingle)">
- <summary>
- Compares this instance to a second SharpDX.AngleSingle and returns
- an integer that indicates whether the value of this instance is less than,
- equal to, or greater than the value of the specified object.
- </summary>
- <param name="other">The object to compare.</param>
- <returns>
- A signed integer that indicates the relationship of the current instance
- to the obj parameter. If the value is less than zero, the current instance
- is less than the other. If the value is zero, the current instance is equal
- to the other. If the value is greater than zero, the current instance is
- greater than the other.
- </returns>
- </member>
- <member name="M:SharpDX.AngleSingle.Equals(SharpDX.AngleSingle)">
- <summary>
- Returns a value that indicates whether the current instance and a specified
- SharpDX.AngleSingle object have the same value.
- </summary>
- <param name="other">The object to compare.</param>
- <returns>
- Returns true if this SharpDX.AngleSingle object and another have the same value;
- otherwise, false.
- </returns>
- </member>
- <member name="M:SharpDX.AngleSingle.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.AngleSingle.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.AngleSingle.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.AngleSingle.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.AngleSingle.GetHashCode">
- <summary>
- Returns a hash code for this SharpDX.AngleSingle instance.
- </summary>
- <returns>A 32-bit signed integer hash code.</returns>
- </member>
- <member name="M:SharpDX.AngleSingle.Equals(System.Object)">
- <summary>
- Returns a value that indicates whether the current instance and a specified
- object have the same value.
- </summary>
- <param name="obj">The object to compare.</param>
- <returns>
- Returns true if the obj parameter is a SharpDX.AngleSingle object or a type
- capable of implicit conversion to a SharpDX.AngleSingle value, and
- its value is equal to the value of the current SharpDX.Angle
- object; otherwise, false.
- </returns>
- </member>
- <member name="T:SharpDX.Mathematics.AssemblyDoc">
- <summary>
- The <see cref="A:SharpDX.Mathematics"/> assembly is a managed Math API.
- </summary>
- </member>
- <member name="T:SharpDX.Mathematics.NamespaceDoc">
- <summary>
- The <see cref="N:SharpDX.Mathematics"/> namespace provides managed Direct3D Compiler API.
- </summary>
- <msdn-id>dd607340</msdn-id>
- <unmanaged>Math</unmanaged>
- <unmanaged-short>Math</unmanaged-short>
- </member>
- <member name="T:SharpDX.Bool4">
- <summary>
- Represents a four dimensional mathematical vector of bool (32 bits per bool value).
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.SizeInBytes">
- <summary>
- The size of the <see cref = "T:SharpDX.Bool4" /> type, in bytes.
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.False">
- <summary>
- A <see cref = "T:SharpDX.Bool4" /> with all of its components set to false.
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.UnitX">
- <summary>
- The X unit <see cref = "T:SharpDX.Bool4" /> (true, 0, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.UnitY">
- <summary>
- The Y unit <see cref = "T:SharpDX.Bool4" /> (0, true, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.UnitZ">
- <summary>
- The Z unit <see cref = "T:SharpDX.Bool4" /> (0, 0, true, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.UnitW">
- <summary>
- The W unit <see cref = "T:SharpDX.Bool4" /> (0, 0, 0, true).
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.One">
- <summary>
- A <see cref = "T:SharpDX.Bool4" /> with all of its components set to true.
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.iX">
- <summary>
- The X component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.iY">
- <summary>
- The Y component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.iZ">
- <summary>
- The Z component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Bool4.iW">
- <summary>
- The W component of the vector.
- </summary>
- </member>
- <member name="P:SharpDX.Bool4.X">
- <summary>
- The X component of the vector.
- </summary>
- </member>
- <member name="P:SharpDX.Bool4.Y">
- <summary>
- The Y component of the vector.
- </summary>
- </member>
- <member name="P:SharpDX.Bool4.Z">
- <summary>
- The Z component of the vector.
- </summary>
- </member>
- <member name="P:SharpDX.Bool4.W">
- <summary>
- The W component of the vector.
- </summary>
- </member>
- <member name="M:SharpDX.Bool4.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Bool4" /> struct.
- </summary>
- <param name = "value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Bool4.#ctor(System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Bool4" /> struct.
- </summary>
- <param name = "x">Initial value for the X component of the vector.</param>
- <param name = "y">Initial value for the Y component of the vector.</param>
- <param name = "z">Initial value for the Z component of the vector.</param>
- <param name = "w">Initial value for the W component of the vector.</param>
- </member>
- <member name="M:SharpDX.Bool4.#ctor(System.Boolean[])">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Bool4" /> struct.
- </summary>
- <param name = "values">The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements.</param>
- <exception cref = "T:System.ArgumentNullException">Thrown when <paramref name = "values" /> is <c>null</c>.</exception>
- <exception cref = "T:System.ArgumentOutOfRangeException">Thrown when <paramref name = "values" /> contains more or less than four elements.</exception>
- </member>
- <member name="P:SharpDX.Bool4.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the X, Y, Z, or W component, depending on the index.</value>
- <param name = "index">The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref = "T:System.ArgumentOutOfRangeException">Thrown when the <paramref name = "index" /> is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Bool4.ToArray">
- <summary>
- Creates an array containing the elements of the vector.
- </summary>
- <returns>A four-element array containing the components of the vector.</returns>
- </member>
- <member name="M:SharpDX.Bool4.op_Equality(SharpDX.Bool4,SharpDX.Bool4)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name = "left">The first value to compare.</param>
- <param name = "right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name = "left" /> has the same value as <paramref name = "right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Bool4.op_Inequality(SharpDX.Bool4,SharpDX.Bool4)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name = "left">The first value to compare.</param>
- <param name = "right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name = "left" /> has a different value than <paramref name = "right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Bool4.ToString">
- <summary>
- Returns a <see cref = "T:System.String" /> that represents this instance.
- </summary>
- <returns>
- A <see cref = "T:System.String" /> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Bool4.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Bool4.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Bool4.Equals(SharpDX.Bool4@)">
- <summary>
- Determines whether the specified <see cref = "T:SharpDX.Bool4" /> is equal to this instance.
- </summary>
- <param name = "other">The <see cref = "T:SharpDX.Bool4" /> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref = "T:SharpDX.Bool4" /> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Bool4.Equals(SharpDX.Bool4)">
- <summary>
- Determines whether the specified <see cref = "T:SharpDX.Bool4" /> is equal to this instance.
- </summary>
- <param name = "other">The <see cref = "T:SharpDX.Bool4" /> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref = "T:SharpDX.Bool4" /> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Bool4.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref = "T:System.Object" /> is equal to this instance.
- </summary>
- <param name = "value">The <see cref = "T:System.Object" /> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref = "T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Bool4.op_Implicit(System.Boolean[])~SharpDX.Bool4">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Int32"/> array to <see cref="T:SharpDX.Bool4"/>.
- </summary>
- <param name="input">The input.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Bool4.op_Implicit(SharpDX.Bool4)~System.Boolean[]">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Bool4"/> to <see cref="T:System.Int32"/> array.
- </summary>
- <param name="input">The input.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Bool4.op_Implicit(SharpDX.Bool4)~SharpDX.Mathematics.Interop.RawBool4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Bool4"/> to <see cref="T:SharpDX.Mathematics.Interop.RawBool4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Bool4.op_Implicit(SharpDX.Mathematics.Interop.RawBool4)~SharpDX.Bool4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawBool4"/> to <see cref="T:SharpDX.Bool4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.BoundingBox">
- <summary>
- Represents an axis-aligned bounding box in three dimensional space.
- </summary>
- </member>
- <member name="F:SharpDX.BoundingBox.Minimum">
- <summary>
- The minimum point of the box.
- </summary>
- </member>
- <member name="F:SharpDX.BoundingBox.Maximum">
- <summary>
- The maximum point of the box.
- </summary>
- </member>
- <member name="M:SharpDX.BoundingBox.#ctor(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.BoundingBox"/> struct.
- </summary>
- <param name="minimum">The minimum vertex of the bounding box.</param>
- <param name="maximum">The maximum vertex of the bounding box.</param>
- </member>
- <member name="M:SharpDX.BoundingBox.GetCorners">
- <summary>
- Retrieves the eight corners of the bounding box.
- </summary>
- <returns>An array of points representing the eight corners of the bounding box.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.GetCorners(SharpDX.Vector3[])">
- <summary>
- Retrieves the eight corners of the bounding box.
- </summary>
- <returns>An array of points representing the eight corners of the bounding box.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Intersects(SharpDX.Ray@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Intersects(SharpDX.Ray@,System.Single@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Intersects(SharpDX.Ray@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Intersects(SharpDX.Plane@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="plane">The plane to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Intersects(SharpDX.BoundingBox@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Intersects(SharpDX.BoundingBox)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Intersects(SharpDX.BoundingSphere@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Intersects(SharpDX.BoundingSphere)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Contains(SharpDX.Vector3@)">
- <summary>
- Determines whether the current objects contains a point.
- </summary>
- <param name="point">The point to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Contains(SharpDX.Vector3)">
- <summary>
- Determines whether the current objects contains a point.
- </summary>
- <param name="point">The point to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Contains(SharpDX.BoundingBox@)">
- <summary>
- Determines whether the current objects contains a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Contains(SharpDX.BoundingBox)">
- <summary>
- Determines whether the current objects contains a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Contains(SharpDX.BoundingSphere@)">
- <summary>
- Determines whether the current objects contains a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Contains(SharpDX.BoundingSphere)">
- <summary>
- Determines whether the current objects contains a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.FromPoints(SharpDX.Vector3[],SharpDX.BoundingBox@)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingBox"/> that fully contains the given points.
- </summary>
- <param name="points">The points that will be contained by the box.</param>
- <param name="result">When the method completes, contains the newly constructed bounding box.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="points"/> is <c>null</c>.</exception>
- </member>
- <member name="M:SharpDX.BoundingBox.FromPoints(SharpDX.Vector3[])">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingBox"/> that fully contains the given points.
- </summary>
- <param name="points">The points that will be contained by the box.</param>
- <returns>The newly constructed bounding box.</returns>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="points"/> is <c>null</c>.</exception>
- </member>
- <member name="M:SharpDX.BoundingBox.FromSphere(SharpDX.BoundingSphere@,SharpDX.BoundingBox@)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingBox"/> from a given sphere.
- </summary>
- <param name="sphere">The sphere that will designate the extents of the box.</param>
- <param name="result">When the method completes, contains the newly constructed bounding box.</param>
- </member>
- <member name="M:SharpDX.BoundingBox.FromSphere(SharpDX.BoundingSphere)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingBox"/> from a given sphere.
- </summary>
- <param name="sphere">The sphere that will designate the extents of the box.</param>
- <returns>The newly constructed bounding box.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Merge(SharpDX.BoundingBox@,SharpDX.BoundingBox@,SharpDX.BoundingBox@)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingBox"/> that is as large as the total combined area of the two specified boxes.
- </summary>
- <param name="value1">The first box to merge.</param>
- <param name="value2">The second box to merge.</param>
- <param name="result">When the method completes, contains the newly constructed bounding box.</param>
- </member>
- <member name="M:SharpDX.BoundingBox.Merge(SharpDX.BoundingBox,SharpDX.BoundingBox)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingBox"/> that is as large as the total combined area of the two specified boxes.
- </summary>
- <param name="value1">The first box to merge.</param>
- <param name="value2">The second box to merge.</param>
- <returns>The newly constructed bounding box.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.op_Equality(SharpDX.BoundingBox,SharpDX.BoundingBox)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.op_Inequality(SharpDX.BoundingBox,SharpDX.BoundingBox)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.BoundingBox.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingBox.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingBox.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingBox.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingBox.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Equals(SharpDX.BoundingBox@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Equals(SharpDX.BoundingBox)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingBox.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:SharpDX.BoundingFrustum">
- <summary>
- Defines a frustum which can be used in frustum culling, zoom to Extents (zoom to fit) operations,
- (matrix, frustum, camera) interchange, and many kind of intersection testing.
- </summary>
- </member>
- <member name="P:SharpDX.BoundingFrustum.Matrix">
- <summary>
- Gets or sets the Matrix that describes this bounding frustum.
- </summary>
- </member>
- <member name="P:SharpDX.BoundingFrustum.Near">
- <summary>
- Gets the near plane of the BoundingFrustum.
- </summary>
- </member>
- <member name="P:SharpDX.BoundingFrustum.Far">
- <summary>
- Gets the far plane of the BoundingFrustum.
- </summary>
- </member>
- <member name="P:SharpDX.BoundingFrustum.Left">
- <summary>
- Gets the left plane of the BoundingFrustum.
- </summary>
- </member>
- <member name="P:SharpDX.BoundingFrustum.Right">
- <summary>
- Gets the right plane of the BoundingFrustum.
- </summary>
- </member>
- <member name="P:SharpDX.BoundingFrustum.Top">
- <summary>
- Gets the top plane of the BoundingFrustum.
- </summary>
- </member>
- <member name="P:SharpDX.BoundingFrustum.Bottom">
- <summary>
- Gets the bottom plane of the BoundingFrustum.
- </summary>
- </member>
- <member name="M:SharpDX.BoundingFrustum.#ctor(SharpDX.Matrix)">
- <summary>
- Creates a new instance of BoundingFrustum.
- </summary>
- <param name="matrix">Combined matrix that usually takes view × projection matrix.</param>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Equals(SharpDX.BoundingFrustum@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.BoundingFrustum"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.BoundingFrustum"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.BoundingFrustum"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Equals(SharpDX.BoundingFrustum)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.BoundingFrustum"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.BoundingFrustum"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.BoundingFrustum"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.op_Equality(SharpDX.BoundingFrustum,SharpDX.BoundingFrustum)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>
- The result of the operator.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.op_Inequality(SharpDX.BoundingFrustum,SharpDX.BoundingFrustum)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>
- The result of the operator.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.GetPlane(System.Int32)">
- <summary>
- Returns one of the 6 planes related to this frustum.
- </summary>
- <param name="index">Plane index where 0 fro Left, 1 for Right, 2 for Top, 3 for Bottom, 4 for Near, 5 for Far</param>
- <returns></returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.FromCamera(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a new frustum relaying on perspective camera parameters
- </summary>
- <param name="cameraPos">The camera pos.</param>
- <param name="lookDir">The look dir.</param>
- <param name="upDir">Up dir.</param>
- <param name="fov">The fov.</param>
- <param name="znear">The znear.</param>
- <param name="zfar">The zfar.</param>
- <param name="aspect">The aspect.</param>
- <returns>The bounding frustum calculated from perspective camera</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.FromCamera(SharpDX.FrustumCameraParams)">
- <summary>
- Creates a new frustum relaying on perspective camera parameters
- </summary>
- <param name="cameraParams">The camera params.</param>
- <returns>The bounding frustum from camera params</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.GetCorners">
- <summary>
- Returns the 8 corners of the frustum, element0 is Near1 (near right down corner)
- , element1 is Near2 (near right top corner)
- , element2 is Near3 (near Left top corner)
- , element3 is Near4 (near Left down corner)
- , element4 is Far1 (far right down corner)
- , element5 is Far2 (far right top corner)
- , element6 is Far3 (far left top corner)
- , element7 is Far4 (far left down corner)
- </summary>
- <returns>The 8 corners of the frustum</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.GetCorners(SharpDX.Vector3[])">
- <summary>
- Returns the 8 corners of the frustum, element0 is Near1 (near right down corner)
- , element1 is Near2 (near right top corner)
- , element2 is Near3 (near Left top corner)
- , element3 is Near4 (near Left down corner)
- , element4 is Far1 (far right down corner)
- , element5 is Far2 (far right top corner)
- , element6 is Far3 (far left top corner)
- , element7 is Far4 (far left down corner)
- </summary>
- <returns>The 8 corners of the frustum</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.GetCameraParams">
- <summary>
- Extracts perspective camera parameters from the frustum, doesn't work with orthographic frustums.
- </summary>
- <returns>Perspective camera parameters from the frustum</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.Vector3@)">
- <summary>
- Checks whether a point lay inside, intersects or lay outside the frustum.
- </summary>
- <param name="point">The point.</param>
- <returns>Type of the containment</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.Vector3)">
- <summary>
- Checks whether a point lay inside, intersects or lay outside the frustum.
- </summary>
- <param name="point">The point.</param>
- <returns>Type of the containment</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.Vector3[])">
- <summary>
- Checks whether a group of points lay totally inside the frustum (Contains), or lay partially inside the frustum (Intersects), or lay outside the frustum (Disjoint).
- </summary>
- <param name="points">The points.</param>
- <returns>Type of the containment</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.Vector3[],SharpDX.ContainmentType@)">
- <summary>
- Checks whether a group of points lay totally inside the frustum (Contains), or lay partially inside the frustum (Intersects), or lay outside the frustum (Disjoint).
- </summary>
- <param name="points">The points.</param>
- <param name="result">Type of the containment.</param>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.BoundingBox@)">
- <summary>
- Determines the intersection relationship between the frustum and a bounding box.
- </summary>
- <param name="box">The box.</param>
- <returns>Type of the containment</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.BoundingBox)">
- <summary>
- Determines the intersection relationship between the frustum and a bounding box.
- </summary>
- <param name="box">The box.</param>
- <returns>Type of the containment</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.BoundingBox@,SharpDX.ContainmentType@)">
- <summary>
- Determines the intersection relationship between the frustum and a bounding box.
- </summary>
- <param name="box">The box.</param>
- <param name="result">Type of the containment.</param>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.BoundingSphere@)">
- <summary>
- Determines the intersection relationship between the frustum and a bounding sphere.
- </summary>
- <param name="sphere">The sphere.</param>
- <returns>Type of the containment</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.BoundingSphere)">
- <summary>
- Determines the intersection relationship between the frustum and a bounding sphere.
- </summary>
- <param name="sphere">The sphere.</param>
- <returns>Type of the containment</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.BoundingSphere@,SharpDX.ContainmentType@)">
- <summary>
- Determines the intersection relationship between the frustum and a bounding sphere.
- </summary>
- <param name="sphere">The sphere.</param>
- <param name="result">Type of the containment.</param>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.BoundingFrustum@)">
- <summary>
- Determines the intersection relationship between the frustum and another bounding frustum.
- </summary>
- <param name="frustum">The frustum.</param>
- <returns>Type of the containment</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.BoundingFrustum)">
- <summary>
- Determines the intersection relationship between the frustum and another bounding frustum.
- </summary>
- <param name="frustum">The frustum.</param>
- <returns>Type of the containment</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Contains(SharpDX.BoundingFrustum@,System.Boolean@)">
- <summary>
- Determines the intersection relationship between the frustum and another bounding frustum.
- </summary>
- <param name="frustum">The frustum.</param>
- <param name="result">Type of the containment.</param>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Intersects(SharpDX.BoundingSphere@)">
- <summary>
- Checks whether the current BoundingFrustum intersects a BoundingSphere.
- </summary>
- <param name="sphere">The sphere.</param>
- <returns>Type of the containment</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Intersects(SharpDX.BoundingSphere@,System.Boolean@)">
- <summary>
- Checks whether the current BoundingFrustum intersects a BoundingSphere.
- </summary>
- <param name="sphere">The sphere.</param>
- <param name="result">Set to <c>true</c> if the current BoundingFrustum intersects a BoundingSphere.</param>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Intersects(SharpDX.BoundingBox@)">
- <summary>
- Checks whether the current BoundingFrustum intersects a BoundingBox.
- </summary>
- <param name="box">The box.</param>
- <returns><c>true</c> if the current BoundingFrustum intersects a BoundingSphere.</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Intersects(SharpDX.BoundingBox@,System.Boolean@)">
- <summary>
- Checks whether the current BoundingFrustum intersects a BoundingBox.
- </summary>
- <param name="box">The box.</param>
- <param name="result"><c>true</c> if the current BoundingFrustum intersects a BoundingSphere.</param>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Intersects(SharpDX.Plane@)">
- <summary>
- Checks whether the current BoundingFrustum intersects the specified Plane.
- </summary>
- <param name="plane">The plane.</param>
- <returns>Plane intersection type.</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Intersects(SharpDX.Plane@,SharpDX.PlaneIntersectionType@)">
- <summary>
- Checks whether the current BoundingFrustum intersects the specified Plane.
- </summary>
- <param name="plane">The plane.</param>
- <param name="result">Plane intersection type.</param>
- </member>
- <member name="M:SharpDX.BoundingFrustum.GetWidthAtDepth(System.Single)">
- <summary>
- Get the width of the frustum at specified depth.
- </summary>
- <param name="depth">the depth at which to calculate frustum width.</param>
- <returns>With of the frustum at the specified depth</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.GetHeightAtDepth(System.Single)">
- <summary>
- Get the height of the frustum at specified depth.
- </summary>
- <param name="depth">the depth at which to calculate frustum height.</param>
- <returns>Height of the frustum at the specified depth</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Intersects(SharpDX.Ray@)">
- <summary>
- Checks whether the current BoundingFrustum intersects the specified Ray.
- </summary>
- <param name="ray">The ray.</param>
- <returns><c>true</c> if the current BoundingFrustum intersects the specified Ray.</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.Intersects(SharpDX.Ray@,System.Nullable{System.Single}@,System.Nullable{System.Single}@)">
- <summary>
- Checks whether the current BoundingFrustum intersects the specified Ray.
- </summary>
- <param name="ray">The Ray to check for intersection with.</param>
- <param name="inDistance">The distance at which the ray enters the frustum if there is an intersection and the ray starts outside the frustum.</param>
- <param name="outDistance">The distance at which the ray exits the frustum if there is an intersection.</param>
- <returns><c>true</c> if the current BoundingFrustum intersects the specified Ray.</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.GetZoomToExtentsShiftDistance(SharpDX.Vector3[])">
- <summary>
- Get the distance which when added to camera position along the lookat direction will do the effect of zoom to extents (zoom to fit) operation,
- so all the passed points will fit in the current view.
- if the returned value is positive, the camera will move toward the lookat direction (ZoomIn).
- if the returned value is negative, the camera will move in the reverse direction of the lookat direction (ZoomOut).
- </summary>
- <param name="points">The points.</param>
- <returns>The zoom to fit distance</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.GetZoomToExtentsShiftDistance(SharpDX.BoundingBox@)">
- <summary>
- Get the distance which when added to camera position along the lookat direction will do the effect of zoom to extents (zoom to fit) operation,
- so all the passed points will fit in the current view.
- if the returned value is positive, the camera will move toward the lookat direction (ZoomIn).
- if the returned value is negative, the camera will move in the reverse direction of the lookat direction (ZoomOut).
- </summary>
- <param name="boundingBox">The bounding box.</param>
- <returns>The zoom to fit distance</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.GetZoomToExtentsShiftVector(SharpDX.Vector3[])">
- <summary>
- Get the vector shift which when added to camera position will do the effect of zoom to extents (zoom to fit) operation,
- so all the passed points will fit in the current view.
- </summary>
- <param name="points">The points.</param>
- <returns>The zoom to fit vector</returns>
- </member>
- <member name="M:SharpDX.BoundingFrustum.GetZoomToExtentsShiftVector(SharpDX.BoundingBox@)">
- <summary>
- Get the vector shift which when added to camera position will do the effect of zoom to extents (zoom to fit) operation,
- so all the passed points will fit in the current view.
- </summary>
- <param name="boundingBox">The bounding box.</param>
- <returns>The zoom to fit vector</returns>
- </member>
- <member name="P:SharpDX.BoundingFrustum.IsOrthographic">
- <summary>
- Indicate whether the current BoundingFrustrum is Orthographic.
- </summary>
- <value>
- <c>true</c> if the current BoundingFrustrum is Orthographic; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="T:SharpDX.BoundingSphere">
- <summary>
- Represents a bounding sphere in three dimensional space.
- </summary>
- </member>
- <member name="F:SharpDX.BoundingSphere.Center">
- <summary>
- The center of the sphere in three dimensional space.
- </summary>
- </member>
- <member name="F:SharpDX.BoundingSphere.Radius">
- <summary>
- The radius of the sphere.
- </summary>
- </member>
- <member name="M:SharpDX.BoundingSphere.#ctor(SharpDX.Vector3,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.BoundingSphere"/> struct.
- </summary>
- <param name="center">The center of the sphere in three dimensional space.</param>
- <param name="radius">The radius of the sphere.</param>
- </member>
- <member name="M:SharpDX.BoundingSphere.Intersects(SharpDX.Ray@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Intersects(SharpDX.Ray@,System.Single@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Intersects(SharpDX.Ray@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Intersects(SharpDX.Plane@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="plane">The plane to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Intersects(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a triangle.
- </summary>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Intersects(SharpDX.BoundingBox@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Intersects(SharpDX.BoundingBox)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Intersects(SharpDX.BoundingSphere@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Intersects(SharpDX.BoundingSphere)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Contains(SharpDX.Vector3@)">
- <summary>
- Determines whether the current objects contains a point.
- </summary>
- <param name="point">The point to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Contains(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines whether the current objects contains a triangle.
- </summary>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Contains(SharpDX.BoundingBox@)">
- <summary>
- Determines whether the current objects contains a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Contains(SharpDX.BoundingSphere@)">
- <summary>
- Determines whether the current objects contains a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.FromPoints(SharpDX.Vector3[],System.Int32,System.Int32,SharpDX.BoundingSphere@)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingSphere" /> that fully contains the given points.
- </summary>
- <param name="points">The points that will be contained by the sphere.</param>
- <param name="start">The start index from points array to start compute the bounding sphere.</param>
- <param name="count">The count of points to process to compute the bounding sphere.</param>
- <param name="result">When the method completes, contains the newly constructed bounding sphere.</param>
- <exception cref="T:System.ArgumentNullException">points</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- start
- or
- count
- </exception>
- </member>
- <member name="M:SharpDX.BoundingSphere.FromPoints(SharpDX.Vector3[],SharpDX.BoundingSphere@)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingSphere"/> that fully contains the given points.
- </summary>
- <param name="points">The points that will be contained by the sphere.</param>
- <param name="result">When the method completes, contains the newly constructed bounding sphere.</param>
- </member>
- <member name="M:SharpDX.BoundingSphere.FromPoints(SharpDX.Vector3[])">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingSphere"/> that fully contains the given points.
- </summary>
- <param name="points">The points that will be contained by the sphere.</param>
- <returns>The newly constructed bounding sphere.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.FromBox(SharpDX.BoundingBox@,SharpDX.BoundingSphere@)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingSphere"/> from a given box.
- </summary>
- <param name="box">The box that will designate the extents of the sphere.</param>
- <param name="result">When the method completes, the newly constructed bounding sphere.</param>
- </member>
- <member name="M:SharpDX.BoundingSphere.FromBox(SharpDX.BoundingBox)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingSphere"/> from a given box.
- </summary>
- <param name="box">The box that will designate the extents of the sphere.</param>
- <returns>The newly constructed bounding sphere.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Merge(SharpDX.BoundingSphere@,SharpDX.BoundingSphere@,SharpDX.BoundingSphere@)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingSphere"/> that is the as large as the total combined area of the two specified spheres.
- </summary>
- <param name="value1">The first sphere to merge.</param>
- <param name="value2">The second sphere to merge.</param>
- <param name="result">When the method completes, contains the newly constructed bounding sphere.</param>
- </member>
- <member name="M:SharpDX.BoundingSphere.Merge(SharpDX.BoundingSphere,SharpDX.BoundingSphere)">
- <summary>
- Constructs a <see cref="T:SharpDX.BoundingSphere"/> that is the as large as the total combined area of the two specified spheres.
- </summary>
- <param name="value1">The first sphere to merge.</param>
- <param name="value2">The second sphere to merge.</param>
- <returns>The newly constructed bounding sphere.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.op_Equality(SharpDX.BoundingSphere,SharpDX.BoundingSphere)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.op_Inequality(SharpDX.BoundingSphere,SharpDX.BoundingSphere)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Equals(SharpDX.BoundingSphere@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Equals(SharpDX.BoundingSphere)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.BoundingSphere.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:SharpDX.Collision">
- <summary>
- Contains static methods to help in determining intersections, containment, etc.
- </summary>
- </member>
- <member name="M:SharpDX.Collision.ClosestPointPointTriangle(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines the closest point between a point and a triangle.
- </summary>
- <param name="point">The point to test.</param>
- <param name="vertex1">The first vertex to test.</param>
- <param name="vertex2">The second vertex to test.</param>
- <param name="vertex3">The third vertex to test.</param>
- <param name="result">When the method completes, contains the closest point between the two objects.</param>
- </member>
- <member name="M:SharpDX.Collision.ClosestPointPlanePoint(SharpDX.Plane@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines the closest point between a <see cref="T:SharpDX.Plane"/> and a point.
- </summary>
- <param name="plane">The plane to test.</param>
- <param name="point">The point to test.</param>
- <param name="result">When the method completes, contains the closest point between the two objects.</param>
- </member>
- <member name="M:SharpDX.Collision.ClosestPointBoxPoint(SharpDX.BoundingBox@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines the closest point between a <see cref="T:SharpDX.BoundingBox"/> and a point.
- </summary>
- <param name="box">The box to test.</param>
- <param name="point">The point to test.</param>
- <param name="result">When the method completes, contains the closest point between the two objects.</param>
- </member>
- <member name="M:SharpDX.Collision.ClosestPointSpherePoint(SharpDX.BoundingSphere@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines the closest point between a <see cref="T:SharpDX.BoundingSphere"/> and a point.
- </summary>
- <param name="sphere"></param>
- <param name="point">The point to test.</param>
- <param name="result">When the method completes, contains the closest point between the two objects;
- or, if the point is directly in the center of the sphere, contains <see cref="F:SharpDX.Vector3.Zero"/>.</param>
- </member>
- <member name="M:SharpDX.Collision.ClosestPointSphereSphere(SharpDX.BoundingSphere@,SharpDX.BoundingSphere@,SharpDX.Vector3@)">
- <summary>
- Determines the closest point between a <see cref="T:SharpDX.BoundingSphere"/> and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere1">The first sphere to test.</param>
- <param name="sphere2">The second sphere to test.</param>
- <param name="result">When the method completes, contains the closest point between the two objects;
- or, if the point is directly in the center of the sphere, contains <see cref="F:SharpDX.Vector3.Zero"/>.</param>
- <remarks>
- If the two spheres are overlapping, but not directly on top of each other, the closest point
- is the 'closest' point of intersection. This can also be considered is the deepest point of
- intersection.
- </remarks>
- </member>
- <member name="M:SharpDX.Collision.DistancePlanePoint(SharpDX.Plane@,SharpDX.Vector3@)">
- <summary>
- Determines the distance between a <see cref="T:SharpDX.Plane"/> and a point.
- </summary>
- <param name="plane">The plane to test.</param>
- <param name="point">The point to test.</param>
- <returns>The distance between the two objects.</returns>
- </member>
- <member name="M:SharpDX.Collision.DistanceBoxPoint(SharpDX.BoundingBox@,SharpDX.Vector3@)">
- <summary>
- Determines the distance between a <see cref="T:SharpDX.BoundingBox"/> and a point.
- </summary>
- <param name="box">The box to test.</param>
- <param name="point">The point to test.</param>
- <returns>The distance between the two objects.</returns>
- </member>
- <member name="M:SharpDX.Collision.DistanceBoxBox(SharpDX.BoundingBox@,SharpDX.BoundingBox@)">
- <summary>
- Determines the distance between a <see cref="T:SharpDX.BoundingBox"/> and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box1">The first box to test.</param>
- <param name="box2">The second box to test.</param>
- <returns>The distance between the two objects.</returns>
- </member>
- <member name="M:SharpDX.Collision.DistanceSpherePoint(SharpDX.BoundingSphere@,SharpDX.Vector3@)">
- <summary>
- Determines the distance between a <see cref="T:SharpDX.BoundingSphere"/> and a point.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <param name="point">The point to test.</param>
- <returns>The distance between the two objects.</returns>
- </member>
- <member name="M:SharpDX.Collision.DistanceSphereSphere(SharpDX.BoundingSphere@,SharpDX.BoundingSphere@)">
- <summary>
- Determines the distance between a <see cref="T:SharpDX.BoundingSphere"/> and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere1">The first sphere to test.</param>
- <param name="sphere2">The second sphere to test.</param>
- <returns>The distance between the two objects.</returns>
- </member>
- <member name="M:SharpDX.Collision.RayIntersectsPoint(SharpDX.Ray@,SharpDX.Vector3@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a point.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="point">The point to test.</param>
- <returns>Whether the two objects intersect.</returns>
- </member>
- <member name="M:SharpDX.Collision.RayIntersectsRay(SharpDX.Ray@,SharpDX.Ray@,SharpDX.Vector3@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray1">The first ray to test.</param>
- <param name="ray2">The second ray to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersect.</returns>
- <remarks>
- This method performs a ray vs ray intersection test based on the following formula
- from Goldman.
- <code>s = det([o_2 - o_1, d_2, d_1 x d_2]) / ||d_1 x d_2||^2</code>
- <code>t = det([o_2 - o_1, d_1, d_1 x d_2]) / ||d_1 x d_2||^2</code>
- Where o_1 is the position of the first ray, o_2 is the position of the second ray,
- d_1 is the normalized direction of the first ray, d_2 is the normalized direction
- of the second ray, det denotes the determinant of a matrix, x denotes the cross
- product, [ ] denotes a matrix, and || || denotes the length or magnitude of a vector.
- </remarks>
- </member>
- <member name="M:SharpDX.Collision.RayIntersectsPlane(SharpDX.Ray@,SharpDX.Plane@,System.Single@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="plane">The plane to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersect.</returns>
- </member>
- <member name="M:SharpDX.Collision.RayIntersectsPlane(SharpDX.Ray@,SharpDX.Plane@,SharpDX.Vector3@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="plane">The plane to test</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.RayIntersectsTriangle(SharpDX.Ray@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,System.Single@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a triangle.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- <remarks>
- This method tests if the ray intersects either the front or back of the triangle.
- If the ray is parallel to the triangle's plane, no intersection is assumed to have
- happened. If the intersection of the ray and the triangle is behind the origin of
- the ray, no intersection is assumed to have happened. In both cases of assumptions,
- this method returns false.
- </remarks>
- </member>
- <member name="M:SharpDX.Collision.RayIntersectsTriangle(SharpDX.Ray@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a triangle.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.RayIntersectsBox(SharpDX.Ray@,SharpDX.BoundingBox@,System.Single@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="box">The box to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.RayIntersectsBox(SharpDX.Ray@,SharpDX.BoundingBox@,SharpDX.Vector3@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="box">The box to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.RayIntersectsSphere(SharpDX.Ray@,SharpDX.BoundingSphere@,System.Single@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="sphere">The sphere to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.RayIntersectsSphere(SharpDX.Ray@,SharpDX.BoundingSphere@,SharpDX.Vector3@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="sphere">The sphere to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.PlaneIntersectsPoint(SharpDX.Plane@,SharpDX.Vector3@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Plane"/> and a point.
- </summary>
- <param name="plane">The plane to test.</param>
- <param name="point">The point to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.PlaneIntersectsPlane(SharpDX.Plane@,SharpDX.Plane@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Plane"/> and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="plane1">The first plane to test.</param>
- <param name="plane2">The second plane to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.PlaneIntersectsPlane(SharpDX.Plane@,SharpDX.Plane@,SharpDX.Ray@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Plane"/> and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="plane1">The first plane to test.</param>
- <param name="plane2">The second plane to test.</param>
- <param name="line">When the method completes, contains the line of intersection
- as a <see cref="T:SharpDX.Ray"/>, or a zero ray if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- <remarks>
- Although a ray is set to have an origin, the ray returned by this method is really
- a line in three dimensions which has no real origin. The ray is considered valid when
- both the positive direction is used and when the negative direction is used.
- </remarks>
- </member>
- <member name="M:SharpDX.Collision.PlaneIntersectsTriangle(SharpDX.Plane@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Plane"/> and a triangle.
- </summary>
- <param name="plane">The plane to test.</param>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.PlaneIntersectsBox(SharpDX.Plane@,SharpDX.BoundingBox@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Plane"/> and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="plane">The plane to test.</param>
- <param name="box">The box to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.PlaneIntersectsSphere(SharpDX.Plane@,SharpDX.BoundingSphere@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Plane"/> and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="plane">The plane to test.</param>
- <param name="sphere">The sphere to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.BoxIntersectsBox(SharpDX.BoundingBox@,SharpDX.BoundingBox@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.BoundingBox"/> and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box1">The first box to test.</param>
- <param name="box2">The second box to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.BoxIntersectsSphere(SharpDX.BoundingBox@,SharpDX.BoundingSphere@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.BoundingBox"/> and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="box">The box to test.</param>
- <param name="sphere">The sphere to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.SphereIntersectsTriangle(SharpDX.BoundingSphere@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.BoundingSphere"/> and a triangle.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.SphereIntersectsSphere(SharpDX.BoundingSphere@,SharpDX.BoundingSphere@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.BoundingSphere"/> and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere1">First sphere to test.</param>
- <param name="sphere2">Second sphere to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Collision.BoxContainsPoint(SharpDX.BoundingBox@,SharpDX.Vector3@)">
- <summary>
- Determines whether a <see cref="T:SharpDX.BoundingBox"/> contains a point.
- </summary>
- <param name="box">The box to test.</param>
- <param name="point">The point to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.Collision.BoxContainsBox(SharpDX.BoundingBox@,SharpDX.BoundingBox@)">
- <summary>
- Determines whether a <see cref="T:SharpDX.BoundingBox"/> contains a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box1">The first box to test.</param>
- <param name="box2">The second box to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.Collision.BoxContainsSphere(SharpDX.BoundingBox@,SharpDX.BoundingSphere@)">
- <summary>
- Determines whether a <see cref="T:SharpDX.BoundingBox"/> contains a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="box">The box to test.</param>
- <param name="sphere">The sphere to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.Collision.SphereContainsPoint(SharpDX.BoundingSphere@,SharpDX.Vector3@)">
- <summary>
- Determines whether a <see cref="T:SharpDX.BoundingSphere"/> contains a point.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <param name="point">The point to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.Collision.SphereContainsTriangle(SharpDX.BoundingSphere@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines whether a <see cref="T:SharpDX.BoundingSphere"/> contains a triangle.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.Collision.SphereContainsBox(SharpDX.BoundingSphere@,SharpDX.BoundingBox@)">
- <summary>
- Determines whether a <see cref="T:SharpDX.BoundingSphere"/> contains a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <param name="box">The box to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.Collision.SphereContainsSphere(SharpDX.BoundingSphere@,SharpDX.BoundingSphere@)">
- <summary>
- Determines whether a <see cref="T:SharpDX.BoundingSphere"/> contains a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere1">The first sphere to test.</param>
- <param name="sphere2">The second sphere to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="T:SharpDX.Color">
- <summary>
- Represents a 32-bit color (4 bytes) in the form of RGBA (in byte order: R, G, B, A).
- </summary>
- <summary>
- List of predefined <see cref="T:SharpDX.Color"/>.
- </summary>
- </member>
- <member name="F:SharpDX.Color.R">
- <summary>
- The red component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.G">
- <summary>
- The green component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.B">
- <summary>
- The blue component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.A">
- <summary>
- The alpha component of the color.
- </summary>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Byte)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Byte,System.Byte,System.Byte,System.Byte)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct.
- </summary>
- <param name="red">The red component of the color.</param>
- <param name="green">The green component of the color.</param>
- <param name="blue">The blue component of the color.</param>
- <param name="alpha">The alpha component of the color.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Byte,System.Byte,System.Byte)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct. Alpha is set to 255.
- </summary>
- <param name="red">The red component of the color.</param>
- <param name="green">The green component of the color.</param>
- <param name="blue">The blue component of the color.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct. Passed values are clamped within byte range.
- </summary>
- <param name="red">The red component of the color.</param>
- <param name="green">The green component of the color.</param>
- <param name="blue">The blue component of the color.</param>
- <param name="alpha">The alpha component of the color</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct. Alpha is set to 255. Passed values are clamped within byte range.
- </summary>
- <param name="red">The red component of the color.</param>
- <param name="green">The green component of the color.</param>
- <param name="blue">The blue component of the color.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct.
- </summary>
- <param name="red">The red component of the color.</param>
- <param name="green">The green component of the color.</param>
- <param name="blue">The blue component of the color.</param>
- <param name="alpha">The alpha component of the color.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct. Alpha is set to 255.
- </summary>
- <param name="red">The red component of the color.</param>
- <param name="green">The green component of the color.</param>
- <param name="blue">The blue component of the color.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(SharpDX.Vector4)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct.
- </summary>
- <param name="value">The red, green, blue, and alpha components of the color.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(SharpDX.Vector3,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct.
- </summary>
- <param name="value">The red, green, and blue components of the color.</param>
- <param name="alpha">The alpha component of the color.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(SharpDX.Vector3)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct. Alpha is set to 255.
- </summary>
- <param name="value">The red, green, and blue components of the color.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.UInt32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct.
- </summary>
- <param name="rgba">A packed integer containing all four color components in RGBA order.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct.
- </summary>
- <param name="rgba">A packed integer containing all four color components in RGBA order.</param>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct.
- </summary>
- <param name="values">The values to assign to the red, green, and blue, alpha components of the color. This must be an array with four elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than four elements.</exception>
- </member>
- <member name="M:SharpDX.Color.#ctor(System.Byte[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color"/> struct.
- </summary>
- <param name="values">The values to assign to the alpha, red, green, and blue components of the color. This must be an array with four elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than four elements.</exception>
- </member>
- <member name="P:SharpDX.Color.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the alpha, red, green, or blue component, depending on the index.</value>
- <param name="index">The index of the component to access. Use 0 for the alpha component, 1 for the red component, 2 for the green component, and 3 for the blue component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Color.ToBgra">
- <summary>
- Converts the color into a packed integer.
- </summary>
- <returns>A packed integer containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.Color.ToRgba">
- <summary>
- Converts the color into a packed integer.
- </summary>
- <returns>A packed integer containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.Color.ToAbgr">
- <summary>
- Converts the color into a packed integer.
- </summary>
- <returns>A packed integer containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.Color.ToVector3">
- <summary>
- Converts the color into a three component vector.
- </summary>
- <returns>A three component vector containing the red, green, and blue components of the color.</returns>
- </member>
- <member name="M:SharpDX.Color.ToColor3">
- <summary>
- Converts the color into a three component color.
- </summary>
- <returns>A three component color containing the red, green, and blue components of the color.</returns>
- </member>
- <member name="M:SharpDX.Color.ToVector4">
- <summary>
- Converts the color into a four component vector.
- </summary>
- <returns>A four component vector containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.Color.ToArray">
- <summary>
- Creates an array containing the elements of the color.
- </summary>
- <returns>A four-element array containing the components of the color in RGBA order.</returns>
- </member>
- <member name="M:SharpDX.Color.GetBrightness">
- <summary>
- Gets the brightness.
- </summary>
- <returns>The Hue-Saturation-Brightness (HSB) brightness for this <see cref="T:SharpDX.Color"/></returns>
- </member>
- <member name="M:SharpDX.Color.GetHue">
- <summary>
- Gets the hue.
- </summary>
- <returns>The Hue-Saturation-Brightness (HSB) hue for this <see cref="T:SharpDX.Color"/></returns>
- </member>
- <member name="M:SharpDX.Color.GetSaturation">
- <summary>
- Gets the saturation.
- </summary>
- <returns>The Hue-Saturation-Brightness (HSB) saturation for this <see cref="T:SharpDX.Color"/></returns>
- </member>
- <member name="M:SharpDX.Color.Add(SharpDX.Color@,SharpDX.Color@,SharpDX.Color@)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <param name="result">When the method completes, completes the sum of the two colors.</param>
- </member>
- <member name="M:SharpDX.Color.Add(SharpDX.Color,SharpDX.Color)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <returns>The sum of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color.Subtract(SharpDX.Color@,SharpDX.Color@,SharpDX.Color@)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract.</param>
- <param name="result">WHen the method completes, contains the difference of the two colors.</param>
- </member>
- <member name="M:SharpDX.Color.Subtract(SharpDX.Color,SharpDX.Color)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract</param>
- <returns>The difference of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color.Modulate(SharpDX.Color@,SharpDX.Color@,SharpDX.Color@)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <param name="result">When the method completes, contains the modulated color.</param>
- </member>
- <member name="M:SharpDX.Color.Modulate(SharpDX.Color,SharpDX.Color)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <returns>The modulated color.</returns>
- </member>
- <member name="M:SharpDX.Color.Scale(SharpDX.Color@,System.Single,SharpDX.Color@)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The color to scale.</param>
- <param name="scale">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled color.</param>
- </member>
- <member name="M:SharpDX.Color.Scale(SharpDX.Color,System.Single)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The color to scale.</param>
- <param name="scale">The amount by which to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.Color.Negate(SharpDX.Color@,SharpDX.Color@)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <param name="result">When the method completes, contains the negated color.</param>
- </member>
- <member name="M:SharpDX.Color.Negate(SharpDX.Color)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <returns>The negated color.</returns>
- </member>
- <member name="M:SharpDX.Color.Clamp(SharpDX.Color@,SharpDX.Color@,SharpDX.Color@,SharpDX.Color@)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <param name="result">When the method completes, contains the clamped value.</param>
- </member>
- <member name="M:SharpDX.Color.Premultiply(SharpDX.Color@,SharpDX.Color@)">
- <summary>
- Computes the premultiplied value of the provided color.
- </summary>
- <param name="value">The non-premultiplied value.</param>
- <param name="result">The premultiplied result.</param>
- </member>
- <member name="M:SharpDX.Color.Premultiply(SharpDX.Color)">
- <summary>
- Computes the premultiplied value of the provided color.
- </summary>
- <param name="value">The non-premultiplied value.</param>
- <returns>The premultiplied result.</returns>
- </member>
- <member name="M:SharpDX.Color.FromBgra(System.Int32)">
- <summary>
- Converts the color from a packed BGRA integer.
- </summary>
- <param name="color">A packed integer containing all four color components in BGRA order</param>
- <returns>A color.</returns>
- </member>
- <member name="M:SharpDX.Color.FromBgra(System.UInt32)">
- <summary>
- Converts the color from a packed BGRA integer.
- </summary>
- <param name="color">A packed integer containing all four color components in BGRA order</param>
- <returns>A color.</returns>
- </member>
- <member name="M:SharpDX.Color.FromAbgr(System.Int32)">
- <summary>
- Converts the color from a packed ABGR integer.
- </summary>
- <param name="color">A packed integer containing all four color components in ABGR order</param>
- <returns>A color.</returns>
- </member>
- <member name="M:SharpDX.Color.FromAbgr(System.UInt32)">
- <summary>
- Converts the color from a packed ABGR integer.
- </summary>
- <param name="color">A packed integer containing all four color components in ABGR order</param>
- <returns>A color.</returns>
- </member>
- <member name="M:SharpDX.Color.FromRgba(System.Int32)">
- <summary>
- Converts the color from a packed BGRA integer.
- </summary>
- <param name="color">A packed integer containing all four color components in RGBA order</param>
- <returns>A color.</returns>
- </member>
- <member name="M:SharpDX.Color.FromRgba(System.UInt32)">
- <summary>
- Converts the color from a packed BGRA integer.
- </summary>
- <param name="color">A packed integer containing all four color components in RGBA order</param>
- <returns>A color.</returns>
- </member>
- <member name="M:SharpDX.Color.Clamp(SharpDX.Color,SharpDX.Color,SharpDX.Color)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <returns>The clamped value.</returns>
- </member>
- <member name="M:SharpDX.Color.Lerp(SharpDX.Color@,SharpDX.Color@,System.Single,SharpDX.Color@)">
- <summary>
- Performs a linear interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two colors.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Color.Lerp(SharpDX.Color,SharpDX.Color,System.Single)">
- <summary>
- Performs a linear interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two colors.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Color.SmoothStep(SharpDX.Color@,SharpDX.Color@,System.Single,SharpDX.Color@)">
- <summary>
- Performs a cubic interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two colors.</param>
- </member>
- <member name="M:SharpDX.Color.SmoothStep(SharpDX.Color,SharpDX.Color,System.Single)">
- <summary>
- Performs a cubic interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color.Max(SharpDX.Color@,SharpDX.Color@,SharpDX.Color@)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <param name="result">When the method completes, contains an new color composed of the largest components of the source colors.</param>
- </member>
- <member name="M:SharpDX.Color.Max(SharpDX.Color,SharpDX.Color)">
- <summary>
- Returns a color containing the largest components of the specified colorss.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <returns>A color containing the largest components of the source colors.</returns>
- </member>
- <member name="M:SharpDX.Color.Min(SharpDX.Color@,SharpDX.Color@,SharpDX.Color@)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <param name="result">When the method completes, contains an new color composed of the smallest components of the source colors.</param>
- </member>
- <member name="M:SharpDX.Color.Min(SharpDX.Color,SharpDX.Color)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <returns>A color containing the smallest components of the source colors.</returns>
- </member>
- <member name="M:SharpDX.Color.AdjustContrast(SharpDX.Color@,System.Single,SharpDX.Color@)">
- <summary>
- Adjusts the contrast of a color.
- </summary>
- <param name="value">The color whose contrast is to be adjusted.</param>
- <param name="contrast">The amount by which to adjust the contrast.</param>
- <param name="result">When the method completes, contains the adjusted color.</param>
- </member>
- <member name="M:SharpDX.Color.AdjustContrast(SharpDX.Color,System.Single)">
- <summary>
- Adjusts the contrast of a color.
- </summary>
- <param name="value">The color whose contrast is to be adjusted.</param>
- <param name="contrast">The amount by which to adjust the contrast.</param>
- <returns>The adjusted color.</returns>
- </member>
- <member name="M:SharpDX.Color.AdjustSaturation(SharpDX.Color@,System.Single,SharpDX.Color@)">
- <summary>
- Adjusts the saturation of a color.
- </summary>
- <param name="value">The color whose saturation is to be adjusted.</param>
- <param name="saturation">The amount by which to adjust the saturation.</param>
- <param name="result">When the method completes, contains the adjusted color.</param>
- </member>
- <member name="M:SharpDX.Color.AdjustSaturation(SharpDX.Color,System.Single)">
- <summary>
- Adjusts the saturation of a color.
- </summary>
- <param name="value">The color whose saturation is to be adjusted.</param>
- <param name="saturation">The amount by which to adjust the saturation.</param>
- <returns>The adjusted color.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Addition(SharpDX.Color,SharpDX.Color)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <returns>The sum of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color.op_UnaryPlus(SharpDX.Color)">
- <summary>
- Assert a color (return it unchanged).
- </summary>
- <param name="value">The color to assert (unchanged).</param>
- <returns>The asserted (unchanged) color.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Subtraction(SharpDX.Color,SharpDX.Color)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract.</param>
- <returns>The difference of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color.op_UnaryNegation(SharpDX.Color)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <returns>A negated color.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Multiply(System.Single,SharpDX.Color)">
- <summary>
- Scales a color.
- </summary>
- <param name="scale">The factor by which to scale the color.</param>
- <param name="value">The color to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Multiply(SharpDX.Color,System.Single)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The factor by which to scale the color.</param>
- <param name="scale">The color to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Multiply(SharpDX.Color,SharpDX.Color)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <returns>The modulated color.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Equality(SharpDX.Color,SharpDX.Color)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Inequality(SharpDX.Color,SharpDX.Color)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Explicit(SharpDX.Color)~SharpDX.Color3">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color"/> to <see cref="T:SharpDX.Color3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Explicit(SharpDX.Color)~SharpDX.Vector3">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color"/> to <see cref="T:SharpDX.Vector3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Explicit(SharpDX.Color)~SharpDX.Vector4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color"/> to <see cref="T:SharpDX.Vector4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.ToColor4">
- <summary>
- Convert this instance to a <see cref="T:SharpDX.Color4"/>
- </summary>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Implicit(SharpDX.Color)~SharpDX.Color4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Color"/> to <see cref="T:SharpDX.Color4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Implicit(SharpDX.Color)~SharpDX.Mathematics.Interop.RawColor4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Color"/> to <see cref="T:SharpDX.Mathematics.Interop.RawColor4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Implicit(SharpDX.Color)~SharpDX.Mathematics.Interop.RawColorBGRA">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Color"/> to <see cref="T:SharpDX.Mathematics.Interop.RawColor4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Implicit(SharpDX.Color)~System.Nullable{SharpDX.Mathematics.Interop.RawColor4}">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Color"/> to nullable <see cref="T:SharpDX.Mathematics.Interop.RawColor4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Explicit(SharpDX.Vector3)~SharpDX.Color">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector3"/> to <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Explicit(SharpDX.Color3)~SharpDX.Color">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color3"/> to <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Explicit(SharpDX.Vector4)~SharpDX.Color">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector4"/> to <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Explicit(SharpDX.Color4)~SharpDX.Color">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color4"/> to <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color.op_Explicit(SharpDX.Color)~System.Int32">
- <summary>
- Performs an explicit conversion from <see cref="T:System.Int32"/> to <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>
- The result of the conversion.
- </returns>
- </member>
- <member name="M:SharpDX.Color.op_Explicit(System.Int32)~SharpDX.Color">
- <summary>
- Performs an explicit conversion from <see cref="T:System.Int32"/> to <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>
- The result of the conversion.
- </returns>
- </member>
- <member name="M:SharpDX.Color.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to apply to each channel element (byte).</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to apply to each channel element (byte).</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Color.Equals(SharpDX.Color@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Color"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Color"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Color"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Color.Equals(SharpDX.Color)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Color"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Color"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Color"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Color.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="F:SharpDX.Color.Zero">
- <summary>
- Zero color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Transparent">
- <summary>
- Transparent color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.AliceBlue">
- <summary>
- AliceBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.AntiqueWhite">
- <summary>
- AntiqueWhite color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Aqua">
- <summary>
- Aqua color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Aquamarine">
- <summary>
- Aquamarine color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Azure">
- <summary>
- Azure color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Beige">
- <summary>
- Beige color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Bisque">
- <summary>
- Bisque color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Black">
- <summary>
- Black color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.BlanchedAlmond">
- <summary>
- BlanchedAlmond color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Blue">
- <summary>
- Blue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.BlueViolet">
- <summary>
- BlueViolet color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Brown">
- <summary>
- Brown color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.BurlyWood">
- <summary>
- BurlyWood color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.CadetBlue">
- <summary>
- CadetBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Chartreuse">
- <summary>
- Chartreuse color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Chocolate">
- <summary>
- Chocolate color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Coral">
- <summary>
- Coral color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.CornflowerBlue">
- <summary>
- CornflowerBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Cornsilk">
- <summary>
- Cornsilk color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Crimson">
- <summary>
- Crimson color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Cyan">
- <summary>
- Cyan color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkBlue">
- <summary>
- DarkBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkCyan">
- <summary>
- DarkCyan color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkGoldenrod">
- <summary>
- DarkGoldenrod color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkGray">
- <summary>
- DarkGray color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkGreen">
- <summary>
- DarkGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkKhaki">
- <summary>
- DarkKhaki color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkMagenta">
- <summary>
- DarkMagenta color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkOliveGreen">
- <summary>
- DarkOliveGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkOrange">
- <summary>
- DarkOrange color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkOrchid">
- <summary>
- DarkOrchid color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkRed">
- <summary>
- DarkRed color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkSalmon">
- <summary>
- DarkSalmon color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkSeaGreen">
- <summary>
- DarkSeaGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkSlateBlue">
- <summary>
- DarkSlateBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkSlateGray">
- <summary>
- DarkSlateGray color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkTurquoise">
- <summary>
- DarkTurquoise color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DarkViolet">
- <summary>
- DarkViolet color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DeepPink">
- <summary>
- DeepPink color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DeepSkyBlue">
- <summary>
- DeepSkyBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DimGray">
- <summary>
- DimGray color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.DodgerBlue">
- <summary>
- DodgerBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Firebrick">
- <summary>
- Firebrick color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.FloralWhite">
- <summary>
- FloralWhite color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.ForestGreen">
- <summary>
- ForestGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Fuchsia">
- <summary>
- Fuchsia color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Gainsboro">
- <summary>
- Gainsboro color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.GhostWhite">
- <summary>
- GhostWhite color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Gold">
- <summary>
- Gold color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Goldenrod">
- <summary>
- Goldenrod color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Gray">
- <summary>
- Gray color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Green">
- <summary>
- Green color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.GreenYellow">
- <summary>
- GreenYellow color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Honeydew">
- <summary>
- Honeydew color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.HotPink">
- <summary>
- HotPink color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.IndianRed">
- <summary>
- IndianRed color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Indigo">
- <summary>
- Indigo color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Ivory">
- <summary>
- Ivory color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Khaki">
- <summary>
- Khaki color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Lavender">
- <summary>
- Lavender color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LavenderBlush">
- <summary>
- LavenderBlush color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LawnGreen">
- <summary>
- LawnGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LemonChiffon">
- <summary>
- LemonChiffon color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightBlue">
- <summary>
- LightBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightCoral">
- <summary>
- LightCoral color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightCyan">
- <summary>
- LightCyan color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightGoldenrodYellow">
- <summary>
- LightGoldenrodYellow color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightGray">
- <summary>
- LightGray color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightGreen">
- <summary>
- LightGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightPink">
- <summary>
- LightPink color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightSalmon">
- <summary>
- LightSalmon color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightSeaGreen">
- <summary>
- LightSeaGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightSkyBlue">
- <summary>
- LightSkyBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightSlateGray">
- <summary>
- LightSlateGray color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightSteelBlue">
- <summary>
- LightSteelBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LightYellow">
- <summary>
- LightYellow color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Lime">
- <summary>
- Lime color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.LimeGreen">
- <summary>
- LimeGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Linen">
- <summary>
- Linen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Magenta">
- <summary>
- Magenta color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Maroon">
- <summary>
- Maroon color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MediumAquamarine">
- <summary>
- MediumAquamarine color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MediumBlue">
- <summary>
- MediumBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MediumOrchid">
- <summary>
- MediumOrchid color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MediumPurple">
- <summary>
- MediumPurple color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MediumSeaGreen">
- <summary>
- MediumSeaGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MediumSlateBlue">
- <summary>
- MediumSlateBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MediumSpringGreen">
- <summary>
- MediumSpringGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MediumTurquoise">
- <summary>
- MediumTurquoise color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MediumVioletRed">
- <summary>
- MediumVioletRed color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MidnightBlue">
- <summary>
- MidnightBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MintCream">
- <summary>
- MintCream color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.MistyRose">
- <summary>
- MistyRose color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Moccasin">
- <summary>
- Moccasin color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.NavajoWhite">
- <summary>
- NavajoWhite color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Navy">
- <summary>
- Navy color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.OldLace">
- <summary>
- OldLace color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Olive">
- <summary>
- Olive color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.OliveDrab">
- <summary>
- OliveDrab color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Orange">
- <summary>
- Orange color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.OrangeRed">
- <summary>
- OrangeRed color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Orchid">
- <summary>
- Orchid color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.PaleGoldenrod">
- <summary>
- PaleGoldenrod color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.PaleGreen">
- <summary>
- PaleGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.PaleTurquoise">
- <summary>
- PaleTurquoise color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.PaleVioletRed">
- <summary>
- PaleVioletRed color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.PapayaWhip">
- <summary>
- PapayaWhip color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.PeachPuff">
- <summary>
- PeachPuff color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Peru">
- <summary>
- Peru color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Pink">
- <summary>
- Pink color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Plum">
- <summary>
- Plum color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.PowderBlue">
- <summary>
- PowderBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Purple">
- <summary>
- Purple color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Red">
- <summary>
- Red color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.RosyBrown">
- <summary>
- RosyBrown color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.RoyalBlue">
- <summary>
- RoyalBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.SaddleBrown">
- <summary>
- SaddleBrown color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Salmon">
- <summary>
- Salmon color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.SandyBrown">
- <summary>
- SandyBrown color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.SeaGreen">
- <summary>
- SeaGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.SeaShell">
- <summary>
- SeaShell color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Sienna">
- <summary>
- Sienna color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Silver">
- <summary>
- Silver color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.SkyBlue">
- <summary>
- SkyBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.SlateBlue">
- <summary>
- SlateBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.SlateGray">
- <summary>
- SlateGray color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Snow">
- <summary>
- Snow color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.SpringGreen">
- <summary>
- SpringGreen color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.SteelBlue">
- <summary>
- SteelBlue color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Tan">
- <summary>
- Tan color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Teal">
- <summary>
- Teal color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Thistle">
- <summary>
- Thistle color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Tomato">
- <summary>
- Tomato color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Turquoise">
- <summary>
- Turquoise color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Violet">
- <summary>
- Violet color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Wheat">
- <summary>
- Wheat color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.White">
- <summary>
- White color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.WhiteSmoke">
- <summary>
- WhiteSmoke color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.Yellow">
- <summary>
- Yellow color.
- </summary>
- </member>
- <member name="F:SharpDX.Color.YellowGreen">
- <summary>
- YellowGreen color.
- </summary>
- </member>
- <member name="T:SharpDX.Color3">
- <summary>
- Represents a color in the form of rgb.
- </summary>
- </member>
- <member name="F:SharpDX.Color3.Black">
- <summary>
- The Black color (0, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Color3.White">
- <summary>
- The White color (1, 1, 1, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Color3.Red">
- <summary>
- The red component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.Color3.Green">
- <summary>
- The green component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.Color3.Blue">
- <summary>
- The blue component of the color.
- </summary>
- </member>
- <member name="M:SharpDX.Color3.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color3"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Color3.#ctor(System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color3"/> struct.
- </summary>
- <param name="red">The red component of the color.</param>
- <param name="green">The green component of the color.</param>
- <param name="blue">The blue component of the color.</param>
- </member>
- <member name="M:SharpDX.Color3.#ctor(SharpDX.Vector3)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color3"/> struct.
- </summary>
- <param name="value">The red, green, and blue components of the color.</param>
- </member>
- <member name="M:SharpDX.Color3.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color3"/> struct.
- </summary>
- <param name="rgb">A packed integer containing all three color components in RGB order.
- The alpha component is ignored.</param>
- </member>
- <member name="M:SharpDX.Color3.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color3"/> struct.
- </summary>
- <param name="values">The values to assign to the red, green, and blue components of the color. This must be an array with three elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than four elements.</exception>
- </member>
- <member name="P:SharpDX.Color3.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the red, green, or blue component, depending on the index.</value>
- <param name="index">The index of the component to access. Use 0 for the red component, 1 for the green component, and 2 for the blue component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 2].</exception>
- </member>
- <member name="M:SharpDX.Color3.ToRgba">
- <summary>
- Converts the color into a packed integer.
- </summary>
- <returns>A packed integer containing all three color components.
- The alpha channel is set to 255.</returns>
- </member>
- <member name="M:SharpDX.Color3.ToBgra">
- <summary>
- Converts the color into a packed integer.
- </summary>
- <returns>A packed integer containing all three color components.
- The alpha channel is set to 255.</returns>
- </member>
- <member name="M:SharpDX.Color3.ToVector3">
- <summary>
- Converts the color into a three component vector.
- </summary>
- <returns>A three component vector containing the red, green, and blue components of the color.</returns>
- </member>
- <member name="M:SharpDX.Color3.ToArray">
- <summary>
- Creates an array containing the elements of the color.
- </summary>
- <returns>A three-element array containing the components of the color.</returns>
- </member>
- <member name="M:SharpDX.Color3.Add(SharpDX.Color3@,SharpDX.Color3@,SharpDX.Color3@)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <param name="result">When the method completes, completes the sum of the two colors.</param>
- </member>
- <member name="M:SharpDX.Color3.Add(SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <returns>The sum of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color3.Subtract(SharpDX.Color3@,SharpDX.Color3@,SharpDX.Color3@)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract.</param>
- <param name="result">WHen the method completes, contains the difference of the two colors.</param>
- </member>
- <member name="M:SharpDX.Color3.Subtract(SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract</param>
- <returns>The difference of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color3.Modulate(SharpDX.Color3@,SharpDX.Color3@,SharpDX.Color3@)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <param name="result">When the method completes, contains the modulated color.</param>
- </member>
- <member name="M:SharpDX.Color3.Modulate(SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <returns>The modulated color.</returns>
- </member>
- <member name="M:SharpDX.Color3.Scale(SharpDX.Color3@,System.Single,SharpDX.Color3@)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The color to scale.</param>
- <param name="scale">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled color.</param>
- </member>
- <member name="M:SharpDX.Color3.Scale(SharpDX.Color3,System.Single)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The color to scale.</param>
- <param name="scale">The amount by which to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.Color3.Negate(SharpDX.Color3@,SharpDX.Color3@)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <param name="result">When the method completes, contains the negated color.</param>
- </member>
- <member name="M:SharpDX.Color3.Negate(SharpDX.Color3)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <returns>The negated color.</returns>
- </member>
- <member name="M:SharpDX.Color3.Clamp(SharpDX.Color3@,SharpDX.Color3@,SharpDX.Color3@,SharpDX.Color3@)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <param name="result">When the method completes, contains the clamped value.</param>
- </member>
- <member name="M:SharpDX.Color3.Clamp(SharpDX.Color3,SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <returns>The clamped value.</returns>
- </member>
- <member name="M:SharpDX.Color3.Lerp(SharpDX.Color3@,SharpDX.Color3@,System.Single,SharpDX.Color3@)">
- <summary>
- Performs a linear interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two colors.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Color3.Lerp(SharpDX.Color3,SharpDX.Color3,System.Single)">
- <summary>
- Performs a linear interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two colors.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Color3.SmoothStep(SharpDX.Color3@,SharpDX.Color3@,System.Single,SharpDX.Color3@)">
- <summary>
- Performs a cubic interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two colors.</param>
- </member>
- <member name="M:SharpDX.Color3.SmoothStep(SharpDX.Color3,SharpDX.Color3,System.Single)">
- <summary>
- Performs a cubic interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color3.Max(SharpDX.Color3@,SharpDX.Color3@,SharpDX.Color3@)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <param name="result">When the method completes, contains an new color composed of the largest components of the source colors.</param>
- </member>
- <member name="M:SharpDX.Color3.Max(SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Returns a color containing the largest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <returns>A color containing the largest components of the source colors.</returns>
- </member>
- <member name="M:SharpDX.Color3.Min(SharpDX.Color3@,SharpDX.Color3@,SharpDX.Color3@)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <param name="result">When the method completes, contains an new color composed of the smallest components of the source colors.</param>
- </member>
- <member name="M:SharpDX.Color3.Min(SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <returns>A color containing the smallest components of the source colors.</returns>
- </member>
- <member name="M:SharpDX.Color3.AdjustContrast(SharpDX.Color3@,System.Single,SharpDX.Color3@)">
- <summary>
- Adjusts the contrast of a color.
- </summary>
- <param name="value">The color whose contrast is to be adjusted.</param>
- <param name="contrast">The amount by which to adjust the contrast.</param>
- <param name="result">When the method completes, contains the adjusted color.</param>
- </member>
- <member name="M:SharpDX.Color3.AdjustContrast(SharpDX.Color3,System.Single)">
- <summary>
- Adjusts the contrast of a color.
- </summary>
- <param name="value">The color whose contrast is to be adjusted.</param>
- <param name="contrast">The amount by which to adjust the contrast.</param>
- <returns>The adjusted color.</returns>
- </member>
- <member name="M:SharpDX.Color3.AdjustSaturation(SharpDX.Color3@,System.Single,SharpDX.Color3@)">
- <summary>
- Adjusts the saturation of a color.
- </summary>
- <param name="value">The color whose saturation is to be adjusted.</param>
- <param name="saturation">The amount by which to adjust the saturation.</param>
- <param name="result">When the method completes, contains the adjusted color.</param>
- </member>
- <member name="M:SharpDX.Color3.AdjustSaturation(SharpDX.Color3,System.Single)">
- <summary>
- Adjusts the saturation of a color.
- </summary>
- <param name="value">The color whose saturation is to be adjusted.</param>
- <param name="saturation">The amount by which to adjust the saturation.</param>
- <returns>The adjusted color.</returns>
- </member>
- <member name="M:SharpDX.Color3.Premultiply(SharpDX.Color3@,System.Single,SharpDX.Color3@)">
- <summary>
- Computes the premultiplied value of the provided color.
- </summary>
- <param name="value">The non-premultiplied value.</param>
- <param name="alpha">The color alpha.</param>
- <param name="result">The premultiplied result.</param>
- </member>
- <member name="M:SharpDX.Color3.Premultiply(SharpDX.Color3,System.Single)">
- <summary>
- Computes the premultiplied value of the provided color.
- </summary>
- <param name="value">The non-premultiplied value.</param>
- <param name="alpha">The color alpha.</param>
- <returns>The premultiplied color.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Addition(SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <returns>The sum of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_UnaryPlus(SharpDX.Color3)">
- <summary>
- Assert a color (return it unchanged).
- </summary>
- <param name="value">The color to assert (unchanged).</param>
- <returns>The asserted (unchanged) color.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Subtraction(SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract.</param>
- <returns>The difference of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_UnaryNegation(SharpDX.Color3)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <returns>A negated color.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Multiply(System.Single,SharpDX.Color3)">
- <summary>
- Scales a color.
- </summary>
- <param name="scale">The factor by which to scale the color.</param>
- <param name="value">The color to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Multiply(SharpDX.Color3,System.Single)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The factor by which to scale the color.</param>
- <param name="scale">The color to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Multiply(SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <returns>The modulated color.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Equality(SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Inequality(SharpDX.Color3,SharpDX.Color3)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Explicit(SharpDX.Color3)~SharpDX.Color4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color3"/> to <see cref="T:SharpDX.Color4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Implicit(SharpDX.Color3)~SharpDX.Vector3">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Color3"/> to <see cref="T:SharpDX.Vector3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Implicit(SharpDX.Vector3)~SharpDX.Color3">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Vector3"/> to <see cref="T:SharpDX.Color3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Explicit(System.Int32)~SharpDX.Color3">
- <summary>
- Performs an explicit conversion from <see cref="T:System.Int32"/> to <see cref="T:SharpDX.Color3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color3.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color3.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to apply to each channel element (float)</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color3.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color3.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to apply to each channel element (float).</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color3.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Color3.Equals(SharpDX.Color3@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Color3"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Color3"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Color3"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Color3.Equals(SharpDX.Color3)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Color3"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Color3"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Color3"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Color3.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Color3.op_Implicit(SharpDX.Color3)~SharpDX.Mathematics.Interop.RawColor3">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Color3"/> to <see cref="T:SharpDX.Mathematics.Interop.RawColor3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color3.op_Implicit(SharpDX.Mathematics.Interop.RawColor3)~SharpDX.Color3">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawColor3"/> to <see cref="T:SharpDX.Color3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.Color4">
- <summary>
- Represents a color in the form of rgba.
- </summary>
- </member>
- <member name="F:SharpDX.Color4.Black">
- <summary>
- The Black color (0, 0, 0, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Color4.White">
- <summary>
- The White color (1, 1, 1, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Color4.Red">
- <summary>
- The red component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.Color4.Green">
- <summary>
- The green component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.Color4.Blue">
- <summary>
- The blue component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.Color4.Alpha">
- <summary>
- The alpha component of the color.
- </summary>
- </member>
- <member name="M:SharpDX.Color4.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color4"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Color4.#ctor(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color4"/> struct.
- </summary>
- <param name="red">The red component of the color.</param>
- <param name="green">The green component of the color.</param>
- <param name="blue">The blue component of the color.</param>
- <param name="alpha">The alpha component of the color.</param>
- </member>
- <member name="M:SharpDX.Color4.#ctor(SharpDX.Vector4)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color4"/> struct.
- </summary>
- <param name="value">The red, green, blue, and alpha components of the color.</param>
- </member>
- <member name="M:SharpDX.Color4.#ctor(SharpDX.Vector3,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color4"/> struct.
- </summary>
- <param name="value">The red, green, and blue components of the color.</param>
- <param name="alpha">The alpha component of the color.</param>
- </member>
- <member name="M:SharpDX.Color4.#ctor(System.UInt32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color4"/> struct.
- </summary>
- <param name="rgba">A packed integer containing all four color components in RGBA order.</param>
- </member>
- <member name="M:SharpDX.Color4.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color4"/> struct.
- </summary>
- <param name="rgba">A packed integer containing all four color components in RGBA order.</param>
- </member>
- <member name="M:SharpDX.Color4.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color4"/> struct.
- </summary>
- <param name="values">The values to assign to the red, green, blue, and alpha components of the color. This must be an array with four elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than four elements.</exception>
- </member>
- <member name="M:SharpDX.Color4.#ctor(SharpDX.Color3)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color4"/> struct.
- </summary>
- <param name="color"><see cref="T:SharpDX.Color3"/> used to initialize the color.</param>
- </member>
- <member name="M:SharpDX.Color4.#ctor(SharpDX.Color3,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Color4"/> struct.
- </summary>
- <param name="color"><see cref="T:SharpDX.Color3"/> used to initialize the color.</param>
- <param name="alpha">The alpha component of the color.</param>
- </member>
- <member name="P:SharpDX.Color4.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the red, green, blue, and alpha components, depending on the index.</value>
- <param name="index">The index of the component to access. Use 0 for the alpha component, 1 for the red component, 2 for the green component, and 3 for the blue component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Color4.ToBgra">
- <summary>
- Converts the color into a packed integer.
- </summary>
- <returns>A packed integer containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.Color4.ToBgra(System.Byte@,System.Byte@,System.Byte@,System.Byte@)">
- <summary>
- Converts the color into a packed integer.
- </summary>
- <returns>A packed integer containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.Color4.ToRgba">
- <summary>
- Converts the color into a packed integer.
- </summary>
- <returns>A packed integer containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.Color4.ToVector3">
- <summary>
- Converts the color into a three component vector.
- </summary>
- <returns>A three component vector containing the red, green, and blue components of the color.</returns>
- </member>
- <member name="M:SharpDX.Color4.ToVector4">
- <summary>
- Converts the color into a four component vector.
- </summary>
- <returns>A four component vector containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.Color4.ToArray">
- <summary>
- Creates an array containing the elements of the color.
- </summary>
- <returns>A four-element array containing the components of the color.</returns>
- </member>
- <member name="M:SharpDX.Color4.Add(SharpDX.Color4@,SharpDX.Color4@,SharpDX.Color4@)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <param name="result">When the method completes, completes the sum of the two colors.</param>
- </member>
- <member name="M:SharpDX.Color4.Add(SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <returns>The sum of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color4.Subtract(SharpDX.Color4@,SharpDX.Color4@,SharpDX.Color4@)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract.</param>
- <param name="result">WHen the method completes, contains the difference of the two colors.</param>
- </member>
- <member name="M:SharpDX.Color4.Subtract(SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract</param>
- <returns>The difference of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color4.Modulate(SharpDX.Color4@,SharpDX.Color4@,SharpDX.Color4@)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <param name="result">When the method completes, contains the modulated color.</param>
- </member>
- <member name="M:SharpDX.Color4.Modulate(SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <returns>The modulated color.</returns>
- </member>
- <member name="M:SharpDX.Color4.Scale(SharpDX.Color4@,System.Single,SharpDX.Color4@)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The color to scale.</param>
- <param name="scale">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled color.</param>
- </member>
- <member name="M:SharpDX.Color4.Scale(SharpDX.Color4,System.Single)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The color to scale.</param>
- <param name="scale">The amount by which to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.Color4.Negate(SharpDX.Color4@,SharpDX.Color4@)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <param name="result">When the method completes, contains the negated color.</param>
- </member>
- <member name="M:SharpDX.Color4.Negate(SharpDX.Color4)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <returns>The negated color.</returns>
- </member>
- <member name="M:SharpDX.Color4.Clamp(SharpDX.Color4@,SharpDX.Color4@,SharpDX.Color4@,SharpDX.Color4@)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <param name="result">When the method completes, contains the clamped value.</param>
- </member>
- <member name="M:SharpDX.Color4.Clamp(SharpDX.Color4,SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <returns>The clamped value.</returns>
- </member>
- <member name="M:SharpDX.Color4.Lerp(SharpDX.Color4@,SharpDX.Color4@,System.Single,SharpDX.Color4@)">
- <summary>
- Performs a linear interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two colors.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Color4.Lerp(SharpDX.Color4,SharpDX.Color4,System.Single)">
- <summary>
- Performs a linear interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two colors.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Color4.SmoothStep(SharpDX.Color4@,SharpDX.Color4@,System.Single,SharpDX.Color4@)">
- <summary>
- Performs a cubic interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two colors.</param>
- </member>
- <member name="M:SharpDX.Color4.SmoothStep(SharpDX.Color4,SharpDX.Color4,System.Single)">
- <summary>
- Performs a cubic interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color4.Max(SharpDX.Color4@,SharpDX.Color4@,SharpDX.Color4@)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <param name="result">When the method completes, contains an new color composed of the largest components of the source colors.</param>
- </member>
- <member name="M:SharpDX.Color4.Max(SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Returns a color containing the largest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <returns>A color containing the largest components of the source colors.</returns>
- </member>
- <member name="M:SharpDX.Color4.Min(SharpDX.Color4@,SharpDX.Color4@,SharpDX.Color4@)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <param name="result">When the method completes, contains an new color composed of the smallest components of the source colors.</param>
- </member>
- <member name="M:SharpDX.Color4.Min(SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <returns>A color containing the smallest components of the source colors.</returns>
- </member>
- <member name="M:SharpDX.Color4.AdjustContrast(SharpDX.Color4@,System.Single,SharpDX.Color4@)">
- <summary>
- Adjusts the contrast of a color.
- </summary>
- <param name="value">The color whose contrast is to be adjusted.</param>
- <param name="contrast">The amount by which to adjust the contrast.</param>
- <param name="result">When the method completes, contains the adjusted color.</param>
- </member>
- <member name="M:SharpDX.Color4.AdjustContrast(SharpDX.Color4,System.Single)">
- <summary>
- Adjusts the contrast of a color.
- </summary>
- <param name="value">The color whose contrast is to be adjusted.</param>
- <param name="contrast">The amount by which to adjust the contrast.</param>
- <returns>The adjusted color.</returns>
- </member>
- <member name="M:SharpDX.Color4.AdjustSaturation(SharpDX.Color4@,System.Single,SharpDX.Color4@)">
- <summary>
- Adjusts the saturation of a color.
- </summary>
- <param name="value">The color whose saturation is to be adjusted.</param>
- <param name="saturation">The amount by which to adjust the saturation.</param>
- <param name="result">When the method completes, contains the adjusted color.</param>
- </member>
- <member name="M:SharpDX.Color4.AdjustSaturation(SharpDX.Color4,System.Single)">
- <summary>
- Adjusts the saturation of a color.
- </summary>
- <param name="value">The color whose saturation is to be adjusted.</param>
- <param name="saturation">The amount by which to adjust the saturation.</param>
- <returns>The adjusted color.</returns>
- </member>
- <member name="M:SharpDX.Color4.Premultiply(SharpDX.Color4@,SharpDX.Color4@)">
- <summary>
- Computes the premultiplied value of the provided color.
- </summary>
- <param name="value">The non-premultiplied value.</param>
- <param name="result">The premultiplied result.</param>
- </member>
- <member name="M:SharpDX.Color4.Premultiply(SharpDX.Color4)">
- <summary>
- Computes the premultiplied value of the provided color.
- </summary>
- <param name="value">The non-premultiplied value.</param>
- <returns>The premultiplied result.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Addition(SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <returns>The sum of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_UnaryPlus(SharpDX.Color4)">
- <summary>
- Assert a color (return it unchanged).
- </summary>
- <param name="value">The color to assert (unchanged).</param>
- <returns>The asserted (unchanged) color.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Subtraction(SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract.</param>
- <returns>The difference of the two colors.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_UnaryNegation(SharpDX.Color4)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <returns>A negated color.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Multiply(System.Single,SharpDX.Color4)">
- <summary>
- Scales a color.
- </summary>
- <param name="scale">The factor by which to scale the color.</param>
- <param name="value">The color to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Multiply(SharpDX.Color4,System.Single)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The factor by which to scale the color.</param>
- <param name="scale">The color to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Multiply(SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <returns>The modulated color.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Equality(SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Inequality(SharpDX.Color4,SharpDX.Color4)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Explicit(SharpDX.Color4)~SharpDX.Color3">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color4"/> to <see cref="T:SharpDX.Color3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Explicit(SharpDX.Color4)~SharpDX.Vector3">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color4"/> to <see cref="T:SharpDX.Vector3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Implicit(SharpDX.Color4)~SharpDX.Vector4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Color4"/> to <see cref="T:SharpDX.Vector4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Explicit(SharpDX.Vector3)~SharpDX.Color4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector3"/> to <see cref="T:SharpDX.Color4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Explicit(SharpDX.Vector4)~SharpDX.Color4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector4"/> to <see cref="T:SharpDX.Color4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Explicit(SharpDX.ColorBGRA)~SharpDX.Color4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector3"/> to <see cref="T:SharpDX.Color4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Explicit(SharpDX.Color4)~SharpDX.ColorBGRA">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector4"/> to <see cref="T:SharpDX.Color4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Explicit(SharpDX.Color4)~System.Int32">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color4"/> to <see cref="T:System.Int32"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>
- The result of the conversion.
- </returns>
- </member>
- <member name="M:SharpDX.Color4.op_Explicit(System.Int32)~SharpDX.Color4">
- <summary>
- Performs an explicit conversion from <see cref="T:System.Int32"/> to <see cref="T:SharpDX.Color4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>
- The result of the conversion.
- </returns>
- </member>
- <member name="M:SharpDX.Color4.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color4.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to apply to each channel (float).</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color4.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color4.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to apply to each channel (float).</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Color4.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Color4.Equals(SharpDX.Color4@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Color4"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Color4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Color4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Color4.Equals(SharpDX.Color4)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Color4"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Color4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Color4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Color4.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Color4.op_Implicit(SharpDX.Color4)~SharpDX.Mathematics.Interop.RawColor4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Color4"/> to <see cref="T:SharpDX.Mathematics.Interop.RawColor4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Color4.op_Implicit(SharpDX.Mathematics.Interop.RawColor4)~SharpDX.Color4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawColor4"/> to <see cref="T:SharpDX.Color4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.ColorBGRA">
- <summary>
- Represents a 32-bit color (4 bytes) in the form of BGRA (in byte order: B, G, B, A).
- </summary>
- </member>
- <member name="F:SharpDX.ColorBGRA.B">
- <summary>
- The blue component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.ColorBGRA.G">
- <summary>
- The green component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.ColorBGRA.R">
- <summary>
- The red component of the color.
- </summary>
- </member>
- <member name="F:SharpDX.ColorBGRA.A">
- <summary>
- The alpha component of the color.
- </summary>
- </member>
- <member name="M:SharpDX.ColorBGRA.#ctor(System.Byte)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ColorBGRA"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ColorBGRA"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.#ctor(System.Byte,System.Byte,System.Byte,System.Byte)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ColorBGRA"/> struct.
- </summary>
- <param name="red">The red component of the color.</param>
- <param name="green">The green component of the color.</param>
- <param name="blue">The blue component of the color.</param>
- <param name="alpha">The alpha component of the color.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.#ctor(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ColorBGRA"/> struct.
- </summary>
- <param name="red">The red component of the color.</param>
- <param name="green">The green component of the color.</param>
- <param name="blue">The blue component of the color.</param>
- <param name="alpha">The alpha component of the color.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.#ctor(SharpDX.Vector4)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ColorBGRA"/> struct.
- </summary>
- <param name="value">The red, green, blue, and alpha components of the color.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.#ctor(SharpDX.Vector3,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ColorBGRA"/> struct.
- </summary>
- <param name="value">The red, green, and blue components of the color.</param>
- <param name="alpha">The alpha component of the color.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.#ctor(System.UInt32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ColorBGRA"/> struct.
- </summary>
- <param name="bgra">A packed integer containing all four color components in BGRA order.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ColorBGRA"/> struct.
- </summary>
- <param name="bgra">A packed integer containing all four color components in BGRA.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ColorBGRA"/> struct.
- </summary>
- <param name="values">The values to assign to the red, green, and blue, alpha components of the color. This must be an array with four elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than four elements.</exception>
- </member>
- <member name="M:SharpDX.ColorBGRA.#ctor(System.Byte[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ColorBGRA"/> struct.
- </summary>
- <param name="values">The values to assign to the red, green, and blue, alpha components of the color. This must be an array with four elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than four elements.</exception>
- </member>
- <member name="P:SharpDX.ColorBGRA.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the alpha, red, green, or blue component, depending on the index.</value>
- <param name="index">The index of the component to access. Use 0 for the alpha component, 1 for the red component, 2 for the green component, and 3 for the blue component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.ColorBGRA.ToBgra">
- <summary>
- Converts the color into a packed integer.
- </summary>
- <returns>A packed integer containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.ToRgba">
- <summary>
- Converts the color into a packed integer.
- </summary>
- <returns>A packed integer containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.ToVector3">
- <summary>
- Converts the color into a three component vector.
- </summary>
- <returns>A three component vector containing the red, green, and blue components of the color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.ToColor3">
- <summary>
- Converts the color into a three component color.
- </summary>
- <returns>A three component color containing the red, green, and blue components of the color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.ToVector4">
- <summary>
- Converts the color into a four component vector.
- </summary>
- <returns>A four component vector containing all four color components.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.ToArray">
- <summary>
- Creates an array containing the elements of the color.
- </summary>
- <returns>A four-element array containing the components of the color in BGRA order.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.GetBrightness">
- <summary>
- Gets the brightness.
- </summary>
- <returns>The Hue-Saturation-Brightness (HSB) saturation for this <see cref="T:SharpDX.Color"/></returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.GetHue">
- <summary>
- Gets the hue.
- </summary>
- <returns>The Hue-Saturation-Brightness (HSB) saturation for this <see cref="T:SharpDX.Color"/></returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.GetSaturation">
- <summary>
- Gets the saturation.
- </summary>
- <returns>The Hue-Saturation-Brightness (HSB) saturation for this <see cref="T:SharpDX.Color"/></returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.FromBgra(System.Int32)">
- <summary>
- Converts the color from a packed BGRA integer.
- </summary>
- <param name="color">A packed integer containing all four color components in BGRA order</param>
- <returns>A color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.FromBgra(System.UInt32)">
- <summary>
- Converts the color from a packed BGRA integer.
- </summary>
- <param name="color">A packed integer containing all four color components in BGRA order</param>
- <returns>A color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.FromRgba(System.Int32)">
- <summary>
- Converts the color from a packed RGBA integer.
- </summary>
- <param name="color">A packed integer containing all four color components in RGBA order</param>
- <returns>A color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.FromRgba(System.UInt32)">
- <summary>
- Converts the color from a packed RGBA integer.
- </summary>
- <param name="color">A packed integer containing all four color components in RGBA order</param>
- <returns>A color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Add(SharpDX.ColorBGRA@,SharpDX.ColorBGRA@,SharpDX.ColorBGRA@)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <param name="result">When the method completes, completes the sum of the two colors.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.Add(SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <returns>The sum of the two colors.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Subtract(SharpDX.ColorBGRA@,SharpDX.ColorBGRA@,SharpDX.ColorBGRA@)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract.</param>
- <param name="result">WHen the method completes, contains the difference of the two colors.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.Subtract(SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract</param>
- <returns>The difference of the two colors.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Modulate(SharpDX.ColorBGRA@,SharpDX.ColorBGRA@,SharpDX.ColorBGRA@)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <param name="result">When the method completes, contains the modulated color.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.Modulate(SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <returns>The modulated color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Scale(SharpDX.ColorBGRA@,System.Single,SharpDX.ColorBGRA@)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The color to scale.</param>
- <param name="scale">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled color.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.Scale(SharpDX.ColorBGRA,System.Single)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The color to scale.</param>
- <param name="scale">The amount by which to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Negate(SharpDX.ColorBGRA@,SharpDX.ColorBGRA@)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <param name="result">When the method completes, contains the negated color.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.Negate(SharpDX.ColorBGRA)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <returns>The negated color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Clamp(SharpDX.ColorBGRA@,SharpDX.ColorBGRA@,SharpDX.ColorBGRA@,SharpDX.ColorBGRA@)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <param name="result">When the method completes, contains the clamped value.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.Clamp(SharpDX.ColorBGRA,SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <returns>The clamped value.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Lerp(SharpDX.ColorBGRA@,SharpDX.ColorBGRA@,System.Single,SharpDX.ColorBGRA@)">
- <summary>
- Performs a linear interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two colors.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.ColorBGRA.Lerp(SharpDX.ColorBGRA,SharpDX.ColorBGRA,System.Single)">
- <summary>
- Performs a linear interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two colors.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.ColorBGRA.SmoothStep(SharpDX.ColorBGRA@,SharpDX.ColorBGRA@,System.Single,SharpDX.ColorBGRA@)">
- <summary>
- Performs a cubic interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two colors.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.SmoothStep(SharpDX.ColorBGRA,SharpDX.ColorBGRA,System.Single)">
- <summary>
- Performs a cubic interpolation between two colors.
- </summary>
- <param name="start">Start color.</param>
- <param name="end">End color.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two colors.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Max(SharpDX.ColorBGRA@,SharpDX.ColorBGRA@,SharpDX.ColorBGRA@)">
- <summary>
- Returns a color containing the smallest components of the specified colorss.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <param name="result">When the method completes, contains an new color composed of the largest components of the source colorss.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.Max(SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Returns a color containing the largest components of the specified colorss.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <returns>A color containing the largest components of the source colors.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Min(SharpDX.ColorBGRA@,SharpDX.ColorBGRA@,SharpDX.ColorBGRA@)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <param name="result">When the method completes, contains an new color composed of the smallest components of the source colors.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.Min(SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Returns a color containing the smallest components of the specified colors.
- </summary>
- <param name="left">The first source color.</param>
- <param name="right">The second source color.</param>
- <returns>A color containing the smallest components of the source colors.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.AdjustContrast(SharpDX.ColorBGRA@,System.Single,SharpDX.ColorBGRA@)">
- <summary>
- Adjusts the contrast of a color.
- </summary>
- <param name="value">The color whose contrast is to be adjusted.</param>
- <param name="contrast">The amount by which to adjust the contrast.</param>
- <param name="result">When the method completes, contains the adjusted color.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.AdjustContrast(SharpDX.ColorBGRA,System.Single)">
- <summary>
- Adjusts the contrast of a color.
- </summary>
- <param name="value">The color whose contrast is to be adjusted.</param>
- <param name="contrast">The amount by which to adjust the contrast.</param>
- <returns>The adjusted color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.AdjustSaturation(SharpDX.ColorBGRA@,System.Single,SharpDX.ColorBGRA@)">
- <summary>
- Adjusts the saturation of a color.
- </summary>
- <param name="value">The color whose saturation is to be adjusted.</param>
- <param name="saturation">The amount by which to adjust the saturation.</param>
- <param name="result">When the method completes, contains the adjusted color.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.AdjustSaturation(SharpDX.ColorBGRA,System.Single)">
- <summary>
- Adjusts the saturation of a color.
- </summary>
- <param name="value">The color whose saturation is to be adjusted.</param>
- <param name="saturation">The amount by which to adjust the saturation.</param>
- <returns>The adjusted color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Premultiply(SharpDX.ColorBGRA@,SharpDX.ColorBGRA@)">
- <summary>
- Computes the premultiplied value of the provided color.
- </summary>
- <param name="value">The non-premultiplied value.</param>
- <param name="result">The premultiplied result.</param>
- </member>
- <member name="M:SharpDX.ColorBGRA.Premultiply(SharpDX.ColorBGRA)">
- <summary>
- Computes the premultiplied value of the provided color.
- </summary>
- <param name="value">The non-premultiplied value.</param>
- <returns>The premultiplied result.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Addition(SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Adds two colors.
- </summary>
- <param name="left">The first color to add.</param>
- <param name="right">The second color to add.</param>
- <returns>The sum of the two colors.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_UnaryPlus(SharpDX.ColorBGRA)">
- <summary>
- Assert a color (return it unchanged).
- </summary>
- <param name="value">The color to assert (unchange).</param>
- <returns>The asserted (unchanged) color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Subtraction(SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Subtracts two colors.
- </summary>
- <param name="left">The first color to subtract.</param>
- <param name="right">The second color to subtract.</param>
- <returns>The difference of the two colors.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_UnaryNegation(SharpDX.ColorBGRA)">
- <summary>
- Negates a color.
- </summary>
- <param name="value">The color to negate.</param>
- <returns>A negated color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Multiply(System.Single,SharpDX.ColorBGRA)">
- <summary>
- Scales a color.
- </summary>
- <param name="scale">The factor by which to scale the color.</param>
- <param name="value">The color to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Multiply(SharpDX.ColorBGRA,System.Single)">
- <summary>
- Scales a color.
- </summary>
- <param name="value">The factor by which to scale the color.</param>
- <param name="scale">The color to scale.</param>
- <returns>The scaled color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Multiply(SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Modulates two colors.
- </summary>
- <param name="left">The first color to modulate.</param>
- <param name="right">The second color to modulate.</param>
- <returns>The modulated color.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Equality(SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Inequality(SharpDX.ColorBGRA,SharpDX.ColorBGRA)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Explicit(SharpDX.ColorBGRA)~SharpDX.Color3">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.ColorBGRA"/> to <see cref="T:SharpDX.Color3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Explicit(SharpDX.ColorBGRA)~SharpDX.Vector3">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.ColorBGRA"/> to <see cref="T:SharpDX.Vector3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Explicit(SharpDX.ColorBGRA)~SharpDX.Vector4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.ColorBGRA"/> to <see cref="T:SharpDX.Vector4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Explicit(SharpDX.ColorBGRA)~SharpDX.Color4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.ColorBGRA"/> to <see cref="T:SharpDX.Color4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Explicit(SharpDX.Vector3)~SharpDX.ColorBGRA">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector3"/> to <see cref="T:SharpDX.ColorBGRA"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Explicit(SharpDX.Color3)~SharpDX.ColorBGRA">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color3"/> to <see cref="T:SharpDX.ColorBGRA"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Explicit(SharpDX.Vector4)~SharpDX.ColorBGRA">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector4"/> to <see cref="T:SharpDX.ColorBGRA"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Explicit(SharpDX.Color4)~SharpDX.ColorBGRA">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Color4"/> to <see cref="T:SharpDX.ColorBGRA"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Implicit(SharpDX.Color)~SharpDX.ColorBGRA">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Color"/> to <see cref="T:SharpDX.ColorBGRA"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Implicit(SharpDX.ColorBGRA)~SharpDX.Color">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.ColorBGRA"/> to <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Explicit(SharpDX.ColorBGRA)~System.Int32">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.ColorBGRA"/> to <see cref="T:System.Int32"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>
- The result of the conversion.
- </returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Explicit(System.Int32)~SharpDX.ColorBGRA">
- <summary>
- Performs an explicit conversion from <see cref="T:System.Int32"/> to <see cref="T:SharpDX.ColorBGRA"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>
- The result of the conversion.
- </returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to apply to each channel (byte).</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format to apply to each channel (byte).</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Equals(SharpDX.ColorBGRA@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.ColorBGRA"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.ColorBGRA"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.ColorBGRA"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Equals(SharpDX.ColorBGRA)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.ColorBGRA"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.ColorBGRA"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.ColorBGRA"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Implicit(SharpDX.ColorBGRA)~SharpDX.Mathematics.Interop.RawColorBGRA">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.ColorBGRA"/> to <see cref="T:SharpDX.Mathematics.Interop.RawColorBGRA"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ColorBGRA.op_Implicit(SharpDX.Mathematics.Interop.RawColorBGRA)~SharpDX.ColorBGRA">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawColorBGRA"/> to <see cref="T:SharpDX.ColorBGRA"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.AngleType">
- <summary>
- Describes the type of angle.
- </summary>
- </member>
- <member name="F:SharpDX.AngleType.Revolution">
- <summary>
- Specifies an angle measurement in revolutions.
- </summary>
- </member>
- <member name="F:SharpDX.AngleType.Degree">
- <summary>
- Specifies an angle measurement in degrees.
- </summary>
- </member>
- <member name="F:SharpDX.AngleType.Radian">
- <summary>
- Specifies an angle measurement in radians.
- </summary>
- </member>
- <member name="F:SharpDX.AngleType.Gradian">
- <summary>
- Specifies an angle measurement in gradians.
- </summary>
- </member>
- <member name="T:SharpDX.ContainmentType">
- <summary>
- Describes how one bounding volume contains another.
- </summary>
- </member>
- <member name="F:SharpDX.ContainmentType.Disjoint">
- <summary>
- The two bounding volumes don't intersect at all.
- </summary>
- </member>
- <member name="F:SharpDX.ContainmentType.Contains">
- <summary>
- One bounding volume completely contains another.
- </summary>
- </member>
- <member name="F:SharpDX.ContainmentType.Intersects">
- <summary>
- The two bounding volumes overlap.
- </summary>
- </member>
- <member name="T:SharpDX.PlaneIntersectionType">
- <summary>
- Describes the result of an intersection with a plane in three dimensions.
- </summary>
- </member>
- <member name="F:SharpDX.PlaneIntersectionType.Back">
- <summary>
- The object is behind the plane.
- </summary>
- </member>
- <member name="F:SharpDX.PlaneIntersectionType.Front">
- <summary>
- The object is in front of the plane.
- </summary>
- </member>
- <member name="F:SharpDX.PlaneIntersectionType.Intersecting">
- <summary>
- The object is intersecting the plane.
- </summary>
- </member>
- <member name="T:SharpDX.FrustumCameraParams">
- <summary>
- Frustum camera parameters.
- </summary>
- </member>
- <member name="F:SharpDX.FrustumCameraParams.Position">
- <summary>
- Position of the camera.
- </summary>
- </member>
- <member name="F:SharpDX.FrustumCameraParams.LookAtDir">
- <summary>
- Looking at direction of the camera.
- </summary>
- </member>
- <member name="F:SharpDX.FrustumCameraParams.UpDir">
- <summary>
- Up direction.
- </summary>
- </member>
- <member name="F:SharpDX.FrustumCameraParams.FOV">
- <summary>
- Field of view.
- </summary>
- </member>
- <member name="F:SharpDX.FrustumCameraParams.ZNear">
- <summary>
- Z near distance.
- </summary>
- </member>
- <member name="F:SharpDX.FrustumCameraParams.ZFar">
- <summary>
- Z far distance.
- </summary>
- </member>
- <member name="F:SharpDX.FrustumCameraParams.AspectRatio">
- <summary>
- Aspect ratio.
- </summary>
- </member>
- <member name="T:SharpDX.Half">
- <summary>
- A half precision (16 bit) floating point value.
- </summary>
- </member>
- <member name="F:SharpDX.Half.PrecisionDigits">
- <summary>
- Number of decimal digits of precision.
- </summary>
- </member>
- <member name="F:SharpDX.Half.MantissaBits">
- <summary>
- Number of bits in the mantissa.
- </summary>
- </member>
- <member name="F:SharpDX.Half.MaximumDecimalExponent">
- <summary>
- Maximum decimal exponent.
- </summary>
- </member>
- <member name="F:SharpDX.Half.MaximumBinaryExponent">
- <summary>
- Maximum binary exponent.
- </summary>
- </member>
- <member name="F:SharpDX.Half.MinimumDecimalExponent">
- <summary>
- Minimum decimal exponent.
- </summary>
- </member>
- <member name="F:SharpDX.Half.MinimumBinaryExponent">
- <summary>
- Minimum binary exponent.
- </summary>
- </member>
- <member name="F:SharpDX.Half.ExponentRadix">
- <summary>
- Exponent radix.
- </summary>
- </member>
- <member name="F:SharpDX.Half.AdditionRounding">
- <summary>
- Additional rounding.
- </summary>
- </member>
- <member name="F:SharpDX.Half.Epsilon">
- <summary>
- Smallest such that 1.0 + epsilon != 1.0
- </summary>
- </member>
- <member name="F:SharpDX.Half.MaxValue">
- <summary>
- Maximum value of the number.
- </summary>
- </member>
- <member name="F:SharpDX.Half.MinValue">
- <summary>
- Minimum value of the number.
- </summary>
- </member>
- <member name="M:SharpDX.Half.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Half" /> structure.
- </summary>
- <param name = "value">The floating point value that should be stored in 16 bit format.</param>
- </member>
- <member name="M:SharpDX.Half.#ctor(System.UInt16)">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Half" /> structure.
- </summary>
- <param name = "rawvalue">The floating point value that should be stored in 16 bit format.</param>
- </member>
- <member name="P:SharpDX.Half.RawValue">
- <summary>
- Gets or sets the raw 16 bit value used to back this half-float.
- </summary>
- </member>
- <member name="M:SharpDX.Half.ConvertToFloat(SharpDX.Half[])">
- <summary>
- Converts an array of half precision values into full precision values.
- </summary>
- <param name = "values">The values to be converted.</param>
- <returns>An array of converted values.</returns>
- </member>
- <member name="M:SharpDX.Half.ConvertToHalf(System.Single[])">
- <summary>
- Converts an array of full precision values into half precision values.
- </summary>
- <param name = "values">The values to be converted.</param>
- <returns>An array of converted values.</returns>
- </member>
- <member name="M:SharpDX.Half.op_Implicit(System.Single)~SharpDX.Half">
- <summary>
- Performs an explicit conversion from <see cref = "T:System.Single" /> to <see cref = "T:SharpDX.Half" />.
- </summary>
- <param name = "value">The value to be converted.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.Half.op_Implicit(SharpDX.Half)~System.Single">
- <summary>
- Performs an implicit conversion from <see cref = "T:SharpDX.Half" /> to <see cref = "T:System.Single" />.
- </summary>
- <param name = "value">The value to be converted.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.Half.op_Equality(SharpDX.Half,SharpDX.Half)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name = "left">The first value to compare.</param>
- <param name = "right">The second value to compare.</param>
- <returns>
- <c>true</c> if <paramref name = "left" /> has the same value as <paramref name = "right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half.op_Inequality(SharpDX.Half,SharpDX.Half)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name = "left">The first value to compare.</param>
- <param name = "right">The second value to compare.</param>
- <returns>
- <c>true</c> if <paramref name = "left" /> has a different value than <paramref name = "right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half.ToString">
- <summary>
- Converts the value of the object to its equivalent string representation.
- </summary>
- <returns>The string representation of the value of this instance.</returns>
- </member>
- <member name="M:SharpDX.Half.GetHashCode">
- <summary>
- Returns the hash code for this instance.
- </summary>
- <returns>A 32-bit signed integer hash code.</returns>
- </member>
- <member name="M:SharpDX.Half.Equals(SharpDX.Half@,SharpDX.Half@)">
- <summary>
- Determines whether the specified object instances are considered equal.
- </summary>
- <param name = "value1" />
- <param name = "value2" />
- <returns>
- <c>true</c> if <paramref name = "value1" /> is the same instance as <paramref name = "value2" /> or
- if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half.Equals(SharpDX.Half)">
- <summary>
- Returns a value that indicates whether the current instance is equal to the specified object.
- </summary>
- <param name = "other">Object to make the comparison with.</param>
- <returns>
- <c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
- </member>
- <member name="M:SharpDX.Half.Equals(System.Object)">
- <summary>
- Returns a value that indicates whether the current instance is equal to a specified object.
- </summary>
- <param name = "obj">Object to make the comparison with.</param>
- <returns>
- <c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
- </member>
- <member name="T:SharpDX.Half2">
- <summary>
- Defines a two component vector, using half precision floating point coordinates.
- </summary>
- </member>
- <member name="F:SharpDX.Half2.X">
- <summary>
- Gets or sets the X component of the vector.
- </summary>
- <value>The X component of the vector.</value>
- </member>
- <member name="F:SharpDX.Half2.Y">
- <summary>
- Gets or sets the Y component of the vector.
- </summary>
- <value>The Y component of the vector.</value>
- </member>
- <member name="M:SharpDX.Half2.#ctor(SharpDX.Half,SharpDX.Half)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half2" /> structure.
- </summary>
- <param name="x">The X component.</param>
- <param name="y">The Y component.</param>
- </member>
- <member name="M:SharpDX.Half2.#ctor(System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half2" /> structure.
- </summary>
- <param name="x">The X component.</param>
- <param name="y">The Y component.</param>
- </member>
- <member name="M:SharpDX.Half2.#ctor(System.UInt16,System.UInt16)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half2" /> structure.
- </summary>
- <param name="x">The X component.</param>
- <param name="y">The Y component.</param>
- </member>
- <member name="M:SharpDX.Half2.#ctor(SharpDX.Half)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half2" /> structure.
- </summary>
- <param name="value">The value to set for both the X and Y components.</param>
- </member>
- <member name="M:SharpDX.Half2.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half2" /> structure.
- </summary>
- <param name="value">Value to initialize X and Y components with.</param>
- </member>
- <member name="M:SharpDX.Half2.op_Implicit(SharpDX.Vector2)~SharpDX.Half2">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector2"/> to <see cref="T:SharpDX.Half2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half2.op_Implicit(SharpDX.Half2)~SharpDX.Vector2">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Half2"/> to <see cref="T:SharpDX.Vector2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half2.op_Equality(SharpDX.Half2,SharpDX.Half2)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns>
- <c>true</c> if <paramref name="left" /> has the same value as <paramref name="right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half2.op_Inequality(SharpDX.Half2,SharpDX.Half2)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns>
- <c>true</c> if <paramref name="left" /> has a different value than <paramref name="right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half2.GetHashCode">
- <summary>
- Returns the hash code for this instance.
- </summary>
- <returns>A 32-bit signed integer hash code.</returns>
- </member>
- <member name="M:SharpDX.Half2.Equals(SharpDX.Half2@,SharpDX.Half2@)">
- <summary>
- Determines whether the specified object instances are considered equal.
- </summary>
- <param name="value1" />
- <param name="value2" />
- <returns>
- <c>true</c> if <paramref name="value1" /> is the same instance as <paramref name="value2" /> or
- if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half2.Equals(SharpDX.Half2)">
- <summary>
- Returns a value that indicates whether the current instance is equal to the specified object.
- </summary>
- <param name="other">Object to make the comparison with.</param>
- <returns>
- <c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
- </member>
- <member name="M:SharpDX.Half2.Equals(System.Object)">
- <summary>
- Returns a value that indicates whether the current instance is equal to a specified object.
- </summary>
- <param name="obj">Object to make the comparison with.</param>
- <returns>
- <c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
- </member>
- <member name="T:SharpDX.Half3">
- <summary>
- Defines a three component vector, using half precision floating point coordinates.
- </summary>
- </member>
- <member name="F:SharpDX.Half3.X">
- <summary>
- Gets or sets the X component of the vector.
- </summary>
- <value>The X component of the vector.</value>
- </member>
- <member name="F:SharpDX.Half3.Y">
- <summary>
- Gets or sets the Y component of the vector.
- </summary>
- <value>The Y component of the vector.</value>
- </member>
- <member name="F:SharpDX.Half3.Z">
- <summary>
- Gets or sets the Z component of the vector.
- </summary>
- <value>The Z component of the vector.</value>
- </member>
- <member name="M:SharpDX.Half3.#ctor(SharpDX.Half,SharpDX.Half,SharpDX.Half)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half3" /> structure.
- </summary>
- <param name="x">The X component.</param>
- <param name="y">The Y component.</param>
- <param name="z">The Z component.</param>
- </member>
- <member name="M:SharpDX.Half3.#ctor(System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half3" /> structure.
- </summary>
- <param name="x">The X component.</param>
- <param name="y">The Y component.</param>
- <param name="z">The Z component.</param>
- </member>
- <member name="M:SharpDX.Half3.#ctor(System.UInt16,System.UInt16,System.UInt16)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half3" /> structure.
- </summary>
- <param name="x">The X component.</param>
- <param name="y">The Y component.</param>
- <param name="z">The Z component.</param>
- </member>
- <member name="M:SharpDX.Half3.#ctor(SharpDX.Half)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half3" /> structure.
- </summary>
- <param name="value">The value to set for the X, Y, and Z components.</param>
- </member>
- <member name="M:SharpDX.Half3.op_Implicit(SharpDX.Vector3)~SharpDX.Half3">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Vector3"/> to <see cref="T:SharpDX.Half3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half3.op_Implicit(SharpDX.Half3)~SharpDX.Vector3">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Half3"/> to <see cref="T:SharpDX.Vector3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half3.op_Explicit(SharpDX.Vector2)~SharpDX.Half3">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector2"/> to <see cref="T:SharpDX.Half3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half3.op_Explicit(SharpDX.Half3)~SharpDX.Vector2">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Half3"/> to <see cref="T:SharpDX.Vector2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half3.op_Equality(SharpDX.Half3,SharpDX.Half3)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns>
- <c>true</c> if <paramref name="left" /> has the same value as <paramref name="right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half3.op_Inequality(SharpDX.Half3,SharpDX.Half3)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns>
- <c>true</c> if <paramref name="left" /> has a different value than <paramref name="right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half3.GetHashCode">
- <summary>
- Returns the hash code for this instance.
- </summary>
- <returns>A 32-bit signed integer hash code.</returns>
- </member>
- <member name="M:SharpDX.Half3.Equals(SharpDX.Half3@,SharpDX.Half3@)">
- <summary>
- Determines whether the specified object instances are considered equal.
- </summary>
- <param name="value1" />
- <param name="value2" />
- <returns>
- <c>true</c> if <paramref name="value1" /> is the same instance as <paramref name="value2" /> or
- if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half3.Equals(SharpDX.Half3)">
- <summary>
- Returns a value that indicates whether the current instance is equal to the specified object.
- </summary>
- <param name="other">Object to make the comparison with.</param>
- <returns>
- <c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
- </member>
- <member name="M:SharpDX.Half3.Equals(System.Object)">
- <summary>
- Returns a value that indicates whether the current instance is equal to a specified object.
- </summary>
- <param name="obj">Object to make the comparison with.</param>
- <returns>
- <c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
- </member>
- <member name="T:SharpDX.Half4">
- <summary>
- Defines a four component vector, using half precision floating point coordinates.
- </summary>
- </member>
- <member name="F:SharpDX.Half4.X">
- <summary>
- Gets or sets the X component of the vector.
- </summary>
- <value>The X component of the vector.</value>
- </member>
- <member name="F:SharpDX.Half4.Y">
- <summary>
- Gets or sets the Y component of the vector.
- </summary>
- <value>The Y component of the vector.</value>
- </member>
- <member name="F:SharpDX.Half4.Z">
- <summary>
- Gets or sets the Z component of the vector.
- </summary>
- <value>The Z component of the vector.</value>
- </member>
- <member name="F:SharpDX.Half4.W">
- <summary>
- Gets or sets the W component of the vector.
- </summary>
- <value>The W component of the vector.</value>
- </member>
- <member name="M:SharpDX.Half4.#ctor(SharpDX.Half,SharpDX.Half,SharpDX.Half,SharpDX.Half)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half4" /> structure.
- </summary>
- <param name="x">The X component.</param>
- <param name="y">The Y component.</param>
- <param name="z">The Z component.</param>
- <param name="w">The W component.</param>
- </member>
- <member name="M:SharpDX.Half4.#ctor(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half4" /> structure.
- </summary>
- <param name="x">The X component.</param>
- <param name="y">The Y component.</param>
- <param name="z">The Z component.</param>
- <param name="w">The W component.</param>
- </member>
- <member name="M:SharpDX.Half4.#ctor(System.UInt16,System.UInt16,System.UInt16,System.UInt16)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half4" /> structure.
- </summary>
- <param name="x">The X component.</param>
- <param name="y">The Y component.</param>
- <param name="z">The Z component.</param>
- <param name="w">The W component.</param>
- </member>
- <member name="M:SharpDX.Half4.#ctor(SharpDX.Half)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Half4" /> structure.
- </summary>
- <param name="value">The value to set for the X, Y, Z, and W components.</param>
- </member>
- <member name="M:SharpDX.Half4.op_Implicit(SharpDX.Vector4)~SharpDX.Half4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Vector4"/> to <see cref="T:SharpDX.Half4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half4.op_Implicit(SharpDX.Half4)~SharpDX.Vector4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Half4"/> to <see cref="T:SharpDX.Vector4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half4.op_Explicit(SharpDX.Vector3)~SharpDX.Half4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector3"/> to <see cref="T:SharpDX.Half4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half4.op_Explicit(SharpDX.Half4)~SharpDX.Vector3">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Half4"/> to <see cref="T:SharpDX.Vector3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half4.op_Explicit(SharpDX.Vector2)~SharpDX.Half4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector2"/> to <see cref="T:SharpDX.Half4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half4.op_Explicit(SharpDX.Half4)~SharpDX.Vector2">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Half4"/> to <see cref="T:SharpDX.Vector2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Half4.op_Equality(SharpDX.Half4,SharpDX.Half4)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns>
- <c>true</c> if <paramref name="left" /> has the same value as <paramref name="right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half4.op_Inequality(SharpDX.Half4,SharpDX.Half4)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns>
- <c>true</c> if <paramref name="left" /> has a different value than <paramref name="right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half4.GetHashCode">
- <summary>
- Returns the hash code for this instance.
- </summary>
- <returns>A 32-bit signed integer hash code.</returns>
- </member>
- <member name="M:SharpDX.Half4.Equals(SharpDX.Half4@,SharpDX.Half4@)">
- <summary>
- Determines whether the specified object instances are considered equal.
- </summary>
- <param name="value1" />
- <param name="value2" />
- <returns>
- <c>true</c> if <paramref name="value1" /> is the same instance as <paramref name="value2" /> or
- if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Half4.Equals(SharpDX.Half4)">
- <summary>
- Returns a value that indicates whether the current instance is equal to the specified object.
- </summary>
- <param name="other">Object to make the comparison with.</param>
- <returns>
- <c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
- </member>
- <member name="M:SharpDX.Half4.Equals(System.Object)">
- <summary>
- Returns a value that indicates whether the current instance is equal to a specified object.
- </summary>
- <param name="obj">Object to make the comparison with.</param>
- <returns>
- <c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
- </member>
- <member name="T:SharpDX.HalfUtils">
- <summary>
- Helper class to perform Half/Float conversion.
- Code extract from paper : www.fox-toolkit.org/ftp/fasthalffloatconversion.pdf by Jeroen van der Zijp
- </summary>
- </member>
- <member name="M:SharpDX.HalfUtils.Unpack(System.UInt16)">
- <summary>
- Unpacks the specified h.
- </summary>
- <param name="h">The h.</param>
- <returns></returns>
- </member>
- <member name="M:SharpDX.HalfUtils.Pack(System.Single)">
- <summary>
- Packs the specified f.
- </summary>
- <param name="f">The f.</param>
- <returns></returns>
- </member>
- <member name="T:SharpDX.Int3">
- <summary>
- Represents a three dimensional mathematical int vector.
- </summary>
- </member>
- <member name="F:SharpDX.Int3.SizeInBytes">
- <summary>
- The size of the <see cref = "T:SharpDX.Int3" /> type, in bytes.
- </summary>
- </member>
- <member name="F:SharpDX.Int3.Zero">
- <summary>
- A <see cref = "T:SharpDX.Int3" /> with all of its components set to zero.
- </summary>
- </member>
- <member name="F:SharpDX.Int3.UnitX">
- <summary>
- The X unit <see cref = "T:SharpDX.Int3" /> (1, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Int3.UnitY">
- <summary>
- The Y unit <see cref = "T:SharpDX.Int3" /> (0, 1, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Int3.UnitZ">
- <summary>
- The Z unit <see cref = "T:SharpDX.Int3" /> (0, 0, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Int3.One">
- <summary>
- A <see cref = "T:SharpDX.Int3" /> with all of its components set to one.
- </summary>
- </member>
- <member name="F:SharpDX.Int3.X">
- <summary>
- The X component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Int3.Y">
- <summary>
- The Y component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Int3.Z">
- <summary>
- The Z component of the vector.
- </summary>
- </member>
- <member name="M:SharpDX.Int3.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Int3" /> struct.
- </summary>
- <param name = "value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Int3.#ctor(System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Int3" /> struct.
- </summary>
- <param name = "x">Initial value for the X component of the vector.</param>
- <param name = "y">Initial value for the Y component of the vector.</param>
- <param name = "z">Initial value for the Z component of the vector.</param>
- </member>
- <member name="M:SharpDX.Int3.#ctor(System.Int32[])">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Int3" /> struct.
- </summary>
- <param name = "values">The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements.</param>
- <exception cref = "T:System.ArgumentNullException">Thrown when <paramref name = "values" /> is <c>null</c>.</exception>
- <exception cref = "T:System.ArgumentOutOfRangeException">Thrown when <paramref name = "values" /> contains more or less than four elements.</exception>
- </member>
- <member name="P:SharpDX.Int3.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the X, Y, Z, or W component, depending on the index.</value>
- <param name = "index">The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref = "T:System.ArgumentOutOfRangeException">Thrown when the <paramref name = "index" /> is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Int3.ToArray">
- <summary>
- Creates an array containing the elements of the vector.
- </summary>
- <returns>A four-element array containing the components of the vector.</returns>
- </member>
- <member name="M:SharpDX.Int3.Add(SharpDX.Int3@,SharpDX.Int3@,SharpDX.Int3@)">
- <summary>
- Adds two vectors.
- </summary>
- <param name = "left">The first vector to add.</param>
- <param name = "right">The second vector to add.</param>
- <param name = "result">When the method completes, contains the sum of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Int3.Add(SharpDX.Int3,SharpDX.Int3)">
- <summary>
- Adds two vectors.
- </summary>
- <param name = "left">The first vector to add.</param>
- <param name = "right">The second vector to add.</param>
- <returns>The sum of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Int3.Subtract(SharpDX.Int3@,SharpDX.Int3@,SharpDX.Int3@)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name = "left">The first vector to subtract.</param>
- <param name = "right">The second vector to subtract.</param>
- <param name = "result">When the method completes, contains the difference of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Int3.Subtract(SharpDX.Int3,SharpDX.Int3)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name = "left">The first vector to subtract.</param>
- <param name = "right">The second vector to subtract.</param>
- <returns>The difference of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Int3.Multiply(SharpDX.Int3@,System.Int32,SharpDX.Int3@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <param name = "result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Int3.Multiply(SharpDX.Int3,System.Int32)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Int3.Modulate(SharpDX.Int3@,SharpDX.Int3@,SharpDX.Int3@)">
- <summary>
- Modulates a vector with another by performing component-wise multiplication.
- </summary>
- <param name = "left">The first vector to modulate.</param>
- <param name = "right">The second vector to modulate.</param>
- <param name = "result">When the method completes, contains the modulated vector.</param>
- </member>
- <member name="M:SharpDX.Int3.Modulate(SharpDX.Int3,SharpDX.Int3)">
- <summary>
- Modulates a vector with another by performing component-wise multiplication.
- </summary>
- <param name = "left">The first vector to modulate.</param>
- <param name = "right">The second vector to modulate.</param>
- <returns>The modulated vector.</returns>
- </member>
- <member name="M:SharpDX.Int3.Divide(SharpDX.Int3@,System.Int32,SharpDX.Int3@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <param name = "result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Int3.Divide(SharpDX.Int3,System.Int32)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Int3.Negate(SharpDX.Int3@,SharpDX.Int3@)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name = "value">The vector to negate.</param>
- <param name = "result">When the method completes, contains a vector facing in the opposite direction.</param>
- </member>
- <member name="M:SharpDX.Int3.Negate(SharpDX.Int3)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name = "value">The vector to negate.</param>
- <returns>A vector facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Int3.Clamp(SharpDX.Int3@,SharpDX.Int3@,SharpDX.Int3@,SharpDX.Int3@)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name = "value">The value to clamp.</param>
- <param name = "min">The minimum value.</param>
- <param name = "max">The maximum value.</param>
- <param name = "result">When the method completes, contains the clamped value.</param>
- </member>
- <member name="M:SharpDX.Int3.Clamp(SharpDX.Int3,SharpDX.Int3,SharpDX.Int3)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name = "value">The value to clamp.</param>
- <param name = "min">The minimum value.</param>
- <param name = "max">The maximum value.</param>
- <returns>The clamped value.</returns>
- </member>
- <member name="M:SharpDX.Int3.Max(SharpDX.Int3@,SharpDX.Int3@,SharpDX.Int3@)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name = "left">The first source vector.</param>
- <param name = "right">The second source vector.</param>
- <param name = "result">When the method completes, contains an new vector composed of the largest components of the source vectors.</param>
- </member>
- <member name="M:SharpDX.Int3.Max(SharpDX.Int3,SharpDX.Int3)">
- <summary>
- Returns a vector containing the largest components of the specified vectors.
- </summary>
- <param name = "left">The first source vector.</param>
- <param name = "right">The second source vector.</param>
- <returns>A vector containing the largest components of the source vectors.</returns>
- </member>
- <member name="M:SharpDX.Int3.Min(SharpDX.Int3@,SharpDX.Int3@,SharpDX.Int3@)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name = "left">The first source vector.</param>
- <param name = "right">The second source vector.</param>
- <param name = "result">When the method completes, contains an new vector composed of the smallest components of the source vectors.</param>
- </member>
- <member name="M:SharpDX.Int3.Min(SharpDX.Int3,SharpDX.Int3)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name = "left">The first source vector.</param>
- <param name = "right">The second source vector.</param>
- <returns>A vector containing the smallest components of the source vectors.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Addition(SharpDX.Int3,SharpDX.Int3)">
- <summary>
- Adds two vectors.
- </summary>
- <param name = "left">The first vector to add.</param>
- <param name = "right">The second vector to add.</param>
- <returns>The sum of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_UnaryPlus(SharpDX.Int3)">
- <summary>
- Assert a vector (return it unchanged).
- </summary>
- <param name = "value">The vector to assert (unchanged).</param>
- <returns>The asserted (unchanged) vector.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Subtraction(SharpDX.Int3,SharpDX.Int3)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name = "left">The first vector to subtract.</param>
- <param name = "right">The second vector to subtract.</param>
- <returns>The difference of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_UnaryNegation(SharpDX.Int3)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name = "value">The vector to negate.</param>
- <returns>A vector facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Multiply(System.Int32,SharpDX.Int3)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Multiply(SharpDX.Int3,System.Int32)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Division(SharpDX.Int3,System.Int32)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Equality(SharpDX.Int3,SharpDX.Int3)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name = "left">The first value to compare.</param>
- <param name = "right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name = "left" /> has the same value as <paramref name = "right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Inequality(SharpDX.Int3,SharpDX.Int3)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name = "left">The first value to compare.</param>
- <param name = "right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name = "left" /> has a different value than <paramref name = "right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Explicit(SharpDX.Int3)~SharpDX.Vector2">
- <summary>
- Performs an explicit conversion from <see cref = "T:SharpDX.Int3" /> to <see cref = "T:SharpDX.Vector2" />.
- </summary>
- <param name = "value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Explicit(SharpDX.Int3)~SharpDX.Vector3">
- <summary>
- Performs an explicit conversion from <see cref = "T:SharpDX.Int3" /> to <see cref = "T:SharpDX.Vector3" />.
- </summary>
- <param name = "value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int3.ToString">
- <summary>
- Returns a <see cref = "T:System.String" /> that represents this instance.
- </summary>
- <returns>
- A <see cref = "T:System.String" /> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Int3.ToString(System.String)">
- <summary>
- Returns a <see cref = "T:System.String" /> that represents this instance.
- </summary>
- <param name = "format">The format.</param>
- <returns>
- A <see cref = "T:System.String" /> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Int3.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref = "T:System.String" /> that represents this instance.
- </summary>
- <param name = "formatProvider">The format provider.</param>
- <returns>
- A <see cref = "T:System.String" /> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Int3.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref = "T:System.String" /> that represents this instance.
- </summary>
- <param name = "format">The format.</param>
- <param name = "formatProvider">The format provider.</param>
- <returns>
- A <see cref = "T:System.String" /> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Int3.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Int3.Equals(SharpDX.Int3@)">
- <summary>
- Determines whether the specified <see cref = "T:SharpDX.Int3" /> is equal to this instance.
- </summary>
- <param name = "other">The <see cref = "T:SharpDX.Int3" /> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref = "T:SharpDX.Int3" /> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Int3.Equals(SharpDX.Int3)">
- <summary>
- Determines whether the specified <see cref = "T:SharpDX.Int3" /> is equal to this instance.
- </summary>
- <param name = "other">The <see cref = "T:SharpDX.Int3" /> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref = "T:SharpDX.Int3" /> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Int3.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref = "T:System.Object" /> is equal to this instance.
- </summary>
- <param name = "value">The <see cref = "T:System.Object" /> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref = "T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Int3.op_Implicit(System.Int32[])~SharpDX.Int3">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Int32"/> array to <see cref="T:SharpDX.Int3"/>.
- </summary>
- <param name="input">The input.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Implicit(SharpDX.Int3)~System.Int32[]">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Int3"/> to <see cref="T:System.Int32"/> array.
- </summary>
- <param name="input">The input.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Implicit(SharpDX.Int3)~SharpDX.Mathematics.Interop.RawInt3">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Int3"/> to <see cref="T:SharpDX.Mathematics.Interop.RawInt3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int3.op_Implicit(SharpDX.Mathematics.Interop.RawInt3)~SharpDX.Int3">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawInt3"/> to <see cref="T:SharpDX.Int3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.Int4">
- <summary>
- Represents a four dimensional mathematical vector.
- </summary>
- </member>
- <member name="F:SharpDX.Int4.SizeInBytes">
- <summary>
- The size of the <see cref = "T:SharpDX.Int4" /> type, in bytes.
- </summary>
- </member>
- <member name="F:SharpDX.Int4.Zero">
- <summary>
- A <see cref = "T:SharpDX.Int4" /> with all of its components set to zero.
- </summary>
- </member>
- <member name="F:SharpDX.Int4.UnitX">
- <summary>
- The X unit <see cref = "T:SharpDX.Int4" /> (1, 0, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Int4.UnitY">
- <summary>
- The Y unit <see cref = "T:SharpDX.Int4" /> (0, 1, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Int4.UnitZ">
- <summary>
- The Z unit <see cref = "T:SharpDX.Int4" /> (0, 0, 1, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Int4.UnitW">
- <summary>
- The W unit <see cref = "T:SharpDX.Int4" /> (0, 0, 0, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Int4.One">
- <summary>
- A <see cref = "T:SharpDX.Int4" /> with all of its components set to one.
- </summary>
- </member>
- <member name="F:SharpDX.Int4.X">
- <summary>
- The X component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Int4.Y">
- <summary>
- The Y component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Int4.Z">
- <summary>
- The Z component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Int4.W">
- <summary>
- The W component of the vector.
- </summary>
- </member>
- <member name="M:SharpDX.Int4.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Int4" /> struct.
- </summary>
- <param name = "value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Int4.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Int4" /> struct.
- </summary>
- <param name = "x">Initial value for the X component of the vector.</param>
- <param name = "y">Initial value for the Y component of the vector.</param>
- <param name = "z">Initial value for the Z component of the vector.</param>
- <param name = "w">Initial value for the W component of the vector.</param>
- </member>
- <member name="M:SharpDX.Int4.#ctor(System.Int32[])">
- <summary>
- Initializes a new instance of the <see cref = "T:SharpDX.Int4" /> struct.
- </summary>
- <param name = "values">The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements.</param>
- <exception cref = "T:System.ArgumentNullException">Thrown when <paramref name = "values" /> is <c>null</c>.</exception>
- <exception cref = "T:System.ArgumentOutOfRangeException">Thrown when <paramref name = "values" /> contains more or less than four elements.</exception>
- </member>
- <member name="P:SharpDX.Int4.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the X, Y, Z, or W component, depending on the index.</value>
- <param name = "index">The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref = "T:System.ArgumentOutOfRangeException">Thrown when the <paramref name = "index" /> is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Int4.ToArray">
- <summary>
- Creates an array containing the elements of the vector.
- </summary>
- <returns>A four-element array containing the components of the vector.</returns>
- </member>
- <member name="M:SharpDX.Int4.Add(SharpDX.Int4@,SharpDX.Int4@,SharpDX.Int4@)">
- <summary>
- Adds two vectors.
- </summary>
- <param name = "left">The first vector to add.</param>
- <param name = "right">The second vector to add.</param>
- <param name = "result">When the method completes, contains the sum of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Int4.Add(SharpDX.Int4,SharpDX.Int4)">
- <summary>
- Adds two vectors.
- </summary>
- <param name = "left">The first vector to add.</param>
- <param name = "right">The second vector to add.</param>
- <returns>The sum of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Int4.Subtract(SharpDX.Int4@,SharpDX.Int4@,SharpDX.Int4@)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name = "left">The first vector to subtract.</param>
- <param name = "right">The second vector to subtract.</param>
- <param name = "result">When the method completes, contains the difference of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Int4.Subtract(SharpDX.Int4,SharpDX.Int4)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name = "left">The first vector to subtract.</param>
- <param name = "right">The second vector to subtract.</param>
- <returns>The difference of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Int4.Multiply(SharpDX.Int4@,System.Int32,SharpDX.Int4@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <param name = "result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Int4.Multiply(SharpDX.Int4,System.Int32)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Int4.Modulate(SharpDX.Int4@,SharpDX.Int4@,SharpDX.Int4@)">
- <summary>
- Modulates a vector with another by performing component-wise multiplication.
- </summary>
- <param name = "left">The first vector to modulate.</param>
- <param name = "right">The second vector to modulate.</param>
- <param name = "result">When the method completes, contains the modulated vector.</param>
- </member>
- <member name="M:SharpDX.Int4.Modulate(SharpDX.Int4,SharpDX.Int4)">
- <summary>
- Modulates a vector with another by performing component-wise multiplication.
- </summary>
- <param name = "left">The first vector to modulate.</param>
- <param name = "right">The second vector to modulate.</param>
- <returns>The modulated vector.</returns>
- </member>
- <member name="M:SharpDX.Int4.Divide(SharpDX.Int4@,System.Int32,SharpDX.Int4@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <param name = "result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Int4.Divide(SharpDX.Int4,System.Int32)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Int4.Negate(SharpDX.Int4@,SharpDX.Int4@)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name = "value">The vector to negate.</param>
- <param name = "result">When the method completes, contains a vector facing in the opposite direction.</param>
- </member>
- <member name="M:SharpDX.Int4.Negate(SharpDX.Int4)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name = "value">The vector to negate.</param>
- <returns>A vector facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Int4.Clamp(SharpDX.Int4@,SharpDX.Int4@,SharpDX.Int4@,SharpDX.Int4@)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name = "value">The value to clamp.</param>
- <param name = "min">The minimum value.</param>
- <param name = "max">The maximum value.</param>
- <param name = "result">When the method completes, contains the clamped value.</param>
- </member>
- <member name="M:SharpDX.Int4.Clamp(SharpDX.Int4,SharpDX.Int4,SharpDX.Int4)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name = "value">The value to clamp.</param>
- <param name = "min">The minimum value.</param>
- <param name = "max">The maximum value.</param>
- <returns>The clamped value.</returns>
- </member>
- <member name="M:SharpDX.Int4.Max(SharpDX.Int4@,SharpDX.Int4@,SharpDX.Int4@)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name = "left">The first source vector.</param>
- <param name = "right">The second source vector.</param>
- <param name = "result">When the method completes, contains an new vector composed of the largest components of the source vectors.</param>
- </member>
- <member name="M:SharpDX.Int4.Max(SharpDX.Int4,SharpDX.Int4)">
- <summary>
- Returns a vector containing the largest components of the specified vectors.
- </summary>
- <param name = "left">The first source vector.</param>
- <param name = "right">The second source vector.</param>
- <returns>A vector containing the largest components of the source vectors.</returns>
- </member>
- <member name="M:SharpDX.Int4.Min(SharpDX.Int4@,SharpDX.Int4@,SharpDX.Int4@)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name = "left">The first source vector.</param>
- <param name = "right">The second source vector.</param>
- <param name = "result">When the method completes, contains an new vector composed of the smallest components of the source vectors.</param>
- </member>
- <member name="M:SharpDX.Int4.Min(SharpDX.Int4,SharpDX.Int4)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name = "left">The first source vector.</param>
- <param name = "right">The second source vector.</param>
- <returns>A vector containing the smallest components of the source vectors.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Addition(SharpDX.Int4,SharpDX.Int4)">
- <summary>
- Adds two vectors.
- </summary>
- <param name = "left">The first vector to add.</param>
- <param name = "right">The second vector to add.</param>
- <returns>The sum of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_UnaryPlus(SharpDX.Int4)">
- <summary>
- Assert a vector (return it unchanged).
- </summary>
- <param name = "value">The vector to assert (unchanged).</param>
- <returns>The asserted (unchanged) vector.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Subtraction(SharpDX.Int4,SharpDX.Int4)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name = "left">The first vector to subtract.</param>
- <param name = "right">The second vector to subtract.</param>
- <returns>The difference of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_UnaryNegation(SharpDX.Int4)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name = "value">The vector to negate.</param>
- <returns>A vector facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Multiply(System.Int32,SharpDX.Int4)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Multiply(SharpDX.Int4,System.Int32)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Division(SharpDX.Int4,System.Int32)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name = "value">The vector to scale.</param>
- <param name = "scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Equality(SharpDX.Int4,SharpDX.Int4)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name = "left">The first value to compare.</param>
- <param name = "right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name = "left" /> has the same value as <paramref name = "right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Inequality(SharpDX.Int4,SharpDX.Int4)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name = "left">The first value to compare.</param>
- <param name = "right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name = "left" /> has a different value than <paramref name = "right" />; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Explicit(SharpDX.Int4)~SharpDX.Vector2">
- <summary>
- Performs an explicit conversion from <see cref = "T:SharpDX.Int4" /> to <see cref = "T:SharpDX.Vector2" />.
- </summary>
- <param name = "value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Explicit(SharpDX.Int4)~SharpDX.Vector3">
- <summary>
- Performs an explicit conversion from <see cref = "T:SharpDX.Int4" /> to <see cref = "T:SharpDX.Vector3" />.
- </summary>
- <param name = "value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Explicit(SharpDX.Int4)~SharpDX.Vector4">
- <summary>
- Performs an explicit conversion from <see cref = "T:SharpDX.Int4" /> to <see cref = "T:SharpDX.Vector4" />.
- </summary>
- <param name = "value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int4.ToString">
- <summary>
- Returns a <see cref = "T:System.String" /> that represents this instance.
- </summary>
- <returns>
- A <see cref = "T:System.String" /> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Int4.ToString(System.String)">
- <summary>
- Returns a <see cref = "T:System.String" /> that represents this instance.
- </summary>
- <param name = "format">The format.</param>
- <returns>
- A <see cref = "T:System.String" /> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Int4.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref = "T:System.String" /> that represents this instance.
- </summary>
- <param name = "formatProvider">The format provider.</param>
- <returns>
- A <see cref = "T:System.String" /> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Int4.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref = "T:System.String" /> that represents this instance.
- </summary>
- <param name = "format">The format.</param>
- <param name = "formatProvider">The format provider.</param>
- <returns>
- A <see cref = "T:System.String" /> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Int4.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Int4.Equals(SharpDX.Int4@)">
- <summary>
- Determines whether the specified <see cref = "T:SharpDX.Int4" /> is equal to this instance.
- </summary>
- <param name = "other">The <see cref = "T:SharpDX.Int4" /> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref = "T:SharpDX.Int4" /> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Int4.Equals(SharpDX.Int4)">
- <summary>
- Determines whether the specified <see cref = "T:SharpDX.Int4" /> is equal to this instance.
- </summary>
- <param name = "other">The <see cref = "T:SharpDX.Int4" /> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref = "T:SharpDX.Int4" /> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Int4.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref = "T:System.Object" /> is equal to this instance.
- </summary>
- <param name = "value">The <see cref = "T:System.Object" /> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref = "T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Int4.op_Implicit(System.Int32[])~SharpDX.Int4">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Int32"/> array to <see cref="T:SharpDX.Int4"/>.
- </summary>
- <param name="input">The input.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Implicit(SharpDX.Int4)~System.Int32[]">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Int4"/> to <see cref="T:System.Int32"/> array.
- </summary>
- <param name="input">The input.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Implicit(SharpDX.Int4)~SharpDX.Mathematics.Interop.RawInt4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Int4"/> to <see cref="T:SharpDX.Mathematics.Interop.RawInt4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Int4.op_Implicit(SharpDX.Mathematics.Interop.RawInt4)~SharpDX.Int4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawInt4"/> to <see cref="T:SharpDX.Int4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="F:SharpDX.MathUtil.ZeroTolerance">
- <summary>
- The value for which all absolute numbers smaller than are considered equal to zero.
- </summary>
- </member>
- <member name="F:SharpDX.MathUtil.Pi">
- <summary>
- A value specifying the approximation of π which is 180 degrees.
- </summary>
- </member>
- <member name="F:SharpDX.MathUtil.TwoPi">
- <summary>
- A value specifying the approximation of 2π which is 360 degrees.
- </summary>
- </member>
- <member name="F:SharpDX.MathUtil.PiOverTwo">
- <summary>
- A value specifying the approximation of π/2 which is 90 degrees.
- </summary>
- </member>
- <member name="F:SharpDX.MathUtil.PiOverFour">
- <summary>
- A value specifying the approximation of π/4 which is 45 degrees.
- </summary>
- </member>
- <member name="M:SharpDX.MathUtil.NearEqual(System.Single,System.Single)">
- <summary>
- Checks if a and b are almost equals, taking into account the magnitude of floating point numbers (unlike <see cref="M:SharpDX.MathUtil.WithinEpsilon(System.Single,System.Single,System.Single)"/> method). See Remarks.
- See remarks.
- </summary>
- <param name="a">The left value to compare.</param>
- <param name="b">The right value to compare.</param>
- <returns><c>true</c> if a almost equal to b, <c>false</c> otherwise</returns>
- <remarks>
- The code is using the technique described by Bruce Dawson in
- <a href="http://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/">Comparing Floating point numbers 2012 edition</a>.
- </remarks>
- </member>
- <member name="M:SharpDX.MathUtil.IsZero(System.Single)">
- <summary>
- Determines whether the specified value is close to zero (0.0f).
- </summary>
- <param name="a">The floating value.</param>
- <returns><c>true</c> if the specified value is close to zero (0.0f); otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.IsOne(System.Single)">
- <summary>
- Determines whether the specified value is close to one (1.0f).
- </summary>
- <param name="a">The floating value.</param>
- <returns><c>true</c> if the specified value is close to one (1.0f); otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.WithinEpsilon(System.Single,System.Single,System.Single)">
- <summary>
- Checks if a - b are almost equals within a float epsilon.
- </summary>
- <param name="a">The left value to compare.</param>
- <param name="b">The right value to compare.</param>
- <param name="epsilon">Epsilon value</param>
- <returns><c>true</c> if a almost equal to b within a float epsilon, <c>false</c> otherwise</returns>
- </member>
- <member name="M:SharpDX.MathUtil.RevolutionsToDegrees(System.Single)">
- <summary>
- Converts revolutions to degrees.
- </summary>
- <param name="revolution">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.RevolutionsToRadians(System.Single)">
- <summary>
- Converts revolutions to radians.
- </summary>
- <param name="revolution">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.RevolutionsToGradians(System.Single)">
- <summary>
- Converts revolutions to gradians.
- </summary>
- <param name="revolution">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.DegreesToRevolutions(System.Single)">
- <summary>
- Converts degrees to revolutions.
- </summary>
- <param name="degree">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.DegreesToRadians(System.Single)">
- <summary>
- Converts degrees to radians.
- </summary>
- <param name="degree">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.RadiansToRevolutions(System.Single)">
- <summary>
- Converts radians to revolutions.
- </summary>
- <param name="radian">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.RadiansToGradians(System.Single)">
- <summary>
- Converts radians to gradians.
- </summary>
- <param name="radian">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.GradiansToRevolutions(System.Single)">
- <summary>
- Converts gradians to revolutions.
- </summary>
- <param name="gradian">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.GradiansToDegrees(System.Single)">
- <summary>
- Converts gradians to degrees.
- </summary>
- <param name="gradian">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.GradiansToRadians(System.Single)">
- <summary>
- Converts gradians to radians.
- </summary>
- <param name="gradian">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.RadiansToDegrees(System.Single)">
- <summary>
- Converts radians to degrees.
- </summary>
- <param name="radian">The value to convert.</param>
- <returns>The converted value.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.Clamp(System.Single,System.Single,System.Single)">
- <summary>
- Clamps the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="min">The min.</param>
- <param name="max">The max.</param>
- <returns>The result of clamping a value between min and max</returns>
- </member>
- <member name="M:SharpDX.MathUtil.Clamp(System.Int32,System.Int32,System.Int32)">
- <summary>
- Clamps the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="min">The min.</param>
- <param name="max">The max.</param>
- <returns>The result of clamping a value between min and max</returns>
- </member>
- <member name="M:SharpDX.MathUtil.Lerp(System.Double,System.Double,System.Double)">
- <summary>
- Interpolates between two values using a linear function by a given amount.
- </summary>
- <remarks>
- See http://www.encyclopediaofmath.org/index.php/Linear_interpolation and
- http://fgiesen.wordpress.com/2012/08/15/linear-interpolation-past-present-and-future/
- </remarks>
- <param name="from">Value to interpolate from.</param>
- <param name="to">Value to interpolate to.</param>
- <param name="amount">Interpolation amount.</param>
- <returns>The result of linear interpolation of values based on the amount.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.Lerp(System.Single,System.Single,System.Single)">
- <summary>
- Interpolates between two values using a linear function by a given amount.
- </summary>
- <remarks>
- See http://www.encyclopediaofmath.org/index.php/Linear_interpolation and
- http://fgiesen.wordpress.com/2012/08/15/linear-interpolation-past-present-and-future/
- </remarks>
- <param name="from">Value to interpolate from.</param>
- <param name="to">Value to interpolate to.</param>
- <param name="amount">Interpolation amount.</param>
- <returns>The result of linear interpolation of values based on the amount.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.Lerp(System.Byte,System.Byte,System.Single)">
- <summary>
- Interpolates between two values using a linear function by a given amount.
- </summary>
- <remarks>
- See http://www.encyclopediaofmath.org/index.php/Linear_interpolation and
- http://fgiesen.wordpress.com/2012/08/15/linear-interpolation-past-present-and-future/
- </remarks>
- <param name="from">Value to interpolate from.</param>
- <param name="to">Value to interpolate to.</param>
- <param name="amount">Interpolation amount.</param>
- <returns>The result of linear interpolation of values based on the amount.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.SmoothStep(System.Single)">
- <summary>
- Performs smooth (cubic Hermite) interpolation between 0 and 1.
- </summary>
- <remarks>
- See https://en.wikipedia.org/wiki/Smoothstep
- </remarks>
- <param name="amount">Value between 0 and 1 indicating interpolation amount.</param>
- </member>
- <member name="M:SharpDX.MathUtil.SmootherStep(System.Single)">
- <summary>
- Performs a smooth(er) interpolation between 0 and 1 with 1st and 2nd order derivatives of zero at endpoints.
- </summary>
- <remarks>
- See https://en.wikipedia.org/wiki/Smoothstep
- </remarks>
- <param name="amount">Value between 0 and 1 indicating interpolation amount.</param>
- </member>
- <member name="M:SharpDX.MathUtil.Mod(System.Single,System.Single)">
- <summary>
- Calculates the modulo of the specified value.
- </summary>
- <param name="value">The value.</param>
- <param name="modulo">The modulo.</param>
- <returns>The result of the modulo applied to value</returns>
- </member>
- <member name="M:SharpDX.MathUtil.Mod2PI(System.Single)">
- <summary>
- Calculates the modulo 2*PI of the specified value.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the modulo applied to value</returns>
- </member>
- <member name="M:SharpDX.MathUtil.Wrap(System.Int32,System.Int32,System.Int32)">
- <summary>
- Wraps the specified value into a range [min, max]
- </summary>
- <param name="value">The value to wrap.</param>
- <param name="min">The min.</param>
- <param name="max">The max.</param>
- <returns>Result of the wrapping.</returns>
- <exception cref="T:System.ArgumentException">Is thrown when <paramref name="min"/> is greater than <paramref name="max"/>.</exception>
- </member>
- <member name="M:SharpDX.MathUtil.Wrap(System.Single,System.Single,System.Single)">
- <summary>
- Wraps the specified value into a range [min, max[
- </summary>
- <param name="value">The value.</param>
- <param name="min">The min.</param>
- <param name="max">The max.</param>
- <returns>Result of the wrapping.</returns>
- <exception cref="T:System.ArgumentException">Is thrown when <paramref name="min"/> is greater than <paramref name="max"/>.</exception>
- </member>
- <member name="M:SharpDX.MathUtil.Gauss(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Gauss function.
- http://en.wikipedia.org/wiki/Gaussian_function#Two-dimensional_Gaussian_function
- </summary>
- <param name="amplitude">Curve amplitude.</param>
- <param name="x">Position X.</param>
- <param name="y">Position Y</param>
- <param name="centerX">Center X.</param>
- <param name="centerY">Center Y.</param>
- <param name="sigmaX">Curve sigma X.</param>
- <param name="sigmaY">Curve sigma Y.</param>
- <returns>The result of Gaussian function.</returns>
- </member>
- <member name="M:SharpDX.MathUtil.Gauss(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Gauss function.
- http://en.wikipedia.org/wiki/Gaussian_function#Two-dimensional_Gaussian_function
- </summary>
- <param name="amplitude">Curve amplitude.</param>
- <param name="x">Position X.</param>
- <param name="y">Position Y</param>
- <param name="centerX">Center X.</param>
- <param name="centerY">Center Y.</param>
- <param name="sigmaX">Curve sigma X.</param>
- <param name="sigmaY">Curve sigma Y.</param>
- <returns>The result of Gaussian function.</returns>
- </member>
- <member name="T:SharpDX.Matrix">
- <summary>
- Represents a 4x4 mathematical matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.SizeInBytes">
- <summary>
- The size of the <see cref="T:SharpDX.Matrix"/> type, in bytes.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.Zero">
- <summary>
- A <see cref="T:SharpDX.Matrix"/> with all of its components set to zero.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.Identity">
- <summary>
- The identity <see cref="T:SharpDX.Matrix"/>.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M11">
- <summary>
- Value at row 1 column 1 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M12">
- <summary>
- Value at row 1 column 2 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M13">
- <summary>
- Value at row 1 column 3 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M14">
- <summary>
- Value at row 1 column 4 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M21">
- <summary>
- Value at row 2 column 1 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M22">
- <summary>
- Value at row 2 column 2 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M23">
- <summary>
- Value at row 2 column 3 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M24">
- <summary>
- Value at row 2 column 4 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M31">
- <summary>
- Value at row 3 column 1 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M32">
- <summary>
- Value at row 3 column 2 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M33">
- <summary>
- Value at row 3 column 3 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M34">
- <summary>
- Value at row 3 column 4 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M41">
- <summary>
- Value at row 4 column 1 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M42">
- <summary>
- Value at row 4 column 2 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M43">
- <summary>
- Value at row 4 column 3 of the matrix.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix.M44">
- <summary>
- Value at row 4 column 4 of the matrix.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Up">
- <summary>
- Gets or sets the up <see cref="T:SharpDX.Vector3"/> of the matrix; that is M21, M22, and M23.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Down">
- <summary>
- Gets or sets the down <see cref="T:SharpDX.Vector3"/> of the matrix; that is -M21, -M22, and -M23.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Right">
- <summary>
- Gets or sets the right <see cref="T:SharpDX.Vector3"/> of the matrix; that is M11, M12, and M13.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Left">
- <summary>
- Gets or sets the left <see cref="T:SharpDX.Vector3"/> of the matrix; that is -M11, -M12, and -M13.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Forward">
- <summary>
- Gets or sets the forward <see cref="T:SharpDX.Vector3"/> of the matrix; that is -M31, -M32, and -M33.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Backward">
- <summary>
- Gets or sets the backward <see cref="T:SharpDX.Vector3"/> of the matrix; that is M31, M32, and M33.
- </summary>
- </member>
- <member name="M:SharpDX.Matrix.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Matrix.#ctor(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix"/> struct.
- </summary>
- <param name="M11">The value to assign at row 1 column 1 of the matrix.</param>
- <param name="M12">The value to assign at row 1 column 2 of the matrix.</param>
- <param name="M13">The value to assign at row 1 column 3 of the matrix.</param>
- <param name="M14">The value to assign at row 1 column 4 of the matrix.</param>
- <param name="M21">The value to assign at row 2 column 1 of the matrix.</param>
- <param name="M22">The value to assign at row 2 column 2 of the matrix.</param>
- <param name="M23">The value to assign at row 2 column 3 of the matrix.</param>
- <param name="M24">The value to assign at row 2 column 4 of the matrix.</param>
- <param name="M31">The value to assign at row 3 column 1 of the matrix.</param>
- <param name="M32">The value to assign at row 3 column 2 of the matrix.</param>
- <param name="M33">The value to assign at row 3 column 3 of the matrix.</param>
- <param name="M34">The value to assign at row 3 column 4 of the matrix.</param>
- <param name="M41">The value to assign at row 4 column 1 of the matrix.</param>
- <param name="M42">The value to assign at row 4 column 2 of the matrix.</param>
- <param name="M43">The value to assign at row 4 column 3 of the matrix.</param>
- <param name="M44">The value to assign at row 4 column 4 of the matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix"/> struct.
- </summary>
- <param name="values">The values to assign to the components of the matrix. This must be an array with sixteen elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than sixteen elements.</exception>
- </member>
- <member name="P:SharpDX.Matrix.Row1">
- <summary>
- Gets or sets the first row in the matrix; that is M11, M12, M13, and M14.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Row2">
- <summary>
- Gets or sets the second row in the matrix; that is M21, M22, M23, and M24.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Row3">
- <summary>
- Gets or sets the third row in the matrix; that is M31, M32, M33, and M34.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Row4">
- <summary>
- Gets or sets the fourth row in the matrix; that is M41, M42, M43, and M44.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Column1">
- <summary>
- Gets or sets the first column in the matrix; that is M11, M21, M31, and M41.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Column2">
- <summary>
- Gets or sets the second column in the matrix; that is M12, M22, M32, and M42.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Column3">
- <summary>
- Gets or sets the third column in the matrix; that is M13, M23, M33, and M43.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.Column4">
- <summary>
- Gets or sets the fourth column in the matrix; that is M14, M24, M34, and M44.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.TranslationVector">
- <summary>
- Gets or sets the translation of the matrix; that is M41, M42, and M43.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.ScaleVector">
- <summary>
- Gets or sets the scale of the matrix; that is M11, M22, and M33.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix.IsIdentity">
- <summary>
- Gets a value indicating whether this instance is an identity matrix.
- </summary>
- <value>
- <c>true</c> if this instance is an identity matrix; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SharpDX.Matrix.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the matrix component, depending on the index.</value>
- <param name="index">The zero-based index of the component to access.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 15].</exception>
- </member>
- <member name="P:SharpDX.Matrix.Item(System.Int32,System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the matrix component, depending on the index.</value>
- <param name="row">The row of the matrix to access.</param>
- <param name="column">The column of the matrix to access.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="row"/> or <paramref name="column"/>is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Matrix.Determinant">
- <summary>
- Calculates the determinant of the matrix.
- </summary>
- <returns>The determinant of the matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Invert">
- <summary>
- Inverts the matrix.
- </summary>
- </member>
- <member name="M:SharpDX.Matrix.Transpose">
- <summary>
- Transposes the matrix.
- </summary>
- </member>
- <member name="M:SharpDX.Matrix.Orthogonalize">
- <summary>
- Orthogonalizes the specified matrix.
- </summary>
- <remarks>
- <para>Orthogonalization is the process of making all rows orthogonal to each other. This
- means that any given row in the matrix will be orthogonal to any other given row in the
- matrix.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting matrix
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the matrix rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.Orthonormalize">
- <summary>
- Orthonormalizes the specified matrix.
- </summary>
- <remarks>
- <para>Orthonormalization is the process of making all rows and columns orthogonal to each
- other and making all rows and columns of unit length. This means that any given row will
- be orthogonal to any other given row and any given column will be orthogonal to any other
- given column. Any given row will not be orthogonal to any given column. Every row and every
- column will be of unit length.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting matrix
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the matrix rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.DecomposeQR(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Decomposes a matrix into an orthonormalized matrix Q and a right triangular matrix R.
- </summary>
- <param name="Q">When the method completes, contains the orthonormalized matrix of the decomposition.</param>
- <param name="R">When the method completes, contains the right triangular matrix of the decomposition.</param>
- </member>
- <member name="M:SharpDX.Matrix.DecomposeLQ(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Decomposes a matrix into a lower triangular matrix L and an orthonormalized matrix Q.
- </summary>
- <param name="L">When the method completes, contains the lower triangular matrix of the decomposition.</param>
- <param name="Q">When the method completes, contains the orthonormalized matrix of the decomposition.</param>
- </member>
- <member name="M:SharpDX.Matrix.Decompose(SharpDX.Vector3@,SharpDX.Quaternion@,SharpDX.Vector3@)">
- <summary>
- Decomposes a matrix into a scale, rotation, and translation.
- </summary>
- <param name="scale">When the method completes, contains the scaling component of the decomposed matrix.</param>
- <param name="rotation">When the method completes, contains the rotation component of the decomposed matrix.</param>
- <param name="translation">When the method completes, contains the translation component of the decomposed matrix.</param>
- <remarks>
- This method is designed to decompose an SRT transformation matrix only.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.DecomposeUniformScale(System.Single@,SharpDX.Quaternion@,SharpDX.Vector3@)">
- <summary>
- Decomposes a uniform scale matrix into a scale, rotation, and translation.
- A uniform scale matrix has the same scale in every axis.
- </summary>
- <param name="scale">When the method completes, contains the scaling component of the decomposed matrix.</param>
- <param name="rotation">When the method completes, contains the rotation component of the decomposed matrix.</param>
- <param name="translation">When the method completes, contains the translation component of the decomposed matrix.</param>
- <remarks>
- This method is designed to decompose only an SRT transformation matrix that has the same scale in every axis.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.ExchangeRows(System.Int32,System.Int32)">
- <summary>
- Exchanges two rows in the matrix.
- </summary>
- <param name="firstRow">The first row to exchange. This is an index of the row starting at zero.</param>
- <param name="secondRow">The second row to exchange. This is an index of the row starting at zero.</param>
- </member>
- <member name="M:SharpDX.Matrix.ExchangeColumns(System.Int32,System.Int32)">
- <summary>
- Exchanges two columns in the matrix.
- </summary>
- <param name="firstColumn">The first column to exchange. This is an index of the column starting at zero.</param>
- <param name="secondColumn">The second column to exchange. This is an index of the column starting at zero.</param>
- </member>
- <member name="M:SharpDX.Matrix.ToArray">
- <summary>
- Creates an array containing the elements of the matrix.
- </summary>
- <returns>A sixteen-element array containing the components of the matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Add(SharpDX.Matrix@,SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Determines the sum of two matrices.
- </summary>
- <param name="left">The first matrix to add.</param>
- <param name="right">The second matrix to add.</param>
- <param name="result">When the method completes, contains the sum of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix.Add(SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Determines the sum of two matrices.
- </summary>
- <param name="left">The first matrix to add.</param>
- <param name="right">The second matrix to add.</param>
- <returns>The sum of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Subtract(SharpDX.Matrix@,SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Determines the difference between two matrices.
- </summary>
- <param name="left">The first matrix to subtract.</param>
- <param name="right">The second matrix to subtract.</param>
- <param name="result">When the method completes, contains the difference between the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix.Subtract(SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Determines the difference between two matrices.
- </summary>
- <param name="left">The first matrix to subtract.</param>
- <param name="right">The second matrix to subtract.</param>
- <returns>The difference between the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Multiply(SharpDX.Matrix@,System.Single,SharpDX.Matrix@)">
- <summary>
- Scales a matrix by the given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Multiply(SharpDX.Matrix,System.Single)">
- <summary>
- Scales a matrix by the given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Multiply(SharpDX.Matrix@,SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Determines the product of two matrices.
- </summary>
- <param name="left">The first matrix to multiply.</param>
- <param name="right">The second matrix to multiply.</param>
- <param name="result">The product of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix.Multiply(SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Determines the product of two matrices.
- </summary>
- <param name="left">The first matrix to multiply.</param>
- <param name="right">The second matrix to multiply.</param>
- <returns>The product of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Divide(SharpDX.Matrix@,System.Single,SharpDX.Matrix@)">
- <summary>
- Scales a matrix by the given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Divide(SharpDX.Matrix,System.Single)">
- <summary>
- Scales a matrix by the given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Divide(SharpDX.Matrix@,SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Determines the quotient of two matrices.
- </summary>
- <param name="left">The first matrix to divide.</param>
- <param name="right">The second matrix to divide.</param>
- <param name="result">When the method completes, contains the quotient of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix.Divide(SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Determines the quotient of two matrices.
- </summary>
- <param name="left">The first matrix to divide.</param>
- <param name="right">The second matrix to divide.</param>
- <returns>The quotient of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Exponent(SharpDX.Matrix@,System.Int32,SharpDX.Matrix@)">
- <summary>
- Performs the exponential operation on a matrix.
- </summary>
- <param name="value">The matrix to perform the operation on.</param>
- <param name="exponent">The exponent to raise the matrix to.</param>
- <param name="result">When the method completes, contains the exponential matrix.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="exponent"/> is negative.</exception>
- </member>
- <member name="M:SharpDX.Matrix.Exponent(SharpDX.Matrix,System.Int32)">
- <summary>
- Performs the exponential operation on a matrix.
- </summary>
- <param name="value">The matrix to perform the operation on.</param>
- <param name="exponent">The exponent to raise the matrix to.</param>
- <returns>The exponential matrix.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="exponent"/> is negative.</exception>
- </member>
- <member name="M:SharpDX.Matrix.Negate(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Negates a matrix.
- </summary>
- <param name="value">The matrix to be negated.</param>
- <param name="result">When the method completes, contains the negated matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Negate(SharpDX.Matrix)">
- <summary>
- Negates a matrix.
- </summary>
- <param name="value">The matrix to be negated.</param>
- <returns>The negated matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Lerp(SharpDX.Matrix@,SharpDX.Matrix@,System.Single,SharpDX.Matrix@)">
- <summary>
- Performs a linear interpolation between two matrices.
- </summary>
- <param name="start">Start matrix.</param>
- <param name="end">End matrix.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two matrices.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.Lerp(SharpDX.Matrix,SharpDX.Matrix,System.Single)">
- <summary>
- Performs a linear interpolation between two matrices.
- </summary>
- <param name="start">Start matrix.</param>
- <param name="end">End matrix.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two matrices.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.SmoothStep(SharpDX.Matrix@,SharpDX.Matrix@,System.Single,SharpDX.Matrix@)">
- <summary>
- Performs a cubic interpolation between two matrices.
- </summary>
- <param name="start">Start matrix.</param>
- <param name="end">End matrix.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix.SmoothStep(SharpDX.Matrix,SharpDX.Matrix,System.Single)">
- <summary>
- Performs a cubic interpolation between two matrices.
- </summary>
- <param name="start">Start matrix.</param>
- <param name="end">End matrix.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Transpose(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Calculates the transpose of the specified matrix.
- </summary>
- <param name="value">The matrix whose transpose is to be calculated.</param>
- <param name="result">When the method completes, contains the transpose of the specified matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.TransposeByRef(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Calculates the transpose of the specified matrix.
- </summary>
- <param name="value">The matrix whose transpose is to be calculated.</param>
- <param name="result">When the method completes, contains the transpose of the specified matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Transpose(SharpDX.Matrix)">
- <summary>
- Calculates the transpose of the specified matrix.
- </summary>
- <param name="value">The matrix whose transpose is to be calculated.</param>
- <returns>The transpose of the specified matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Invert(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Calculates the inverse of the specified matrix.
- </summary>
- <param name="value">The matrix whose inverse is to be calculated.</param>
- <param name="result">When the method completes, contains the inverse of the specified matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Invert(SharpDX.Matrix)">
- <summary>
- Calculates the inverse of the specified matrix.
- </summary>
- <param name="value">The matrix whose inverse is to be calculated.</param>
- <returns>The inverse of the specified matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Orthogonalize(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Orthogonalizes the specified matrix.
- </summary>
- <param name="value">The matrix to orthogonalize.</param>
- <param name="result">When the method completes, contains the orthogonalized matrix.</param>
- <remarks>
- <para>Orthogonalization is the process of making all rows orthogonal to each other. This
- means that any given row in the matrix will be orthogonal to any other given row in the
- matrix.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting matrix
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the matrix rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.Orthogonalize(SharpDX.Matrix)">
- <summary>
- Orthogonalizes the specified matrix.
- </summary>
- <param name="value">The matrix to orthogonalize.</param>
- <returns>The orthogonalized matrix.</returns>
- <remarks>
- <para>Orthogonalization is the process of making all rows orthogonal to each other. This
- means that any given row in the matrix will be orthogonal to any other given row in the
- matrix.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting matrix
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the matrix rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.Orthonormalize(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Orthonormalizes the specified matrix.
- </summary>
- <param name="value">The matrix to orthonormalize.</param>
- <param name="result">When the method completes, contains the orthonormalized matrix.</param>
- <remarks>
- <para>Orthonormalization is the process of making all rows and columns orthogonal to each
- other and making all rows and columns of unit length. This means that any given row will
- be orthogonal to any other given row and any given column will be orthogonal to any other
- given column. Any given row will not be orthogonal to any given column. Every row and every
- column will be of unit length.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting matrix
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the matrix rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.Orthonormalize(SharpDX.Matrix)">
- <summary>
- Orthonormalizes the specified matrix.
- </summary>
- <param name="value">The matrix to orthonormalize.</param>
- <returns>The orthonormalized matrix.</returns>
- <remarks>
- <para>Orthonormalization is the process of making all rows and columns orthogonal to each
- other and making all rows and columns of unit length. This means that any given row will
- be orthogonal to any other given row and any given column will be orthogonal to any other
- given column. Any given row will not be orthogonal to any given column. Every row and every
- column will be of unit length.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting matrix
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the matrix rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.UpperTriangularForm(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Brings the matrix into upper triangular form using elementary row operations.
- </summary>
- <param name="value">The matrix to put into upper triangular form.</param>
- <param name="result">When the method completes, contains the upper triangular matrix.</param>
- <remarks>
- If the matrix is not invertible (i.e. its determinant is zero) than the result of this
- method may produce Single.Nan and Single.Inf values. When the matrix represents a system
- of linear equations, than this often means that either no solution exists or an infinite
- number of solutions exist.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.UpperTriangularForm(SharpDX.Matrix)">
- <summary>
- Brings the matrix into upper triangular form using elementary row operations.
- </summary>
- <param name="value">The matrix to put into upper triangular form.</param>
- <returns>The upper triangular matrix.</returns>
- <remarks>
- If the matrix is not invertible (i.e. its determinant is zero) than the result of this
- method may produce Single.Nan and Single.Inf values. When the matrix represents a system
- of linear equations, than this often means that either no solution exists or an infinite
- number of solutions exist.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.LowerTriangularForm(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Brings the matrix into lower triangular form using elementary row operations.
- </summary>
- <param name="value">The matrix to put into lower triangular form.</param>
- <param name="result">When the method completes, contains the lower triangular matrix.</param>
- <remarks>
- If the matrix is not invertible (i.e. its determinant is zero) than the result of this
- method may produce Single.Nan and Single.Inf values. When the matrix represents a system
- of linear equations, than this often means that either no solution exists or an infinite
- number of solutions exist.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.LowerTriangularForm(SharpDX.Matrix)">
- <summary>
- Brings the matrix into lower triangular form using elementary row operations.
- </summary>
- <param name="value">The matrix to put into lower triangular form.</param>
- <returns>The lower triangular matrix.</returns>
- <remarks>
- If the matrix is not invertible (i.e. its determinant is zero) than the result of this
- method may produce Single.Nan and Single.Inf values. When the matrix represents a system
- of linear equations, than this often means that either no solution exists or an infinite
- number of solutions exist.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.RowEchelonForm(SharpDX.Matrix@,SharpDX.Matrix@)">
- <summary>
- Brings the matrix into row echelon form using elementary row operations;
- </summary>
- <param name="value">The matrix to put into row echelon form.</param>
- <param name="result">When the method completes, contains the row echelon form of the matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.RowEchelonForm(SharpDX.Matrix)">
- <summary>
- Brings the matrix into row echelon form using elementary row operations;
- </summary>
- <param name="value">The matrix to put into row echelon form.</param>
- <returns>When the method completes, contains the row echelon form of the matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.ReducedRowEchelonForm(SharpDX.Matrix@,SharpDX.Vector4@,SharpDX.Matrix@,SharpDX.Vector4@)">
- <summary>
- Brings the matrix into reduced row echelon form using elementary row operations.
- </summary>
- <param name="value">The matrix to put into reduced row echelon form.</param>
- <param name="augment">The fifth column of the matrix.</param>
- <param name="result">When the method completes, contains the resultant matrix after the operation.</param>
- <param name="augmentResult">When the method completes, contains the resultant fifth column of the matrix.</param>
- <remarks>
- <para>The fifth column is often called the augmented part of the matrix. This is because the fifth
- column is really just an extension of the matrix so that there is a place to put all of the
- non-zero components after the operation is complete.</para>
- <para>Often times the resultant matrix will the identity matrix or a matrix similar to the identity
- matrix. Sometimes, however, that is not possible and numbers other than zero and one may appear.</para>
- <para>This method can be used to solve systems of linear equations. Upon completion of this method,
- the <paramref name="augmentResult"/> will contain the solution for the system. It is up to the user
- to analyze both the input and the result to determine if a solution really exists.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix.BillboardLH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Matrix@)">
- <summary>
- Creates a left-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <param name="result">When the method completes, contains the created billboard matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.BillboardLH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a left-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <returns>The created billboard matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.BillboardRH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Matrix@)">
- <summary>
- Creates a right-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <param name="result">When the method completes, contains the created billboard matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.BillboardRH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a right-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <returns>The created billboard matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.LookAtLH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Matrix@)">
- <summary>
- Creates a left-handed, look-at matrix.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <param name="result">When the method completes, contains the created look-at matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.LookAtLH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a left-handed, look-at matrix.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <returns>The created look-at matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.LookAtRH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Matrix@)">
- <summary>
- Creates a right-handed, look-at matrix.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <param name="result">When the method completes, contains the created look-at matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.LookAtRH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a right-handed, look-at matrix.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <returns>The created look-at matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.OrthoLH(System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a left-handed, orthographic projection matrix.
- </summary>
- <param name="width">Width of the viewing volume.</param>
- <param name="height">Height of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <param name="result">When the method completes, contains the created projection matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.OrthoLH(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a left-handed, orthographic projection matrix.
- </summary>
- <param name="width">Width of the viewing volume.</param>
- <param name="height">Height of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <returns>The created projection matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.OrthoRH(System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a right-handed, orthographic projection matrix.
- </summary>
- <param name="width">Width of the viewing volume.</param>
- <param name="height">Height of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <param name="result">When the method completes, contains the created projection matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.OrthoRH(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a right-handed, orthographic projection matrix.
- </summary>
- <param name="width">Width of the viewing volume.</param>
- <param name="height">Height of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <returns>The created projection matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.OrthoOffCenterLH(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a left-handed, customized orthographic projection matrix.
- </summary>
- <param name="left">Minimum x-value of the viewing volume.</param>
- <param name="right">Maximum x-value of the viewing volume.</param>
- <param name="bottom">Minimum y-value of the viewing volume.</param>
- <param name="top">Maximum y-value of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <param name="result">When the method completes, contains the created projection matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.OrthoOffCenterLH(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a left-handed, customized orthographic projection matrix.
- </summary>
- <param name="left">Minimum x-value of the viewing volume.</param>
- <param name="right">Maximum x-value of the viewing volume.</param>
- <param name="bottom">Minimum y-value of the viewing volume.</param>
- <param name="top">Maximum y-value of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <returns>The created projection matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.OrthoOffCenterRH(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a right-handed, customized orthographic projection matrix.
- </summary>
- <param name="left">Minimum x-value of the viewing volume.</param>
- <param name="right">Maximum x-value of the viewing volume.</param>
- <param name="bottom">Minimum y-value of the viewing volume.</param>
- <param name="top">Maximum y-value of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <param name="result">When the method completes, contains the created projection matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.OrthoOffCenterRH(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a right-handed, customized orthographic projection matrix.
- </summary>
- <param name="left">Minimum x-value of the viewing volume.</param>
- <param name="right">Maximum x-value of the viewing volume.</param>
- <param name="bottom">Minimum y-value of the viewing volume.</param>
- <param name="top">Maximum y-value of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <returns>The created projection matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveLH(System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a left-handed, perspective projection matrix.
- </summary>
- <param name="width">Width of the viewing volume.</param>
- <param name="height">Height of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <param name="result">When the method completes, contains the created projection matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveLH(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a left-handed, perspective projection matrix.
- </summary>
- <param name="width">Width of the viewing volume.</param>
- <param name="height">Height of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <returns>The created projection matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveRH(System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a right-handed, perspective projection matrix.
- </summary>
- <param name="width">Width of the viewing volume.</param>
- <param name="height">Height of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <param name="result">When the method completes, contains the created projection matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveRH(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a right-handed, perspective projection matrix.
- </summary>
- <param name="width">Width of the viewing volume.</param>
- <param name="height">Height of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <returns>The created projection matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveFovLH(System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a left-handed, perspective projection matrix based on a field of view.
- </summary>
- <param name="fov">Field of view in the y direction, in radians.</param>
- <param name="aspect">Aspect ratio, defined as view space width divided by height.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <param name="result">When the method completes, contains the created projection matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveFovLH(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a left-handed, perspective projection matrix based on a field of view.
- </summary>
- <param name="fov">Field of view in the y direction, in radians.</param>
- <param name="aspect">Aspect ratio, defined as view space width divided by height.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <returns>The created projection matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveFovRH(System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a right-handed, perspective projection matrix based on a field of view.
- </summary>
- <param name="fov">Field of view in the y direction, in radians.</param>
- <param name="aspect">Aspect ratio, defined as view space width divided by height.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <param name="result">When the method completes, contains the created projection matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveFovRH(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a right-handed, perspective projection matrix based on a field of view.
- </summary>
- <param name="fov">Field of view in the y direction, in radians.</param>
- <param name="aspect">Aspect ratio, defined as view space width divided by height.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <returns>The created projection matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveOffCenterLH(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a left-handed, customized perspective projection matrix.
- </summary>
- <param name="left">Minimum x-value of the viewing volume.</param>
- <param name="right">Maximum x-value of the viewing volume.</param>
- <param name="bottom">Minimum y-value of the viewing volume.</param>
- <param name="top">Maximum y-value of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <param name="result">When the method completes, contains the created projection matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveOffCenterLH(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a left-handed, customized perspective projection matrix.
- </summary>
- <param name="left">Minimum x-value of the viewing volume.</param>
- <param name="right">Maximum x-value of the viewing volume.</param>
- <param name="bottom">Minimum y-value of the viewing volume.</param>
- <param name="top">Maximum y-value of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <returns>The created projection matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveOffCenterRH(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a right-handed, customized perspective projection matrix.
- </summary>
- <param name="left">Minimum x-value of the viewing volume.</param>
- <param name="right">Maximum x-value of the viewing volume.</param>
- <param name="bottom">Minimum y-value of the viewing volume.</param>
- <param name="top">Maximum y-value of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <param name="result">When the method completes, contains the created projection matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.PerspectiveOffCenterRH(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a right-handed, customized perspective projection matrix.
- </summary>
- <param name="left">Minimum x-value of the viewing volume.</param>
- <param name="right">Maximum x-value of the viewing volume.</param>
- <param name="bottom">Minimum y-value of the viewing volume.</param>
- <param name="top">Maximum y-value of the viewing volume.</param>
- <param name="znear">Minimum z-value of the viewing volume.</param>
- <param name="zfar">Maximum z-value of the viewing volume.</param>
- <returns>The created projection matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Scaling(SharpDX.Vector3@,SharpDX.Matrix@)">
- <summary>
- Creates a matrix that scales along the x-axis, y-axis, and y-axis.
- </summary>
- <param name="scale">Scaling factor for all three axes.</param>
- <param name="result">When the method completes, contains the created scaling matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Scaling(SharpDX.Vector3)">
- <summary>
- Creates a matrix that scales along the x-axis, y-axis, and y-axis.
- </summary>
- <param name="scale">Scaling factor for all three axes.</param>
- <returns>The created scaling matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Scaling(System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a matrix that scales along the x-axis, y-axis, and y-axis.
- </summary>
- <param name="x">Scaling factor that is applied along the x-axis.</param>
- <param name="y">Scaling factor that is applied along the y-axis.</param>
- <param name="z">Scaling factor that is applied along the z-axis.</param>
- <param name="result">When the method completes, contains the created scaling matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Scaling(System.Single,System.Single,System.Single)">
- <summary>
- Creates a matrix that scales along the x-axis, y-axis, and y-axis.
- </summary>
- <param name="x">Scaling factor that is applied along the x-axis.</param>
- <param name="y">Scaling factor that is applied along the y-axis.</param>
- <param name="z">Scaling factor that is applied along the z-axis.</param>
- <returns>The created scaling matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Scaling(System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a matrix that uniformly scales along all three axis.
- </summary>
- <param name="scale">The uniform scale that is applied along all axis.</param>
- <param name="result">When the method completes, contains the created scaling matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Scaling(System.Single)">
- <summary>
- Creates a matrix that uniformly scales along all three axis.
- </summary>
- <param name="scale">The uniform scale that is applied along all axis.</param>
- <returns>The created scaling matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.RotationX(System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a matrix that rotates around the x-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <param name="result">When the method completes, contains the created rotation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.RotationX(System.Single)">
- <summary>
- Creates a matrix that rotates around the x-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <returns>The created rotation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.RotationY(System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a matrix that rotates around the y-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <param name="result">When the method completes, contains the created rotation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.RotationY(System.Single)">
- <summary>
- Creates a matrix that rotates around the y-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <returns>The created rotation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.RotationZ(System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a matrix that rotates around the z-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <param name="result">When the method completes, contains the created rotation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.RotationZ(System.Single)">
- <summary>
- Creates a matrix that rotates around the z-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <returns>The created rotation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.RotationAxis(SharpDX.Vector3@,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a matrix that rotates around an arbitrary axis.
- </summary>
- <param name="axis">The axis around which to rotate. This parameter is assumed to be normalized.</param>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <param name="result">When the method completes, contains the created rotation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.RotationAxis(SharpDX.Vector3,System.Single)">
- <summary>
- Creates a matrix that rotates around an arbitrary axis.
- </summary>
- <param name="axis">The axis around which to rotate. This parameter is assumed to be normalized.</param>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <returns>The created rotation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.RotationQuaternion(SharpDX.Quaternion@,SharpDX.Matrix@)">
- <summary>
- Creates a rotation matrix from a quaternion.
- </summary>
- <param name="rotation">The quaternion to use to build the matrix.</param>
- <param name="result">The created rotation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.RotationQuaternion(SharpDX.Quaternion)">
- <summary>
- Creates a rotation matrix from a quaternion.
- </summary>
- <param name="rotation">The quaternion to use to build the matrix.</param>
- <returns>The created rotation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.RotationYawPitchRoll(System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a rotation matrix with a specified yaw, pitch, and roll.
- </summary>
- <param name="yaw">Yaw around the y-axis, in radians.</param>
- <param name="pitch">Pitch around the x-axis, in radians.</param>
- <param name="roll">Roll around the z-axis, in radians.</param>
- <param name="result">When the method completes, contains the created rotation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.RotationYawPitchRoll(System.Single,System.Single,System.Single)">
- <summary>
- Creates a rotation matrix with a specified yaw, pitch, and roll.
- </summary>
- <param name="yaw">Yaw around the y-axis, in radians.</param>
- <param name="pitch">Pitch around the x-axis, in radians.</param>
- <param name="roll">Roll around the z-axis, in radians.</param>
- <returns>The created rotation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Translation(SharpDX.Vector3@,SharpDX.Matrix@)">
- <summary>
- Creates a translation matrix using the specified offsets.
- </summary>
- <param name="value">The offset for all three coordinate planes.</param>
- <param name="result">When the method completes, contains the created translation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Translation(SharpDX.Vector3)">
- <summary>
- Creates a translation matrix using the specified offsets.
- </summary>
- <param name="value">The offset for all three coordinate planes.</param>
- <returns>The created translation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Translation(System.Single,System.Single,System.Single,SharpDX.Matrix@)">
- <summary>
- Creates a translation matrix using the specified offsets.
- </summary>
- <param name="x">X-coordinate offset.</param>
- <param name="y">Y-coordinate offset.</param>
- <param name="z">Z-coordinate offset.</param>
- <param name="result">When the method completes, contains the created translation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Translation(System.Single,System.Single,System.Single)">
- <summary>
- Creates a translation matrix using the specified offsets.
- </summary>
- <param name="x">X-coordinate offset.</param>
- <param name="y">Y-coordinate offset.</param>
- <param name="z">Z-coordinate offset.</param>
- <returns>The created translation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Skew(System.Single,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Matrix@)">
- <summary>
- Creates a skew/shear matrix by means of a translation vector, a rotation vector, and a rotation angle.
- shearing is performed in the direction of translation vector, where translation vector and rotation vector define the shearing plane.
- The effect is such that the skewed rotation vector has the specified angle with rotation itself.
- </summary>
- <param name="angle">The rotation angle.</param>
- <param name="rotationVec">The rotation vector</param>
- <param name="transVec">The translation vector</param>
- <param name="matrix">Contains the created skew/shear matrix. </param>
- </member>
- <member name="M:SharpDX.Matrix.AffineTransformation(System.Single,SharpDX.Quaternion@,SharpDX.Vector3@,SharpDX.Matrix@)">
- <summary>
- Creates a 3D affine transformation matrix.
- </summary>
- <param name="scaling">Scaling factor.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <param name="result">When the method completes, contains the created affine transformation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.AffineTransformation(System.Single,SharpDX.Quaternion,SharpDX.Vector3)">
- <summary>
- Creates a 3D affine transformation matrix.
- </summary>
- <param name="scaling">Scaling factor.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <returns>The created affine transformation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.AffineTransformation(System.Single,SharpDX.Vector3@,SharpDX.Quaternion@,SharpDX.Vector3@,SharpDX.Matrix@)">
- <summary>
- Creates a 3D affine transformation matrix.
- </summary>
- <param name="scaling">Scaling factor.</param>
- <param name="rotationCenter">The center of the rotation.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <param name="result">When the method completes, contains the created affine transformation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.AffineTransformation(System.Single,SharpDX.Vector3,SharpDX.Quaternion,SharpDX.Vector3)">
- <summary>
- Creates a 3D affine transformation matrix.
- </summary>
- <param name="scaling">Scaling factor.</param>
- <param name="rotationCenter">The center of the rotation.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <returns>The created affine transformation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.AffineTransformation2D(System.Single,System.Single,SharpDX.Vector2@,SharpDX.Matrix@)">
- <summary>
- Creates a 2D affine transformation matrix.
- </summary>
- <param name="scaling">Scaling factor.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <param name="result">When the method completes, contains the created affine transformation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.AffineTransformation2D(System.Single,System.Single,SharpDX.Vector2)">
- <summary>
- Creates a 2D affine transformation matrix.
- </summary>
- <param name="scaling">Scaling factor.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <returns>The created affine transformation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.AffineTransformation2D(System.Single,SharpDX.Vector2@,System.Single,SharpDX.Vector2@,SharpDX.Matrix@)">
- <summary>
- Creates a 2D affine transformation matrix.
- </summary>
- <param name="scaling">Scaling factor.</param>
- <param name="rotationCenter">The center of the rotation.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <param name="result">When the method completes, contains the created affine transformation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.AffineTransformation2D(System.Single,SharpDX.Vector2,System.Single,SharpDX.Vector2)">
- <summary>
- Creates a 2D affine transformation matrix.
- </summary>
- <param name="scaling">Scaling factor.</param>
- <param name="rotationCenter">The center of the rotation.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <returns>The created affine transformation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Transformation(SharpDX.Vector3@,SharpDX.Quaternion@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Quaternion@,SharpDX.Vector3@,SharpDX.Matrix@)">
- <summary>
- Creates a transformation matrix.
- </summary>
- <param name="scalingCenter">Center point of the scaling operation.</param>
- <param name="scalingRotation">Scaling rotation amount.</param>
- <param name="scaling">Scaling factor.</param>
- <param name="rotationCenter">The center of the rotation.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <param name="result">When the method completes, contains the created transformation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Transformation(SharpDX.Vector3,SharpDX.Quaternion,SharpDX.Vector3,SharpDX.Vector3,SharpDX.Quaternion,SharpDX.Vector3)">
- <summary>
- Creates a transformation matrix.
- </summary>
- <param name="scalingCenter">Center point of the scaling operation.</param>
- <param name="scalingRotation">Scaling rotation amount.</param>
- <param name="scaling">Scaling factor.</param>
- <param name="rotationCenter">The center of the rotation.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <returns>The created transformation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.Transformation2D(SharpDX.Vector2@,System.Single,SharpDX.Vector2@,SharpDX.Vector2@,System.Single,SharpDX.Vector2@,SharpDX.Matrix@)">
- <summary>
- Creates a 2D transformation matrix.
- </summary>
- <param name="scalingCenter">Center point of the scaling operation.</param>
- <param name="scalingRotation">Scaling rotation amount.</param>
- <param name="scaling">Scaling factor.</param>
- <param name="rotationCenter">The center of the rotation.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <param name="result">When the method completes, contains the created transformation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix.Transformation2D(SharpDX.Vector2,System.Single,SharpDX.Vector2,SharpDX.Vector2,System.Single,SharpDX.Vector2)">
- <summary>
- Creates a 2D transformation matrix.
- </summary>
- <param name="scalingCenter">Center point of the scaling operation.</param>
- <param name="scalingRotation">Scaling rotation amount.</param>
- <param name="scaling">Scaling factor.</param>
- <param name="rotationCenter">The center of the rotation.</param>
- <param name="rotation">The rotation of the transformation.</param>
- <param name="translation">The translation factor of the transformation.</param>
- <returns>The created transformation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Addition(SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Adds two matrices.
- </summary>
- <param name="left">The first matrix to add.</param>
- <param name="right">The second matrix to add.</param>
- <returns>The sum of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_UnaryPlus(SharpDX.Matrix)">
- <summary>
- Assert a matrix (return it unchanged).
- </summary>
- <param name="value">The matrix to assert (unchanged).</param>
- <returns>The asserted (unchanged) matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Subtraction(SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Subtracts two matrices.
- </summary>
- <param name="left">The first matrix to subtract.</param>
- <param name="right">The second matrix to subtract.</param>
- <returns>The difference between the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_UnaryNegation(SharpDX.Matrix)">
- <summary>
- Negates a matrix.
- </summary>
- <param name="value">The matrix to negate.</param>
- <returns>The negated matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Multiply(System.Single,SharpDX.Matrix)">
- <summary>
- Scales a matrix by a given value.
- </summary>
- <param name="right">The matrix to scale.</param>
- <param name="left">The amount by which to scale.</param>
- <returns>The scaled matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Multiply(SharpDX.Matrix,System.Single)">
- <summary>
- Scales a matrix by a given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Multiply(SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Multiplies two matrices.
- </summary>
- <param name="left">The first matrix to multiply.</param>
- <param name="right">The second matrix to multiply.</param>
- <returns>The product of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Division(SharpDX.Matrix,System.Single)">
- <summary>
- Scales a matrix by a given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Division(SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Divides two matrices.
- </summary>
- <param name="left">The first matrix to divide.</param>
- <param name="right">The second matrix to divide.</param>
- <returns>The quotient of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Equality(SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Inequality(SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Matrix.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix.Equals(SharpDX.Matrix@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Matrix"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Matrix"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Matrix"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix.Equals(SharpDX.Matrix)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Matrix"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Matrix"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Matrix"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Implicit(SharpDX.Matrix)~SharpDX.Mathematics.Interop.RawMatrix">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Matrix"/> to <see cref="T:SharpDX.Mathematics.Interop.RawMatrix"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Matrix.op_Implicit(SharpDX.Mathematics.Interop.RawMatrix)~SharpDX.Matrix">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawMatrix"/> to <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.Matrix3x2">
- <summary>
- Direct2D Matrix3x2. Supports implicit cast from <see cref="T:SharpDX.Matrix"/>.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x2.Identity">
- <summary>
- Gets the identity matrix.
- </summary>
- <value>The identity matrix.</value>
- </member>
- <member name="F:SharpDX.Matrix3x2.M11">
- <summary>
- Element (1,1)
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x2.M12">
- <summary>
- Element (1,2)
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x2.M21">
- <summary>
- Element (2,1)
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x2.M22">
- <summary>
- Element (2,2)
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x2.M31">
- <summary>
- Element (3,1)
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x2.M32">
- <summary>
- Element (3,2)
- </summary>
- </member>
- <member name="M:SharpDX.Matrix3x2.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix3x2"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.#ctor(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix3x2"/> struct.
- </summary>
- <param name="M11">The value to assign at row 1 column 1 of the matrix.</param>
- <param name="M12">The value to assign at row 1 column 2 of the matrix.</param>
- <param name="M21">The value to assign at row 2 column 1 of the matrix.</param>
- <param name="M22">The value to assign at row 2 column 2 of the matrix.</param>
- <param name="M31">The value to assign at row 3 column 1 of the matrix.</param>
- <param name="M32">The value to assign at row 3 column 2 of the matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix3x2"/> struct.
- </summary>
- <param name="values">The values to assign to the components of the matrix. This must be an array with six elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than six elements.</exception>
- </member>
- <member name="P:SharpDX.Matrix3x2.Row1">
- <summary>
- Gets or sets the first row in the matrix; that is M11 and M12.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x2.Row2">
- <summary>
- Gets or sets the second row in the matrix; that is M21 and M22.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x2.Row3">
- <summary>
- Gets or sets the third row in the matrix; that is M31 and M32.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x2.Column1">
- <summary>
- Gets or sets the first column in the matrix; that is M11, M21, and M31.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x2.Column2">
- <summary>
- Gets or sets the second column in the matrix; that is M12, M22, and M32.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x2.TranslationVector">
- <summary>
- Gets or sets the translation of the matrix; that is M31 and M32.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x2.ScaleVector">
- <summary>
- Gets or sets the scale of the matrix; that is M11 and M22.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x2.IsIdentity">
- <summary>
- Gets a value indicating whether this instance is an identity matrix.
- </summary>
- <value>
- <c>true</c> if this instance is an identity matrix; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SharpDX.Matrix3x2.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the matrix component, depending on the index.</value>
- <param name="index">The zero-based index of the component to access.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 5].</exception>
- </member>
- <member name="P:SharpDX.Matrix3x2.Item(System.Int32,System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the matrix component, depending on the index.</value>
- <param name="row">The row of the matrix to access.</param>
- <param name="column">The column of the matrix to access.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="row"/> or <paramref name="column"/>is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Matrix3x2.ToArray">
- <summary>
- Creates an array containing the elements of the matrix.
- </summary>
- <returns>A sixteen-element array containing the components of the matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Add(SharpDX.Matrix3x2@,SharpDX.Matrix3x2@,SharpDX.Matrix3x2@)">
- <summary>
- Determines the sum of two matrices.
- </summary>
- <param name="left">The first matrix to add.</param>
- <param name="right">The second matrix to add.</param>
- <param name="result">When the method completes, contains the sum of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Add(SharpDX.Matrix3x2,SharpDX.Matrix3x2)">
- <summary>
- Determines the sum of two matrices.
- </summary>
- <param name="left">The first matrix to add.</param>
- <param name="right">The second matrix to add.</param>
- <returns>The sum of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Subtract(SharpDX.Matrix3x2@,SharpDX.Matrix3x2@,SharpDX.Matrix3x2@)">
- <summary>
- Determines the difference between two matrices.
- </summary>
- <param name="left">The first matrix to subtract.</param>
- <param name="right">The second matrix to subtract.</param>
- <param name="result">When the method completes, contains the difference between the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Subtract(SharpDX.Matrix3x2,SharpDX.Matrix3x2)">
- <summary>
- Determines the difference between two matrices.
- </summary>
- <param name="left">The first matrix to subtract.</param>
- <param name="right">The second matrix to subtract.</param>
- <returns>The difference between the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Multiply(SharpDX.Matrix3x2@,System.Single,SharpDX.Matrix3x2@)">
- <summary>
- Scales a matrix by the given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Multiply(SharpDX.Matrix3x2,System.Single)">
- <summary>
- Scales a matrix by the given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Multiply(SharpDX.Matrix3x2@,SharpDX.Matrix3x2@,SharpDX.Matrix3x2@)">
- <summary>
- Determines the product of two matrices.
- </summary>
- <param name="left">The first matrix to multiply.</param>
- <param name="right">The second matrix to multiply.</param>
- <param name="result">The product of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Multiply(SharpDX.Matrix3x2,SharpDX.Matrix3x2)">
- <summary>
- Determines the product of two matrices.
- </summary>
- <param name="left">The first matrix to multiply.</param>
- <param name="right">The second matrix to multiply.</param>
- <returns>The product of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Divide(SharpDX.Matrix3x2@,System.Single,SharpDX.Matrix3x2@)">
- <summary>
- Scales a matrix by the given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Divide(SharpDX.Matrix3x2@,SharpDX.Matrix3x2@,SharpDX.Matrix3x2@)">
- <summary>
- Determines the quotient of two matrices.
- </summary>
- <param name="left">The first matrix to divide.</param>
- <param name="right">The second matrix to divide.</param>
- <param name="result">When the method completes, contains the quotient of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Negate(SharpDX.Matrix3x2@,SharpDX.Matrix3x2@)">
- <summary>
- Negates a matrix.
- </summary>
- <param name="value">The matrix to be negated.</param>
- <param name="result">When the method completes, contains the negated matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Negate(SharpDX.Matrix3x2)">
- <summary>
- Negates a matrix.
- </summary>
- <param name="value">The matrix to be negated.</param>
- <returns>The negated matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Lerp(SharpDX.Matrix3x2@,SharpDX.Matrix3x2@,System.Single,SharpDX.Matrix3x2@)">
- <summary>
- Performs a linear interpolation between two matrices.
- </summary>
- <param name="start">Start matrix.</param>
- <param name="end">End matrix.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two matrices.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x2.Lerp(SharpDX.Matrix3x2,SharpDX.Matrix3x2,System.Single)">
- <summary>
- Performs a linear interpolation between two matrices.
- </summary>
- <param name="start">Start matrix.</param>
- <param name="end">End matrix.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two matrices.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x2.SmoothStep(SharpDX.Matrix3x2@,SharpDX.Matrix3x2@,System.Single,SharpDX.Matrix3x2@)">
- <summary>
- Performs a cubic interpolation between two matrices.
- </summary>
- <param name="start">Start matrix.</param>
- <param name="end">End matrix.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.SmoothStep(SharpDX.Matrix3x2,SharpDX.Matrix3x2,System.Single)">
- <summary>
- Performs a cubic interpolation between two matrices.
- </summary>
- <param name="start">Start matrix.</param>
- <param name="end">End matrix.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Scaling(SharpDX.Vector2@,SharpDX.Matrix3x2@)">
- <summary>
- Creates a matrix that scales along the x-axis and y-axis.
- </summary>
- <param name="scale">Scaling factor for both axes.</param>
- <param name="result">When the method completes, contains the created scaling matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Scaling(SharpDX.Vector2)">
- <summary>
- Creates a matrix that scales along the x-axis and y-axis.
- </summary>
- <param name="scale">Scaling factor for both axes.</param>
- <returns>The created scaling matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Scaling(System.Single,System.Single,SharpDX.Matrix3x2@)">
- <summary>
- Creates a matrix that scales along the x-axis and y-axis.
- </summary>
- <param name="x">Scaling factor that is applied along the x-axis.</param>
- <param name="y">Scaling factor that is applied along the y-axis.</param>
- <param name="result">When the method completes, contains the created scaling matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Scaling(System.Single,System.Single)">
- <summary>
- Creates a matrix that scales along the x-axis and y-axis.
- </summary>
- <param name="x">Scaling factor that is applied along the x-axis.</param>
- <param name="y">Scaling factor that is applied along the y-axis.</param>
- <returns>The created scaling matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Scaling(System.Single,SharpDX.Matrix3x2@)">
- <summary>
- Creates a matrix that uniformly scales along both axes.
- </summary>
- <param name="scale">The uniform scale that is applied along both axes.</param>
- <param name="result">When the method completes, contains the created scaling matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Scaling(System.Single)">
- <summary>
- Creates a matrix that uniformly scales along both axes.
- </summary>
- <param name="scale">The uniform scale that is applied along both axes.</param>
- <returns>The created scaling matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Scaling(System.Single,System.Single,SharpDX.Vector2)">
- <summary>
- Creates a matrix that is scaling from a specified center.
- </summary>
- <param name="x">Scaling factor that is applied along the x-axis.</param>
- <param name="y">Scaling factor that is applied along the y-axis.</param>
- <param name="center">The center of the scaling.</param>
- <returns>The created scaling matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Scaling(System.Single,System.Single,SharpDX.Vector2@,SharpDX.Matrix3x2@)">
- <summary>
- Creates a matrix that is scaling from a specified center.
- </summary>
- <param name="x">Scaling factor that is applied along the x-axis.</param>
- <param name="y">Scaling factor that is applied along the y-axis.</param>
- <param name="center">The center of the scaling.</param>
- <param name="result">The created scaling matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Determinant">
- <summary>
- Calculates the determinant of this matrix.
- </summary>
- <returns>Result of the determinant.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Rotation(System.Single,SharpDX.Matrix3x2@)">
- <summary>
- Creates a matrix that rotates.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis.</param>
- <param name="result">When the method completes, contains the created rotation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Rotation(System.Single)">
- <summary>
- Creates a matrix that rotates.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis.</param>
- <returns>The created rotation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Rotation(System.Single,SharpDX.Vector2)">
- <summary>
- Creates a matrix that rotates about a specified center.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis.</param>
- <param name="center">The center of the rotation.</param>
- <returns>The created rotation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Rotation(System.Single,SharpDX.Vector2,SharpDX.Matrix3x2@)">
- <summary>
- Creates a matrix that rotates about a specified center.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis.</param>
- <param name="center">The center of the rotation.</param>
- <param name="result">When the method completes, contains the created rotation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Transformation(System.Single,System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix3x2@)">
- <summary>
- Creates a transformation matrix.
- </summary>
- <param name="xScale">Scaling factor that is applied along the x-axis.</param>
- <param name="yScale">Scaling factor that is applied along the y-axis.</param>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis.</param>
- <param name="xOffset">X-coordinate offset.</param>
- <param name="yOffset">Y-coordinate offset.</param>
- <param name="result">When the method completes, contains the created transformation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Transformation(System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a transformation matrix.
- </summary>
- <param name="xScale">Scaling factor that is applied along the x-axis.</param>
- <param name="yScale">Scaling factor that is applied along the y-axis.</param>
- <param name="angle">Angle of rotation in radians.</param>
- <param name="xOffset">X-coordinate offset.</param>
- <param name="yOffset">Y-coordinate offset.</param>
- <returns>The created transformation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Translation(SharpDX.Vector2@,SharpDX.Matrix3x2@)">
- <summary>
- Creates a translation matrix using the specified offsets.
- </summary>
- <param name="value">The offset for both coordinate planes.</param>
- <param name="result">When the method completes, contains the created translation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Translation(SharpDX.Vector2)">
- <summary>
- Creates a translation matrix using the specified offsets.
- </summary>
- <param name="value">The offset for both coordinate planes.</param>
- <returns>The created translation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Translation(System.Single,System.Single,SharpDX.Matrix3x2@)">
- <summary>
- Creates a translation matrix using the specified offsets.
- </summary>
- <param name="x">X-coordinate offset.</param>
- <param name="y">Y-coordinate offset.</param>
- <param name="result">When the method completes, contains the created translation matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Translation(System.Single,System.Single)">
- <summary>
- Creates a translation matrix using the specified offsets.
- </summary>
- <param name="x">X-coordinate offset.</param>
- <param name="y">Y-coordinate offset.</param>
- <returns>The created translation matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.TransformPoint(SharpDX.Matrix3x2,SharpDX.Vector2)">
- <summary>
- Transforms a vector by this matrix.
- </summary>
- <param name="matrix">The matrix to use as a transformation matrix.</param>
- <param name="point">The original vector to apply the transformation.</param>
- <returns>The result of the transformation for the input vector.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.TransformPoint(SharpDX.Matrix3x2@,SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Transforms a vector by this matrix.
- </summary>
- <param name="matrix">The matrix to use as a transformation matrix.</param>
- <param name="point">The original vector to apply the transformation.</param>
- <param name="result">The result of the transformation for the input vector.</param>
- <returns></returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Invert">
- <summary>
- Calculates the inverse of this matrix instance.
- </summary>
- </member>
- <member name="M:SharpDX.Matrix3x2.Invert(SharpDX.Matrix3x2)">
- <summary>
- Calculates the inverse of the specified matrix.
- </summary>
- <param name="value">The matrix whose inverse is to be calculated.</param>
- <returns>the inverse of the specified matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Skew(System.Single,System.Single)">
- <summary>
- Creates a skew matrix.
- </summary>
- <param name="angleX">Angle of skew along the X-axis in radians.</param>
- <param name="angleY">Angle of skew along the Y-axis in radians.</param>
- <returns>The created skew matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Skew(System.Single,System.Single,SharpDX.Matrix3x2@)">
- <summary>
- Creates a skew matrix.
- </summary>
- <param name="angleX">Angle of skew along the X-axis in radians.</param>
- <param name="angleY">Angle of skew along the Y-axis in radians.</param>
- <param name="result">When the method completes, contains the created skew matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.Invert(SharpDX.Matrix3x2@,SharpDX.Matrix3x2@)">
- <summary>
- Calculates the inverse of the specified matrix.
- </summary>
- <param name="value">The matrix whose inverse is to be calculated.</param>
- <param name="result">When the method completes, contains the inverse of the specified matrix.</param>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Addition(SharpDX.Matrix3x2,SharpDX.Matrix3x2)">
- <summary>
- Adds two matrices.
- </summary>
- <param name="left">The first matrix to add.</param>
- <param name="right">The second matrix to add.</param>
- <returns>The sum of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_UnaryPlus(SharpDX.Matrix3x2)">
- <summary>
- Assert a matrix (return it unchanged).
- </summary>
- <param name="value">The matrix to assert (unchanged).</param>
- <returns>The asserted (unchanged) matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Subtraction(SharpDX.Matrix3x2,SharpDX.Matrix3x2)">
- <summary>
- Subtracts two matrices.
- </summary>
- <param name="left">The first matrix to subtract.</param>
- <param name="right">The second matrix to subtract.</param>
- <returns>The difference between the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_UnaryNegation(SharpDX.Matrix3x2)">
- <summary>
- Negates a matrix.
- </summary>
- <param name="value">The matrix to negate.</param>
- <returns>The negated matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Multiply(System.Single,SharpDX.Matrix3x2)">
- <summary>
- Scales a matrix by a given value.
- </summary>
- <param name="right">The matrix to scale.</param>
- <param name="left">The amount by which to scale.</param>
- <returns>The scaled matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Multiply(SharpDX.Matrix3x2,System.Single)">
- <summary>
- Scales a matrix by a given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Multiply(SharpDX.Matrix3x2,SharpDX.Matrix3x2)">
- <summary>
- Multiplies two matrices.
- </summary>
- <param name="left">The first matrix to multiply.</param>
- <param name="right">The second matrix to multiply.</param>
- <returns>The product of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Division(SharpDX.Matrix3x2,System.Single)">
- <summary>
- Scales a matrix by a given value.
- </summary>
- <param name="left">The matrix to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled matrix.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Division(SharpDX.Matrix3x2,SharpDX.Matrix3x2)">
- <summary>
- Divides two matrices.
- </summary>
- <param name="left">The first matrix to divide.</param>
- <param name="right">The second matrix to divide.</param>
- <returns>The quotient of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Equality(SharpDX.Matrix3x2,SharpDX.Matrix3x2)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Inequality(SharpDX.Matrix3x2,SharpDX.Matrix3x2)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Equals(SharpDX.Matrix3x2@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Matrix3x2"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Matrix3x2"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Matrix3x2"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Equals(SharpDX.Matrix3x2)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Matrix3x2"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Matrix3x2"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Matrix3x2"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Implicit(SharpDX.Matrix)~SharpDX.Matrix3x2">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Matrix"/> to <see cref="T:SharpDX.Matrix3x2"/>.
- </summary>
- <param name="matrix">The matrix.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Implicit(SharpDX.Matrix3x2)~SharpDX.Mathematics.Interop.RawMatrix3x2">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Matrix3x2"/> to <see cref="T:SharpDX.Mathematics.Interop.RawMatrix3x2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x2.op_Implicit(SharpDX.Mathematics.Interop.RawMatrix3x2)~SharpDX.Matrix3x2">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawMatrix3x2"/> to <see cref="T:SharpDX.Matrix3x2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.Matrix3x3">
- <summary>
- Represents a 3x3 Matrix ( contains only Scale and Rotation ).
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.SizeInBytes">
- <summary>
- The size of the <see cref="T:SharpDX.Matrix3x3"/> type, in bytes.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.Zero">
- <summary>
- A <see cref="T:SharpDX.Matrix3x3"/> with all of its components set to zero.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.Identity">
- <summary>
- The identity <see cref="T:SharpDX.Matrix3x3"/>.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.M11">
- <summary>
- Value at row 1 column 1 of the Matrix3x3.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.M12">
- <summary>
- Value at row 1 column 2 of the Matrix3x3.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.M13">
- <summary>
- Value at row 1 column 3 of the Matrix3x3.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.M21">
- <summary>
- Value at row 2 column 1 of the Matrix3x3.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.M22">
- <summary>
- Value at row 2 column 2 of the Matrix3x3.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.M23">
- <summary>
- Value at row 2 column 3 of the Matrix3x3.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.M31">
- <summary>
- Value at row 3 column 1 of the Matrix3x3.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.M32">
- <summary>
- Value at row 3 column 2 of the Matrix3x3.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix3x3.M33">
- <summary>
- Value at row 3 column 3 of the Matrix3x3.
- </summary>
- </member>
- <member name="M:SharpDX.Matrix3x3.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix3x3"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.#ctor(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix3x3"/> struct.
- </summary>
- <param name="M11">The value to assign at row 1 column 1 of the Matrix3x3.</param>
- <param name="M12">The value to assign at row 1 column 2 of the Matrix3x3.</param>
- <param name="M13">The value to assign at row 1 column 3 of the Matrix3x3.</param>
- <param name="M21">The value to assign at row 2 column 1 of the Matrix3x3.</param>
- <param name="M22">The value to assign at row 2 column 2 of the Matrix3x3.</param>
- <param name="M23">The value to assign at row 2 column 3 of the Matrix3x3.</param>
- <param name="M31">The value to assign at row 3 column 1 of the Matrix3x3.</param>
- <param name="M32">The value to assign at row 3 column 2 of the Matrix3x3.</param>
- <param name="M33">The value to assign at row 3 column 3 of the Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix3x3"/> struct.
- </summary>
- <param name="values">The values to assign to the components of the Matrix3x3. This must be an array with sixteen elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than sixteen elements.</exception>
- </member>
- <member name="P:SharpDX.Matrix3x3.Row1">
- <summary>
- Gets or sets the first row in the Matrix3x3; that is M11, M12, M13
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x3.Row2">
- <summary>
- Gets or sets the second row in the Matrix3x3; that is M21, M22, M23
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x3.Row3">
- <summary>
- Gets or sets the third row in the Matrix3x3; that is M31, M32, M33
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x3.Column1">
- <summary>
- Gets or sets the first column in the Matrix3x3; that is M11, M21, M31
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x3.Column2">
- <summary>
- Gets or sets the second column in the Matrix3x3; that is M12, M22, M32
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x3.Column3">
- <summary>
- Gets or sets the third column in the Matrix3x3; that is M13, M23, M33
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x3.ScaleVector">
- <summary>
- Gets or sets the scale of the Matrix3x3; that is M11, M22, and M33.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix3x3.IsIdentity">
- <summary>
- Gets a value indicating whether this instance is an identity Matrix3x3.
- </summary>
- <value>
- <c>true</c> if this instance is an identity Matrix3x3; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SharpDX.Matrix3x3.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the Matrix3x3 component, depending on the index.</value>
- <param name="index">The zero-based index of the component to access.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 15].</exception>
- </member>
- <member name="P:SharpDX.Matrix3x3.Item(System.Int32,System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the Matrix3x3 component, depending on the index.</value>
- <param name="row">The row of the Matrix3x3 to access.</param>
- <param name="column">The column of the Matrix3x3 to access.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="row"/> or <paramref name="column"/>is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Matrix3x3.Determinant">
- <summary>
- Calculates the determinant of the Matrix3x3.
- </summary>
- <returns>The determinant of the Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Invert">
- <summary>
- Inverts the Matrix3x3.
- </summary>
- </member>
- <member name="M:SharpDX.Matrix3x3.Transpose">
- <summary>
- Transposes the Matrix3x3.
- </summary>
- </member>
- <member name="M:SharpDX.Matrix3x3.Orthogonalize">
- <summary>
- Orthogonalizes the specified Matrix3x3.
- </summary>
- <remarks>
- <para>Orthogonalization is the process of making all rows orthogonal to each other. This
- means that any given row in the Matrix3x3 will be orthogonal to any other given row in the
- Matrix3x3.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the Matrix3x3 rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.Orthonormalize">
- <summary>
- Orthonormalizes the specified Matrix3x3.
- </summary>
- <remarks>
- <para>Orthonormalization is the process of making all rows and columns orthogonal to each
- other and making all rows and columns of unit length. This means that any given row will
- be orthogonal to any other given row and any given column will be orthogonal to any other
- given column. Any given row will not be orthogonal to any given column. Every row and every
- column will be of unit length.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the Matrix3x3 rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.DecomposeQR(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Decomposes a Matrix3x3 into an orthonormalized Matrix3x3 Q and a right triangular Matrix3x3 R.
- </summary>
- <param name="Q">When the method completes, contains the orthonormalized Matrix3x3 of the decomposition.</param>
- <param name="R">When the method completes, contains the right triangular Matrix3x3 of the decomposition.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.DecomposeLQ(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Decomposes a Matrix3x3 into a lower triangular Matrix3x3 L and an orthonormalized Matrix3x3 Q.
- </summary>
- <param name="L">When the method completes, contains the lower triangular Matrix3x3 of the decomposition.</param>
- <param name="Q">When the method completes, contains the orthonormalized Matrix3x3 of the decomposition.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Decompose(SharpDX.Vector3@,SharpDX.Quaternion@)">
- <summary>
- Decomposes a Matrix3x3 into a scale, rotation, and translation.
- </summary>
- <param name="scale">When the method completes, contains the scaling component of the decomposed Matrix3x3.</param>
- <param name="rotation">When the method completes, contains the rotation component of the decomposed Matrix3x3.</param>
- <remarks>
- This method is designed to decompose an SRT transformation Matrix3x3 only.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.DecomposeUniformScale(System.Single@,SharpDX.Quaternion@)">
- <summary>
- Decomposes a uniform scale matrix into a scale, rotation, and translation.
- A uniform scale matrix has the same scale in every axis.
- </summary>
- <param name="scale">When the method completes, contains the scaling component of the decomposed matrix.</param>
- <param name="rotation">When the method completes, contains the rotation component of the decomposed matrix.</param>
- <remarks>
- This method is designed to decompose only an SRT transformation matrix that has the same scale in every axis.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.ExchangeRows(System.Int32,System.Int32)">
- <summary>
- Exchanges two rows in the Matrix3x3.
- </summary>
- <param name="firstRow">The first row to exchange. This is an index of the row starting at zero.</param>
- <param name="secondRow">The second row to exchange. This is an index of the row starting at zero.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.ExchangeColumns(System.Int32,System.Int32)">
- <summary>
- Exchanges two columns in the Matrix3x3.
- </summary>
- <param name="firstColumn">The first column to exchange. This is an index of the column starting at zero.</param>
- <param name="secondColumn">The second column to exchange. This is an index of the column starting at zero.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.ToArray">
- <summary>
- Creates an array containing the elements of the Matrix3x3.
- </summary>
- <returns>A 9-element array containing the components of the Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Add(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Determines the sum of two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to add.</param>
- <param name="right">The second Matrix3x3 to add.</param>
- <param name="result">When the method completes, contains the sum of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Add(SharpDX.Matrix3x3,SharpDX.Matrix3x3)">
- <summary>
- Determines the sum of two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to add.</param>
- <param name="right">The second Matrix3x3 to add.</param>
- <returns>The sum of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Subtract(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Determines the difference between two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to subtract.</param>
- <param name="right">The second Matrix3x3 to subtract.</param>
- <param name="result">When the method completes, contains the difference between the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Subtract(SharpDX.Matrix3x3,SharpDX.Matrix3x3)">
- <summary>
- Determines the difference between two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to subtract.</param>
- <param name="right">The second Matrix3x3 to subtract.</param>
- <returns>The difference between the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Multiply(SharpDX.Matrix3x3@,System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Scales a Matrix3x3 by the given value.
- </summary>
- <param name="left">The Matrix3x3 to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Multiply(SharpDX.Matrix3x3,System.Single)">
- <summary>
- Scales a Matrix3x3 by the given value.
- </summary>
- <param name="left">The Matrix3x3 to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Multiply(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Determines the product of two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to multiply.</param>
- <param name="right">The second Matrix3x3 to multiply.</param>
- <param name="result">The product of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Multiply(SharpDX.Matrix3x3,SharpDX.Matrix3x3)">
- <summary>
- Determines the product of two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to multiply.</param>
- <param name="right">The second Matrix3x3 to multiply.</param>
- <returns>The product of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Divide(SharpDX.Matrix3x3@,System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Scales a Matrix3x3 by the given value.
- </summary>
- <param name="left">The Matrix3x3 to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Divide(SharpDX.Matrix3x3,System.Single)">
- <summary>
- Scales a Matrix3x3 by the given value.
- </summary>
- <param name="left">The Matrix3x3 to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Divide(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Determines the quotient of two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to divide.</param>
- <param name="right">The second Matrix3x3 to divide.</param>
- <param name="result">When the method completes, contains the quotient of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Divide(SharpDX.Matrix3x3,SharpDX.Matrix3x3)">
- <summary>
- Determines the quotient of two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to divide.</param>
- <param name="right">The second Matrix3x3 to divide.</param>
- <returns>The quotient of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Exponent(SharpDX.Matrix3x3@,System.Int32,SharpDX.Matrix3x3@)">
- <summary>
- Performs the exponential operation on a Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 to perform the operation on.</param>
- <param name="exponent">The exponent to raise the Matrix3x3 to.</param>
- <param name="result">When the method completes, contains the exponential Matrix3x3.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="exponent"/> is negative.</exception>
- </member>
- <member name="M:SharpDX.Matrix3x3.Exponent(SharpDX.Matrix3x3,System.Int32)">
- <summary>
- Performs the exponential operation on a Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 to perform the operation on.</param>
- <param name="exponent">The exponent to raise the Matrix3x3 to.</param>
- <returns>The exponential Matrix3x3.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="exponent"/> is negative.</exception>
- </member>
- <member name="M:SharpDX.Matrix3x3.Negate(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Negates a Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 to be negated.</param>
- <param name="result">When the method completes, contains the negated Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Negate(SharpDX.Matrix3x3)">
- <summary>
- Negates a Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 to be negated.</param>
- <returns>The negated Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Lerp(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@,System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Performs a linear interpolation between two matrices.
- </summary>
- <param name="start">Start Matrix3x3.</param>
- <param name="end">End Matrix3x3.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two matrices.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.Lerp(SharpDX.Matrix3x3,SharpDX.Matrix3x3,System.Single)">
- <summary>
- Performs a linear interpolation between two matrices.
- </summary>
- <param name="start">Start Matrix3x3.</param>
- <param name="end">End Matrix3x3.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two matrices.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.SmoothStep(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@,System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Performs a cubic interpolation between two matrices.
- </summary>
- <param name="start">Start Matrix3x3.</param>
- <param name="end">End Matrix3x3.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.SmoothStep(SharpDX.Matrix3x3,SharpDX.Matrix3x3,System.Single)">
- <summary>
- Performs a cubic interpolation between two matrices.
- </summary>
- <param name="start">Start Matrix3x3.</param>
- <param name="end">End Matrix3x3.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Transpose(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Calculates the transpose of the specified Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 whose transpose is to be calculated.</param>
- <param name="result">When the method completes, contains the transpose of the specified Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.TransposeByRef(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Calculates the transpose of the specified Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 whose transpose is to be calculated.</param>
- <param name="result">When the method completes, contains the transpose of the specified Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Transpose(SharpDX.Matrix3x3)">
- <summary>
- Calculates the transpose of the specified Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 whose transpose is to be calculated.</param>
- <returns>The transpose of the specified Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Invert(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Calculates the inverse of the specified Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 whose inverse is to be calculated.</param>
- <param name="result">When the method completes, contains the inverse of the specified Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Invert(SharpDX.Matrix3x3)">
- <summary>
- Calculates the inverse of the specified Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 whose inverse is to be calculated.</param>
- <returns>The inverse of the specified Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Orthogonalize(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Orthogonalizes the specified Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 to orthogonalize.</param>
- <param name="result">When the method completes, contains the orthogonalized Matrix3x3.</param>
- <remarks>
- <para>Orthogonalization is the process of making all rows orthogonal to each other. This
- means that any given row in the Matrix3x3 will be orthogonal to any other given row in the
- Matrix3x3.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the Matrix3x3 rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.Orthogonalize(SharpDX.Matrix3x3)">
- <summary>
- Orthogonalizes the specified Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 to orthogonalize.</param>
- <returns>The orthogonalized Matrix3x3.</returns>
- <remarks>
- <para>Orthogonalization is the process of making all rows orthogonal to each other. This
- means that any given row in the Matrix3x3 will be orthogonal to any other given row in the
- Matrix3x3.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the Matrix3x3 rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.Orthonormalize(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Orthonormalizes the specified Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 to orthonormalize.</param>
- <param name="result">When the method completes, contains the orthonormalized Matrix3x3.</param>
- <remarks>
- <para>Orthonormalization is the process of making all rows and columns orthogonal to each
- other and making all rows and columns of unit length. This means that any given row will
- be orthogonal to any other given row and any given column will be orthogonal to any other
- given column. Any given row will not be orthogonal to any given column. Every row and every
- column will be of unit length.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the Matrix3x3 rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.Orthonormalize(SharpDX.Matrix3x3)">
- <summary>
- Orthonormalizes the specified Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 to orthonormalize.</param>
- <returns>The orthonormalized Matrix3x3.</returns>
- <remarks>
- <para>Orthonormalization is the process of making all rows and columns orthogonal to each
- other and making all rows and columns of unit length. This means that any given row will
- be orthogonal to any other given row and any given column will be orthogonal to any other
- given column. Any given row will not be orthogonal to any given column. Every row and every
- column will be of unit length.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting Matrix3x3
- tends to be numerically unstable. The numeric stability decreases according to the rows
- so that the first row is the most stable and the last row is the least stable.</para>
- <para>This operation is performed on the rows of the Matrix3x3 rather than the columns.
- If you wish for this operation to be performed on the columns, first transpose the
- input and than transpose the output.</para>
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.UpperTriangularForm(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Brings the Matrix3x3 into upper triangular form using elementary row operations.
- </summary>
- <param name="value">The Matrix3x3 to put into upper triangular form.</param>
- <param name="result">When the method completes, contains the upper triangular Matrix3x3.</param>
- <remarks>
- If the Matrix3x3 is not invertible (i.e. its determinant is zero) than the result of this
- method may produce Single.Nan and Single.Inf values. When the Matrix3x3 represents a system
- of linear equations, than this often means that either no solution exists or an infinite
- number of solutions exist.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.UpperTriangularForm(SharpDX.Matrix3x3)">
- <summary>
- Brings the Matrix3x3 into upper triangular form using elementary row operations.
- </summary>
- <param name="value">The Matrix3x3 to put into upper triangular form.</param>
- <returns>The upper triangular Matrix3x3.</returns>
- <remarks>
- If the Matrix3x3 is not invertible (i.e. its determinant is zero) than the result of this
- method may produce Single.Nan and Single.Inf values. When the Matrix3x3 represents a system
- of linear equations, than this often means that either no solution exists or an infinite
- number of solutions exist.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.LowerTriangularForm(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Brings the Matrix3x3 into lower triangular form using elementary row operations.
- </summary>
- <param name="value">The Matrix3x3 to put into lower triangular form.</param>
- <param name="result">When the method completes, contains the lower triangular Matrix3x3.</param>
- <remarks>
- If the Matrix3x3 is not invertible (i.e. its determinant is zero) than the result of this
- method may produce Single.Nan and Single.Inf values. When the Matrix3x3 represents a system
- of linear equations, than this often means that either no solution exists or an infinite
- number of solutions exist.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.LowerTriangularForm(SharpDX.Matrix3x3)">
- <summary>
- Brings the Matrix3x3 into lower triangular form using elementary row operations.
- </summary>
- <param name="value">The Matrix3x3 to put into lower triangular form.</param>
- <returns>The lower triangular Matrix3x3.</returns>
- <remarks>
- If the Matrix3x3 is not invertible (i.e. its determinant is zero) than the result of this
- method may produce Single.Nan and Single.Inf values. When the Matrix3x3 represents a system
- of linear equations, than this often means that either no solution exists or an infinite
- number of solutions exist.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix3x3.RowEchelonForm(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Brings the Matrix3x3 into row echelon form using elementary row operations;
- </summary>
- <param name="value">The Matrix3x3 to put into row echelon form.</param>
- <param name="result">When the method completes, contains the row echelon form of the Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.RowEchelonForm(SharpDX.Matrix3x3)">
- <summary>
- Brings the Matrix3x3 into row echelon form using elementary row operations;
- </summary>
- <param name="value">The Matrix3x3 to put into row echelon form.</param>
- <returns>When the method completes, contains the row echelon form of the Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.BillboardLH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Matrix3x3@)">
- <summary>
- Creates a left-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <param name="result">When the method completes, contains the created billboard Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.BillboardLH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a left-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <returns>The created billboard Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.BillboardRH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Matrix3x3@)">
- <summary>
- Creates a right-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <param name="result">When the method completes, contains the created billboard Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.BillboardRH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a right-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <returns>The created billboard Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.LookAtLH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Matrix3x3@)">
- <summary>
- Creates a left-handed, look-at Matrix3x3.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <param name="result">When the method completes, contains the created look-at Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.LookAtLH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a left-handed, look-at Matrix3x3.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <returns>The created look-at Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.LookAtRH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Matrix3x3@)">
- <summary>
- Creates a right-handed, look-at Matrix3x3.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <param name="result">When the method completes, contains the created look-at Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.LookAtRH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a right-handed, look-at Matrix3x3.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <returns>The created look-at Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Scaling(SharpDX.Vector3@,SharpDX.Matrix3x3@)">
- <summary>
- Creates a Matrix3x3 that scales along the x-axis, y-axis, and y-axis.
- </summary>
- <param name="scale">Scaling factor for all three axes.</param>
- <param name="result">When the method completes, contains the created scaling Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Scaling(SharpDX.Vector3)">
- <summary>
- Creates a Matrix3x3 that scales along the x-axis, y-axis, and y-axis.
- </summary>
- <param name="scale">Scaling factor for all three axes.</param>
- <returns>The created scaling Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Scaling(System.Single,System.Single,System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Creates a Matrix3x3 that scales along the x-axis, y-axis, and y-axis.
- </summary>
- <param name="x">Scaling factor that is applied along the x-axis.</param>
- <param name="y">Scaling factor that is applied along the y-axis.</param>
- <param name="z">Scaling factor that is applied along the z-axis.</param>
- <param name="result">When the method completes, contains the created scaling Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Scaling(System.Single,System.Single,System.Single)">
- <summary>
- Creates a Matrix3x3 that scales along the x-axis, y-axis, and y-axis.
- </summary>
- <param name="x">Scaling factor that is applied along the x-axis.</param>
- <param name="y">Scaling factor that is applied along the y-axis.</param>
- <param name="z">Scaling factor that is applied along the z-axis.</param>
- <returns>The created scaling Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Scaling(System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Creates a Matrix3x3 that uniformly scales along all three axis.
- </summary>
- <param name="scale">The uniform scale that is applied along all axis.</param>
- <param name="result">When the method completes, contains the created scaling Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.Scaling(System.Single)">
- <summary>
- Creates a Matrix3x3 that uniformly scales along all three axis.
- </summary>
- <param name="scale">The uniform scale that is applied along all axis.</param>
- <returns>The created scaling Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationX(System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Creates a Matrix3x3 that rotates around the x-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <param name="result">When the method completes, contains the created rotation Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationX(System.Single)">
- <summary>
- Creates a Matrix3x3 that rotates around the x-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <returns>The created rotation Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationY(System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Creates a Matrix3x3 that rotates around the y-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <param name="result">When the method completes, contains the created rotation Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationY(System.Single)">
- <summary>
- Creates a Matrix3x3 that rotates around the y-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <returns>The created rotation Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationZ(System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Creates a Matrix3x3 that rotates around the z-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <param name="result">When the method completes, contains the created rotation Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationZ(System.Single)">
- <summary>
- Creates a Matrix3x3 that rotates around the z-axis.
- </summary>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <returns>The created rotation Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationAxis(SharpDX.Vector3@,System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Creates a Matrix3x3 that rotates around an arbitrary axis.
- </summary>
- <param name="axis">The axis around which to rotate. This parameter is assumed to be normalized.</param>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <param name="result">When the method completes, contains the created rotation Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationAxis(SharpDX.Vector3,System.Single)">
- <summary>
- Creates a Matrix3x3 that rotates around an arbitrary axis.
- </summary>
- <param name="axis">The axis around which to rotate. This parameter is assumed to be normalized.</param>
- <param name="angle">Angle of rotation in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.</param>
- <returns>The created rotation Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationQuaternion(SharpDX.Quaternion@,SharpDX.Matrix3x3@)">
- <summary>
- Creates a rotation Matrix3x3 from a quaternion.
- </summary>
- <param name="rotation">The quaternion to use to build the Matrix3x3.</param>
- <param name="result">The created rotation Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationQuaternion(SharpDX.Quaternion)">
- <summary>
- Creates a rotation Matrix3x3 from a quaternion.
- </summary>
- <param name="rotation">The quaternion to use to build the Matrix3x3.</param>
- <returns>The created rotation Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationYawPitchRoll(System.Single,System.Single,System.Single,SharpDX.Matrix3x3@)">
- <summary>
- Creates a rotation Matrix3x3 with a specified yaw, pitch, and roll.
- </summary>
- <param name="yaw">Yaw around the y-axis, in radians.</param>
- <param name="pitch">Pitch around the x-axis, in radians.</param>
- <param name="roll">Roll around the z-axis, in radians.</param>
- <param name="result">When the method completes, contains the created rotation Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Matrix3x3.RotationYawPitchRoll(System.Single,System.Single,System.Single)">
- <summary>
- Creates a rotation Matrix3x3 with a specified yaw, pitch, and roll.
- </summary>
- <param name="yaw">Yaw around the y-axis, in radians.</param>
- <param name="pitch">Pitch around the x-axis, in radians.</param>
- <param name="roll">Roll around the z-axis, in radians.</param>
- <returns>The created rotation Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Addition(SharpDX.Matrix3x3,SharpDX.Matrix3x3)">
- <summary>
- Adds two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to add.</param>
- <param name="right">The second Matrix3x3 to add.</param>
- <returns>The sum of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_UnaryPlus(SharpDX.Matrix3x3)">
- <summary>
- Assert a Matrix3x3 (return it unchanged).
- </summary>
- <param name="value">The Matrix3x3 to assert (unchanged).</param>
- <returns>The asserted (unchanged) Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Subtraction(SharpDX.Matrix3x3,SharpDX.Matrix3x3)">
- <summary>
- Subtracts two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to subtract.</param>
- <param name="right">The second Matrix3x3 to subtract.</param>
- <returns>The difference between the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_UnaryNegation(SharpDX.Matrix3x3)">
- <summary>
- Negates a Matrix3x3.
- </summary>
- <param name="value">The Matrix3x3 to negate.</param>
- <returns>The negated Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Multiply(System.Single,SharpDX.Matrix3x3)">
- <summary>
- Scales a Matrix3x3 by a given value.
- </summary>
- <param name="right">The Matrix3x3 to scale.</param>
- <param name="left">The amount by which to scale.</param>
- <returns>The scaled Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Multiply(SharpDX.Matrix3x3,System.Single)">
- <summary>
- Scales a Matrix3x3 by a given value.
- </summary>
- <param name="left">The Matrix3x3 to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Multiply(SharpDX.Matrix3x3,SharpDX.Matrix3x3)">
- <summary>
- Multiplies two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to multiply.</param>
- <param name="right">The second Matrix3x3 to multiply.</param>
- <returns>The product of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Division(SharpDX.Matrix3x3,System.Single)">
- <summary>
- Scales a Matrix3x3 by a given value.
- </summary>
- <param name="left">The Matrix3x3 to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Division(SharpDX.Matrix3x3,SharpDX.Matrix3x3)">
- <summary>
- Divides two matrices.
- </summary>
- <param name="left">The first Matrix3x3 to divide.</param>
- <param name="right">The second Matrix3x3 to divide.</param>
- <returns>The quotient of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Equality(SharpDX.Matrix3x3,SharpDX.Matrix3x3)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Inequality(SharpDX.Matrix3x3,SharpDX.Matrix3x3)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Explicit(SharpDX.Matrix3x3)~SharpDX.Matrix">
- <summary>
- Convert the 3x3 Matrix to a 4x4 Matrix.
- </summary>
- <returns>A 4x4 Matrix with zero translation and M44=1</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.op_Explicit(SharpDX.Matrix)~SharpDX.Matrix3x3">
- <summary>
- Convert the 4x4 Matrix to a 3x3 Matrix.
- </summary>
- <returns>A 3x3 Matrix</returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Equals(SharpDX.Matrix3x3@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Matrix3x3"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Matrix3x3"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Matrix3x3"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Equals(SharpDX.Matrix3x3)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Matrix3x3"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Matrix3x3"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Matrix3x3"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix3x3.Equals(SharpDX.Matrix3x3@,SharpDX.Matrix3x3@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Matrix3x3"/> are equal.
- </summary>
- </member>
- <member name="M:SharpDX.Matrix3x3.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:SharpDX.Matrix5x4">
- <summary>
- Represents a 4x4 mathematical Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.SizeInBytes">
- <summary>
- The size of the <see cref="T:SharpDX.Matrix5x4"/> type, in bytes.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.Zero">
- <summary>
- A <see cref="T:SharpDX.Matrix5x4"/> with all of its components set to zero.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.Identity">
- <summary>
- The identity <see cref="T:SharpDX.Matrix5x4"/>.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M11">
- <summary>
- Value at row 1 column 1 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M12">
- <summary>
- Value at row 1 column 2 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M13">
- <summary>
- Value at row 1 column 3 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M14">
- <summary>
- Value at row 1 column 4 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M21">
- <summary>
- Value at row 2 column 1 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M22">
- <summary>
- Value at row 2 column 2 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M23">
- <summary>
- Value at row 2 column 3 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M24">
- <summary>
- Value at row 2 column 4 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M31">
- <summary>
- Value at row 3 column 1 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M32">
- <summary>
- Value at row 3 column 2 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M33">
- <summary>
- Value at row 3 column 3 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M34">
- <summary>
- Value at row 3 column 4 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M41">
- <summary>
- Value at row 4 column 1 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M42">
- <summary>
- Value at row 4 column 2 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M43">
- <summary>
- Value at row 4 column 3 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M44">
- <summary>
- Value at row 4 column 4 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M51">
- <summary>
- Value at row 5 column 1 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M52">
- <summary>
- Value at row 5 column 2 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M53">
- <summary>
- Value at row 5 column 3 of the Matrix5x4.
- </summary>
- </member>
- <member name="F:SharpDX.Matrix5x4.M54">
- <summary>
- Value at row 5 column 4 of the Matrix5x4.
- </summary>
- </member>
- <member name="M:SharpDX.Matrix5x4.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix5x4"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.#ctor(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix5x4"/> struct.
- </summary>
- <param name="M11">The value to assign at row 1 column 1 of the Matrix5x4.</param>
- <param name="M12">The value to assign at row 1 column 2 of the Matrix5x4.</param>
- <param name="M13">The value to assign at row 1 column 3 of the Matrix5x4.</param>
- <param name="M14">The value to assign at row 1 column 4 of the Matrix5x4.</param>
- <param name="M21">The value to assign at row 2 column 1 of the Matrix5x4.</param>
- <param name="M22">The value to assign at row 2 column 2 of the Matrix5x4.</param>
- <param name="M23">The value to assign at row 2 column 3 of the Matrix5x4.</param>
- <param name="M24">The value to assign at row 2 column 4 of the Matrix5x4.</param>
- <param name="M31">The value to assign at row 3 column 1 of the Matrix5x4.</param>
- <param name="M32">The value to assign at row 3 column 2 of the Matrix5x4.</param>
- <param name="M33">The value to assign at row 3 column 3 of the Matrix5x4.</param>
- <param name="M34">The value to assign at row 3 column 4 of the Matrix5x4.</param>
- <param name="M41">The value to assign at row 4 column 1 of the Matrix5x4.</param>
- <param name="M42">The value to assign at row 4 column 2 of the Matrix5x4.</param>
- <param name="M43">The value to assign at row 4 column 3 of the Matrix5x4.</param>
- <param name="M44">The value to assign at row 4 column 4 of the Matrix5x4.</param>
- <param name="M51">The value to assign at row 5 column 1 of the Matrix5x4.</param>
- <param name="M52">The value to assign at row 5 column 2 of the Matrix5x4.</param>
- <param name="M53">The value to assign at row 5 column 3 of the Matrix5x4.</param>
- <param name="M54">The value to assign at row 5 column 4 of the Matrix5x4.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Matrix5x4"/> struct.
- </summary>
- <param name="values">The values to assign to the components of the Matrix5x4. This must be an array with sixteen elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than sixteen elements.</exception>
- </member>
- <member name="P:SharpDX.Matrix5x4.Row1">
- <summary>
- Gets or sets the first row in the Matrix5x4; that is M11, M12, M13, and M14.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix5x4.Row2">
- <summary>
- Gets or sets the second row in the Matrix5x4; that is M21, M22, M23, and M24.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix5x4.Row3">
- <summary>
- Gets or sets the third row in the Matrix5x4; that is M31, M32, M33, and M34.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix5x4.Row4">
- <summary>
- Gets or sets the fourth row in the Matrix5x4; that is M41, M42, M43, and M44.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix5x4.Row5">
- <summary>
- Gets or sets the fifth row in the Matrix5x4; that is M51, M52, M53, and M54.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix5x4.TranslationVector">
- <summary>
- Gets or sets the translation of the Matrix5x4; that is M41, M42, and M43.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix5x4.ScaleVector">
- <summary>
- Gets or sets the scale of the Matrix5x4; that is M11, M22, and M33.
- </summary>
- </member>
- <member name="P:SharpDX.Matrix5x4.IsIdentity">
- <summary>
- Gets a value indicating whether this instance is an identity Matrix5x4.
- </summary>
- <value>
- <c>true</c> if this instance is an identity Matrix5x4; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SharpDX.Matrix5x4.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the Matrix5x4 component, depending on the index.</value>
- <param name="index">The zero-based index of the component to access.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 15].</exception>
- </member>
- <member name="P:SharpDX.Matrix5x4.Item(System.Int32,System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the Matrix5x4 component, depending on the index.</value>
- <param name="row">The row of the Matrix5x4 to access.</param>
- <param name="column">The column of the Matrix5x4 to access.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="row"/> or <paramref name="column"/>is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Matrix5x4.Add(SharpDX.Matrix5x4@,SharpDX.Matrix5x4@,SharpDX.Matrix5x4@)">
- <summary>
- Determines the sum of two matrices.
- </summary>
- <param name="left">The first Matrix5x4 to add.</param>
- <param name="right">The second Matrix5x4 to add.</param>
- <param name="result">When the method completes, contains the sum of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.Add(SharpDX.Matrix5x4,SharpDX.Matrix5x4)">
- <summary>
- Determines the sum of two matrices.
- </summary>
- <param name="left">The first Matrix5x4 to add.</param>
- <param name="right">The second Matrix5x4 to add.</param>
- <returns>The sum of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Subtract(SharpDX.Matrix5x4@,SharpDX.Matrix5x4@,SharpDX.Matrix5x4@)">
- <summary>
- Determines the difference between two matrices.
- </summary>
- <param name="left">The first Matrix5x4 to subtract.</param>
- <param name="right">The second Matrix5x4 to subtract.</param>
- <param name="result">When the method completes, contains the difference between the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.Subtract(SharpDX.Matrix5x4,SharpDX.Matrix5x4)">
- <summary>
- Determines the difference between two matrices.
- </summary>
- <param name="left">The first Matrix5x4 to subtract.</param>
- <param name="right">The second Matrix5x4 to subtract.</param>
- <returns>The difference between the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Multiply(SharpDX.Matrix5x4@,System.Single,SharpDX.Matrix5x4@)">
- <summary>
- Scales a Matrix5x4 by the given value.
- </summary>
- <param name="left">The Matrix5x4 to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled Matrix5x4.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.Divide(SharpDX.Matrix5x4@,System.Single,SharpDX.Matrix5x4@)">
- <summary>
- Scales a Matrix5x4 by the given value.
- </summary>
- <param name="left">The Matrix5x4 to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <param name="result">When the method completes, contains the scaled Matrix5x4.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.Negate(SharpDX.Matrix5x4@,SharpDX.Matrix5x4@)">
- <summary>
- Negates a Matrix5x4.
- </summary>
- <param name="value">The Matrix5x4 to be negated.</param>
- <param name="result">When the method completes, contains the negated Matrix5x4.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.Negate(SharpDX.Matrix5x4)">
- <summary>
- Negates a Matrix5x4.
- </summary>
- <param name="value">The Matrix5x4 to be negated.</param>
- <returns>The negated Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Lerp(SharpDX.Matrix5x4@,SharpDX.Matrix5x4@,System.Single,SharpDX.Matrix5x4@)">
- <summary>
- Performs a linear interpolation between two matrices.
- </summary>
- <param name="start">Start Matrix5x4.</param>
- <param name="end">End Matrix5x4.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two matrices.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix5x4.Lerp(SharpDX.Matrix5x4,SharpDX.Matrix5x4,System.Single)">
- <summary>
- Performs a linear interpolation between two matrices.
- </summary>
- <param name="start">Start Matrix5x4.</param>
- <param name="end">End Matrix5x4.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two matrices.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Matrix5x4.SmoothStep(SharpDX.Matrix5x4@,SharpDX.Matrix5x4@,System.Single,SharpDX.Matrix5x4@)">
- <summary>
- Performs a cubic interpolation between two matrices.
- </summary>
- <param name="start">Start Matrix5x4.</param>
- <param name="end">End Matrix5x4.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two matrices.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.SmoothStep(SharpDX.Matrix5x4,SharpDX.Matrix5x4,System.Single)">
- <summary>
- Performs a cubic interpolation between two matrices.
- </summary>
- <param name="start">Start Matrix5x4.</param>
- <param name="end">End Matrix5x4.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Scaling(SharpDX.Vector4@,SharpDX.Matrix5x4@)">
- <summary>
- Creates a Matrix5x4 that scales along the x-axis, y-axis, y-axis and w-axis
- </summary>
- <param name="scale">Scaling factor for all three axes.</param>
- <param name="result">When the method completes, contains the created scaling Matrix5x4.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.Scaling(SharpDX.Vector4)">
- <summary>
- Creates a Matrix5x4 that scales along the x-axis, y-axis, and y-axis.
- </summary>
- <param name="scale">Scaling factor for all three axes.</param>
- <returns>The created scaling Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Scaling(System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix5x4@)">
- <summary>
- Creates a Matrix5x4 that scales along the x-axis, y-axis, z-axis and w-axis.
- </summary>
- <param name="x">Scaling factor that is applied along the x-axis.</param>
- <param name="y">Scaling factor that is applied along the y-axis.</param>
- <param name="z">Scaling factor that is applied along the z-axis.</param>
- <param name="w">Scaling factor that is applied along the w-axis.</param>
- <param name="result">When the method completes, contains the created scaling Matrix5x4.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.Scaling(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a Matrix5x4 that scales along the x-axis, y-axis, z-axis and w-axis.
- </summary>
- <param name="x">Scaling factor that is applied along the x-axis.</param>
- <param name="y">Scaling factor that is applied along the y-axis.</param>
- <param name="z">Scaling factor that is applied along the z-axis.</param>
- <param name="w">Scaling factor that is applied along the w-axis.</param>
- <returns>The created scaling Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Scaling(System.Single,SharpDX.Matrix5x4@)">
- <summary>
- Creates a Matrix5x4 that uniformly scales along all three axis.
- </summary>
- <param name="scale">The uniform scale that is applied along all axis.</param>
- <param name="result">When the method completes, contains the created scaling Matrix5x4.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.Scaling(System.Single)">
- <summary>
- Creates a Matrix5x4 that uniformly scales along all three axis.
- </summary>
- <param name="scale">The uniform scale that is applied along all axis.</param>
- <returns>The created scaling Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Translation(SharpDX.Vector4@,SharpDX.Matrix5x4@)">
- <summary>
- Creates a translation Matrix5x4 using the specified offsets.
- </summary>
- <param name="value">The offset for all three coordinate planes.</param>
- <param name="result">When the method completes, contains the created translation Matrix5x4.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.Translation(SharpDX.Vector4)">
- <summary>
- Creates a translation Matrix5x4 using the specified offsets.
- </summary>
- <param name="value">The offset for all three coordinate planes.</param>
- <returns>The created translation Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Translation(System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix5x4@)">
- <summary>
- Creates a translation Matrix5x4 using the specified offsets.
- </summary>
- <param name="x">X-coordinate offset.</param>
- <param name="y">Y-coordinate offset.</param>
- <param name="z">Z-coordinate offset.</param>
- <param name="w">W-coordinate offset.</param>
- <param name="result">When the method completes, contains the created translation Matrix5x4.</param>
- </member>
- <member name="M:SharpDX.Matrix5x4.Translation(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Creates a translation Matrix5x4 using the specified offsets.
- </summary>
- <param name="x">X-coordinate offset.</param>
- <param name="y">Y-coordinate offset.</param>
- <param name="z">Z-coordinate offset.</param>
- <param name="w">W-coordinate offset.</param>
- <returns>The created translation Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.op_Addition(SharpDX.Matrix5x4,SharpDX.Matrix5x4)">
- <summary>
- Adds two matrices.
- </summary>
- <param name="left">The first Matrix5x4 to add.</param>
- <param name="right">The second Matrix5x4 to add.</param>
- <returns>The sum of the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.op_UnaryPlus(SharpDX.Matrix5x4)">
- <summary>
- Assert a Matrix5x4 (return it unchanged).
- </summary>
- <param name="value">The Matrix5x4 to assert (unchanged).</param>
- <returns>The asserted (unchanged) Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.op_Subtraction(SharpDX.Matrix5x4,SharpDX.Matrix5x4)">
- <summary>
- Subtracts two matrices.
- </summary>
- <param name="left">The first Matrix5x4 to subtract.</param>
- <param name="right">The second Matrix5x4 to subtract.</param>
- <returns>The difference between the two matrices.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.op_UnaryNegation(SharpDX.Matrix5x4)">
- <summary>
- Negates a Matrix5x4.
- </summary>
- <param name="value">The Matrix5x4 to negate.</param>
- <returns>The negated Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.op_Multiply(System.Single,SharpDX.Matrix5x4)">
- <summary>
- Scales a Matrix5x4 by a given value.
- </summary>
- <param name="right">The Matrix5x4 to scale.</param>
- <param name="left">The amount by which to scale.</param>
- <returns>The scaled Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.op_Multiply(SharpDX.Matrix5x4,System.Single)">
- <summary>
- Scales a Matrix5x4 by a given value.
- </summary>
- <param name="left">The Matrix5x4 to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.op_Division(SharpDX.Matrix5x4,System.Single)">
- <summary>
- Scales a Matrix5x4 by a given value.
- </summary>
- <param name="left">The Matrix5x4 to scale.</param>
- <param name="right">The amount by which to scale.</param>
- <returns>The scaled Matrix5x4.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.op_Equality(SharpDX.Matrix5x4,SharpDX.Matrix5x4)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.op_Inequality(SharpDX.Matrix5x4,SharpDX.Matrix5x4)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Equals(SharpDX.Matrix5x4@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Matrix5x4"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Matrix5x4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Matrix5x4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Equals(SharpDX.Matrix5x4)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Matrix5x4"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Matrix5x4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Matrix5x4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Matrix5x4.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:SharpDX.OrientedBoundingBox">
- <summary>
- OrientedBoundingBox (OBB) is a rectangular block, much like an AABB (BoundingBox) but with an arbitrary orientation.
- </summary>
- </member>
- <member name="F:SharpDX.OrientedBoundingBox.Extents">
- <summary>
- Half lengths of the box along each axis.
- </summary>
- </member>
- <member name="F:SharpDX.OrientedBoundingBox.Transformation">
- <summary>
- The matrix which aligns and scales the box, and its translation vector represents the center of the box.
- </summary>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.#ctor(SharpDX.BoundingBox)">
- <summary>
- Creates an <see cref="T:SharpDX.OrientedBoundingBox"/> from a BoundingBox.
- </summary>
- <param name="bb">The BoundingBox to create from.</param>
- <remarks>
- Initially, the OBB is axis-aligned box, but it can be rotated and transformed later.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.#ctor(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates an <see cref="T:SharpDX.OrientedBoundingBox"/> which contained between two minimum and maximum points.
- </summary>
- <param name="minimum">The minimum vertex of the bounding box.</param>
- <param name="maximum">The maximum vertex of the bounding box.</param>
- <remarks>
- Initially, the OrientedBoundingBox is axis-aligned box, but it can be rotated and transformed later.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.#ctor(SharpDX.Vector3[])">
- <summary>
- Creates an <see cref="T:SharpDX.OrientedBoundingBox"/> that fully contains the given points.
- </summary>
- <param name="points">The points that will be contained by the box.</param>
- <remarks>
- This method is not for computing the best tight-fitting OrientedBoundingBox.
- And initially, the OrientedBoundingBox is axis-aligned box, but it can be rotated and transformed later.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.GetCorners">
- <summary>
- Retrieves the eight corners of the bounding box.
- </summary>
- <returns>An array of points representing the eight corners of the bounding box.</returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Transform(SharpDX.Matrix@)">
- <summary>
- Transforms this box using a transformation matrix.
- </summary>
- <param name="mat">The transformation matrix.</param>
- <remarks>
- While any kind of transformation can be applied, it is recommended to apply scaling using scale method instead, which
- scales the Extents and keeps the Transformation matrix for rotation only, and that preserves collision detection accuracy.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Transform(SharpDX.Matrix)">
- <summary>
- Transforms this box using a transformation matrix.
- </summary>
- <param name="mat">The transformation matrix.</param>
- <remarks>
- While any kind of transformation can be applied, it is recommended to apply scaling using scale method instead, which
- scales the Extents and keeps the Transformation matrix for rotation only, and that preserves collision detection accuracy.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Scale(SharpDX.Vector3@)">
- <summary>
- Scales the <see cref="T:SharpDX.OrientedBoundingBox"/> by scaling its Extents without affecting the Transformation matrix,
- By keeping Transformation matrix scaling-free, the collision detection methods will be more accurate.
- </summary>
- <param name="scaling"></param>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Scale(SharpDX.Vector3)">
- <summary>
- Scales the <see cref="T:SharpDX.OrientedBoundingBox"/> by scaling its Extents without affecting the Transformation matrix,
- By keeping Transformation matrix scaling-free, the collision detection methods will be more accurate.
- </summary>
- <param name="scaling"></param>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Scale(System.Single)">
- <summary>
- Scales the <see cref="T:SharpDX.OrientedBoundingBox"/> by scaling its Extents without affecting the Transformation matrix,
- By keeping Transformation matrix scaling-free, the collision detection methods will be more accurate.
- </summary>
- <param name="scaling"></param>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Translate(SharpDX.Vector3@)">
- <summary>
- Translates the <see cref="T:SharpDX.OrientedBoundingBox"/> to a new position using a translation vector;
- </summary>
- <param name="translation">the translation vector.</param>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Translate(SharpDX.Vector3)">
- <summary>
- Translates the <see cref="T:SharpDX.OrientedBoundingBox"/> to a new position using a translation vector;
- </summary>
- <param name="translation">the translation vector.</param>
- </member>
- <member name="P:SharpDX.OrientedBoundingBox.Size">
- <summary>
- The size of the <see cref="T:SharpDX.OrientedBoundingBox"/> if no scaling is applied to the transformation matrix.
- </summary>
- <remarks>
- The property will return the actual size even if the scaling is applied using Scale method,
- but if the scaling is applied to transformation matrix, use GetSize Function instead.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.GetSize">
- <summary>
- Returns the size of the <see cref="T:SharpDX.OrientedBoundingBox"/> taking into consideration the scaling applied to the transformation matrix.
- </summary>
- <returns>The size of the consideration</returns>
- <remarks>
- This method is computationally expensive, so if no scale is applied to the transformation matrix
- use <see cref="P:SharpDX.OrientedBoundingBox.Size"/> property instead.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.GetSizeSquared">
- <summary>
- Returns the square size of the <see cref="T:SharpDX.OrientedBoundingBox"/> taking into consideration the scaling applied to the transformation matrix.
- </summary>
- <returns>The size of the consideration</returns>
- </member>
- <member name="P:SharpDX.OrientedBoundingBox.Center">
- <summary>
- Returns the center of the <see cref="T:SharpDX.OrientedBoundingBox"/>.
- </summary>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Contains(SharpDX.Vector3@)">
- <summary>
- Determines whether a <see cref="T:SharpDX.OrientedBoundingBox"/> contains a point.
- </summary>
- <param name="point">The point to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Contains(SharpDX.Vector3)">
- <summary>
- Determines whether a <see cref="T:SharpDX.OrientedBoundingBox"/> contains a point.
- </summary>
- <param name="point">The point to test.</param>
- <returns>The type of containment the two objects have.</returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Contains(SharpDX.Vector3[])">
- <summary>
- Determines whether a <see cref="T:SharpDX.OrientedBoundingBox"/> contains an array of points>.
- </summary>
- <param name="points">The points array to test.</param>
- <returns>The type of containment.</returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Contains(SharpDX.BoundingSphere,System.Boolean)">
- <summary>
- Determines whether a <see cref="T:SharpDX.OrientedBoundingBox"/> contains a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <param name="IgnoreScale">Optimize the check operation by assuming that <see cref="T:SharpDX.OrientedBoundingBox"/> has no scaling applied</param>
- <returns>The type of containment the two objects have.</returns>
- <remarks>
- This method is not designed for <see cref="T:SharpDX.OrientedBoundingBox"/> which has a non-uniform scaling applied to its transformation matrix.
- But any type of scaling applied using Scale method will keep this method accurate.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Contains(SharpDX.OrientedBoundingBox@)">
- <summary>
- Check the intersection between two <see cref="T:SharpDX.OrientedBoundingBox"/>
- </summary>
- <param name="obb">The OrientedBoundingBoxs to test.</param>
- <returns>The type of containment the two objects have.</returns>
- <remarks>
- For accuracy, The transformation matrix for both <see cref="T:SharpDX.OrientedBoundingBox"/> must not have any scaling applied to it.
- Anyway, scaling using Scale method will keep this method accurate.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.ContainsLine(SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Check the intersection between an <see cref="T:SharpDX.OrientedBoundingBox"/> and a line defined by two points
- </summary>
- <param name="L1">The first point in the line.</param>
- <param name="L2">The second point in the line.</param>
- <returns>The type of containment the two objects have.</returns>
- <remarks>
- For accuracy, The transformation matrix for the <see cref="T:SharpDX.OrientedBoundingBox"/> must not have any scaling applied to it.
- Anyway, scaling using Scale method will keep this method accurate.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Contains(SharpDX.BoundingBox@)">
- <summary>
- Check the intersection between an <see cref="T:SharpDX.OrientedBoundingBox"/> and <see cref="T:SharpDX.BoundingBox"/>
- </summary>
- <param name="box">The BoundingBox to test.</param>
- <returns>The type of containment the two objects have.</returns>
- <remarks>
- For accuracy, The transformation matrix for the <see cref="T:SharpDX.OrientedBoundingBox"/> must not have any scaling applied to it.
- Anyway, scaling using Scale method will keep this method accurate.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Intersects(SharpDX.Ray@,SharpDX.Vector3@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a <see cref="T:SharpDX.OrientedBoundingBox"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Intersects(SharpDX.Ray@)">
- <summary>
- Determines whether there is an intersection between a <see cref="T:SharpDX.Ray"/> and a <see cref="T:SharpDX.OrientedBoundingBox"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.GetBoundingBox">
- <summary>
- Get the axis-aligned <see cref="T:SharpDX.BoundingBox"/> which contains all <see cref="T:SharpDX.OrientedBoundingBox"/> corners.
- </summary>
- <returns>The axis-aligned BoundingBox of this OrientedBoundingBox.</returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.GetBoxToBoxMatrix(SharpDX.OrientedBoundingBox@,SharpDX.OrientedBoundingBox@,System.Boolean)">
- <summary>
- Calculates the matrix required to transfer any point from one <see cref="T:SharpDX.OrientedBoundingBox"/> local coordinates to another.
- </summary>
- <param name="A">The source OrientedBoundingBox.</param>
- <param name="B">The target OrientedBoundingBox.</param>
- <param name="NoMatrixScaleApplied">
- If true, the method will use a fast algorithm which is inapplicable if a scale is applied to the transformation matrix of the OrientedBoundingBox.
- </param>
- <returns></returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Merge(SharpDX.OrientedBoundingBox@,SharpDX.OrientedBoundingBox@,System.Boolean)">
- <summary>
- Merge an OrientedBoundingBox B into another OrientedBoundingBox A, by expanding A to contain B and keeping A orientation.
- </summary>
- <param name="A">The <see cref="T:SharpDX.OrientedBoundingBox"/> to merge into it.</param>
- <param name="B">The <see cref="T:SharpDX.OrientedBoundingBox"/> to be merged</param>
- <param name="NoMatrixScaleApplied">
- If true, the method will use a fast algorithm which is inapplicable if a scale is applied to the transformation matrix of the OrientedBoundingBox.
- </param>
- <remarks>
- Unlike merging axis aligned boxes, The operation is not interchangeable, because it keeps A orientation and merge B into it.
- </remarks>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.MergeInto(SharpDX.OrientedBoundingBox@,System.Boolean)">
- <summary>
- Merge this OrientedBoundingBox into another OrientedBoundingBox, keeping the other OrientedBoundingBox orientation.
- </summary>
- <param name="OBB">The other <see cref="T:SharpDX.OrientedBoundingBox"/> to merge into.</param>
- <param name="NoMatrixScaleApplied">
- If true, the method will use a fast algorithm which is inapplicable if a scale is applied to the transformation matrix of the OrientedBoundingBox.
- </param>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Add(SharpDX.OrientedBoundingBox@,System.Boolean)">
- <summary>
- Merge another OrientedBoundingBox into this OrientedBoundingBox.
- </summary>
- <param name="OBB">The other <see cref="T:SharpDX.OrientedBoundingBox"/> to merge into this OrientedBoundingBox.</param>
- <param name="NoMatrixScaleApplied">
- If true, the method will use a fast algorithm which is inapplicable if a scale is applied to the transformation matrix of the OrientedBoundingBox.
- </param>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Equals(SharpDX.OrientedBoundingBox@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Equals(SharpDX.OrientedBoundingBox)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.op_Equality(SharpDX.OrientedBoundingBox,SharpDX.OrientedBoundingBox)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.op_Inequality(SharpDX.OrientedBoundingBox,SharpDX.OrientedBoundingBox)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.OrientedBoundingBox.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="T:SharpDX.Plane">
- <summary>
- Represents a plane in three dimensional space.
- </summary>
- </member>
- <member name="F:SharpDX.Plane.Normal">
- <summary>
- The normal vector of the plane.
- </summary>
- </member>
- <member name="F:SharpDX.Plane.D">
- <summary>
- The distance of the plane along its normal from the origin.
- </summary>
- </member>
- <member name="M:SharpDX.Plane.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Plane"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Plane.#ctor(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Plane"/> struct.
- </summary>
- <param name="a">The X component of the normal.</param>
- <param name="b">The Y component of the normal.</param>
- <param name="c">The Z component of the normal.</param>
- <param name="d">The distance of the plane along its normal from the origin.</param>
- </member>
- <member name="M:SharpDX.Plane.#ctor(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Plane" /> class.
- </summary>
- <param name="point">Any point that lies along the plane.</param>
- <param name="normal">The normal vector to the plane.</param>
- </member>
- <member name="M:SharpDX.Plane.#ctor(SharpDX.Vector3,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Plane"/> struct.
- </summary>
- <param name="value">The normal of the plane.</param>
- <param name="d">The distance of the plane along its normal from the origin</param>
- </member>
- <member name="M:SharpDX.Plane.#ctor(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Plane"/> struct.
- </summary>
- <param name="point1">First point of a triangle defining the plane.</param>
- <param name="point2">Second point of a triangle defining the plane.</param>
- <param name="point3">Third point of a triangle defining the plane.</param>
- </member>
- <member name="M:SharpDX.Plane.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Plane"/> struct.
- </summary>
- <param name="values">The values to assign to the A, B, C, and D components of the plane. This must be an array with four elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than four elements.</exception>
- </member>
- <member name="P:SharpDX.Plane.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the A, B, C, or D component, depending on the index.</value>
- <param name="index">The index of the component to access. Use 0 for the A component, 1 for the B component, 2 for the C component, and 3 for the D component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Plane.Normalize">
- <summary>
- Changes the coefficients of the normal vector of the plane to make it of unit length.
- </summary>
- </member>
- <member name="M:SharpDX.Plane.ToArray">
- <summary>
- Creates an array containing the elements of the plane.
- </summary>
- <returns>A four-element array containing the components of the plane.</returns>
- </member>
- <member name="M:SharpDX.Plane.Intersects(SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a point.
- </summary>
- <param name="point">The point to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Plane.Intersects(SharpDX.Ray@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Plane.Intersects(SharpDX.Ray@,System.Single@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Plane.Intersects(SharpDX.Ray@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Plane.Intersects(SharpDX.Plane@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="plane">The plane to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Plane.Intersects(SharpDX.Plane@,SharpDX.Ray@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="plane">The plane to test.</param>
- <param name="line">When the method completes, contains the line of intersection
- as a <see cref="T:SharpDX.Ray"/>, or a zero ray if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Plane.Intersects(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a triangle.
- </summary>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Plane.Intersects(SharpDX.BoundingBox@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Plane.Intersects(SharpDX.BoundingSphere@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Plane.Reflection(SharpDX.Matrix@)">
- <summary>
- Builds a matrix that can be used to reflect vectors about a plane.
- </summary>
- <param name="plane">The plane for which the reflection occurs. This parameter is assumed to be normalized.</param>
- <param name="result">When the method completes, contains the reflection matrix.</param>
- </member>
- <member name="M:SharpDX.Plane.Reflection">
- <summary>
- Builds a matrix that can be used to reflect vectors about a plane.
- </summary>
- <returns>The reflection matrix.</returns>
- </member>
- <member name="M:SharpDX.Plane.Shadow(SharpDX.Vector4@,SharpDX.Matrix@)">
- <summary>
- Creates a matrix that flattens geometry into a shadow from this the plane onto which to project the geometry as a shadow.
- This plane is assumed to be normalized
- </summary>
- <param name="light">The light direction. If the W component is 0, the light is directional light; if the
- W component is 1, the light is a point light.</param>
- <param name="result">When the method completes, contains the shadow matrix.</param>
- </member>
- <member name="M:SharpDX.Plane.Shadow(SharpDX.Vector4)">
- <summary>
- Creates a matrix that flattens geometry into a shadow from this the plane onto which to project the geometry as a shadow.
- This plane is assumed to be normalized
- </summary>
- <param name="light">The light direction. If the W component is 0, the light is directional light; if the
- W component is 1, the light is a point light.</param>
- <returns>The shadow matrix.</returns>
- </member>
- <member name="M:SharpDX.Plane.Reflection(SharpDX.Matrix3x3@)">
- <summary>
- Builds a Matrix3x3 that can be used to reflect vectors about a plane for which the reflection occurs.
- This plane is assumed to be normalized
- </summary>
- <param name="result">When the method completes, contains the reflection Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Plane.Reflection3x3">
- <summary>
- Builds a Matrix3x3 that can be used to reflect vectors about a plane for which the reflection occurs.
- This plane is assumed to be normalized
- </summary>
- <returns>The reflection Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Plane.Shadow(SharpDX.Vector4@,SharpDX.Plane@,SharpDX.Matrix3x3@)">
- <summary>
- Creates a Matrix3x3 that flattens geometry into a shadow.
- </summary>
- <param name="light">The light direction. If the W component is 0, the light is directional light; if the
- W component is 1, the light is a point light.</param>
- <param name="plane">The plane onto which to project the geometry as a shadow. This parameter is assumed to be normalized.</param>
- <param name="result">When the method completes, contains the shadow Matrix3x3.</param>
- </member>
- <member name="M:SharpDX.Plane.Shadow(SharpDX.Vector4,SharpDX.Plane)">
- <summary>
- Creates a Matrix3x3 that flattens geometry into a shadow.
- </summary>
- <param name="light">The light direction. If the W component is 0, the light is directional light; if the
- W component is 1, the light is a point light.</param>
- <param name="plane">The plane onto which to project the geometry as a shadow. This parameter is assumed to be normalized.</param>
- <returns>The shadow Matrix3x3.</returns>
- </member>
- <member name="M:SharpDX.Plane.Multiply(SharpDX.Plane@,System.Single,SharpDX.Plane@)">
- <summary>
- Scales the plane by the given scaling factor.
- </summary>
- <param name="value">The plane to scale.</param>
- <param name="scale">The amount by which to scale the plane.</param>
- <param name="result">When the method completes, contains the scaled plane.</param>
- </member>
- <member name="M:SharpDX.Plane.Multiply(SharpDX.Plane,System.Single)">
- <summary>
- Scales the plane by the given scaling factor.
- </summary>
- <param name="value">The plane to scale.</param>
- <param name="scale">The amount by which to scale the plane.</param>
- <returns>The scaled plane.</returns>
- </member>
- <member name="M:SharpDX.Plane.Dot(SharpDX.Plane@,SharpDX.Vector4@,System.Single@)">
- <summary>
- Calculates the dot product of the specified vector and plane.
- </summary>
- <param name="left">The source plane.</param>
- <param name="right">The source vector.</param>
- <param name="result">When the method completes, contains the dot product of the specified plane and vector.</param>
- </member>
- <member name="M:SharpDX.Plane.Dot(SharpDX.Plane,SharpDX.Vector4)">
- <summary>
- Calculates the dot product of the specified vector and plane.
- </summary>
- <param name="left">The source plane.</param>
- <param name="right">The source vector.</param>
- <returns>The dot product of the specified plane and vector.</returns>
- </member>
- <member name="M:SharpDX.Plane.DotCoordinate(SharpDX.Plane@,SharpDX.Vector3@,System.Single@)">
- <summary>
- Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane.
- </summary>
- <param name="left">The source plane.</param>
- <param name="right">The source vector.</param>
- <param name="result">When the method completes, contains the dot product of a specified vector and the normal of the Plane plus the distance value of the plane.</param>
- </member>
- <member name="M:SharpDX.Plane.DotCoordinate(SharpDX.Plane,SharpDX.Vector3)">
- <summary>
- Calculates the dot product of a specified vector and the normal of the plane plus the distance value of the plane.
- </summary>
- <param name="left">The source plane.</param>
- <param name="right">The source vector.</param>
- <returns>The dot product of a specified vector and the normal of the Plane plus the distance value of the plane.</returns>
- </member>
- <member name="M:SharpDX.Plane.DotNormal(SharpDX.Plane@,SharpDX.Vector3@,System.Single@)">
- <summary>
- Calculates the dot product of the specified vector and the normal of the plane.
- </summary>
- <param name="left">The source plane.</param>
- <param name="right">The source vector.</param>
- <param name="result">When the method completes, contains the dot product of the specified vector and the normal of the plane.</param>
- </member>
- <member name="M:SharpDX.Plane.DotNormal(SharpDX.Plane,SharpDX.Vector3)">
- <summary>
- Calculates the dot product of the specified vector and the normal of the plane.
- </summary>
- <param name="left">The source plane.</param>
- <param name="right">The source vector.</param>
- <returns>The dot product of the specified vector and the normal of the plane.</returns>
- </member>
- <member name="M:SharpDX.Plane.Normalize(SharpDX.Plane@,SharpDX.Plane@)">
- <summary>
- Changes the coefficients of the normal vector of the plane to make it of unit length.
- </summary>
- <param name="plane">The source plane.</param>
- <param name="result">When the method completes, contains the normalized plane.</param>
- </member>
- <member name="M:SharpDX.Plane.Normalize(SharpDX.Plane)">
- <summary>
- Changes the coefficients of the normal vector of the plane to make it of unit length.
- </summary>
- <param name="plane">The source plane.</param>
- <returns>The normalized plane.</returns>
- </member>
- <member name="M:SharpDX.Plane.Transform(SharpDX.Plane@,SharpDX.Quaternion@,SharpDX.Plane@)">
- <summary>
- Transforms a normalized plane by a quaternion rotation.
- </summary>
- <param name="plane">The normalized source plane.</param>
- <param name="rotation">The quaternion rotation.</param>
- <param name="result">When the method completes, contains the transformed plane.</param>
- </member>
- <member name="M:SharpDX.Plane.Transform(SharpDX.Plane,SharpDX.Quaternion)">
- <summary>
- Transforms a normalized plane by a quaternion rotation.
- </summary>
- <param name="plane">The normalized source plane.</param>
- <param name="rotation">The quaternion rotation.</param>
- <returns>The transformed plane.</returns>
- </member>
- <member name="M:SharpDX.Plane.Transform(SharpDX.Plane[],SharpDX.Quaternion@)">
- <summary>
- Transforms an array of normalized planes by a quaternion rotation.
- </summary>
- <param name="planes">The array of normalized planes to transform.</param>
- <param name="rotation">The quaternion rotation.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="planes"/> is <c>null</c>.</exception>
- </member>
- <member name="M:SharpDX.Plane.Transform(SharpDX.Plane@,SharpDX.Matrix@,SharpDX.Plane@)">
- <summary>
- Transforms a normalized plane by a matrix.
- </summary>
- <param name="plane">The normalized source plane.</param>
- <param name="transformation">The transformation matrix.</param>
- <param name="result">When the method completes, contains the transformed plane.</param>
- </member>
- <member name="M:SharpDX.Plane.Transform(SharpDX.Plane,SharpDX.Matrix)">
- <summary>
- Transforms a normalized plane by a matrix.
- </summary>
- <param name="plane">The normalized source plane.</param>
- <param name="transformation">The transformation matrix.</param>
- <returns>When the method completes, contains the transformed plane.</returns>
- </member>
- <member name="M:SharpDX.Plane.Transform(SharpDX.Plane[],SharpDX.Matrix@)">
- <summary>
- Transforms an array of normalized planes by a matrix.
- </summary>
- <param name="planes">The array of normalized planes to transform.</param>
- <param name="transformation">The transformation matrix.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="planes"/> is <c>null</c>.</exception>
- </member>
- <member name="M:SharpDX.Plane.op_Multiply(System.Single,SharpDX.Plane)">
- <summary>
- Scales a plane by the given value.
- </summary>
- <param name="scale">The amount by which to scale the plane.</param>
- <param name="plane">The plane to scale.</param>
- <returns>The scaled plane.</returns>
- </member>
- <member name="M:SharpDX.Plane.op_Multiply(SharpDX.Plane,System.Single)">
- <summary>
- Scales a plane by the given value.
- </summary>
- <param name="plane">The plane to scale.</param>
- <param name="scale">The amount by which to scale the plane.</param>
- <returns>The scaled plane.</returns>
- </member>
- <member name="M:SharpDX.Plane.op_Equality(SharpDX.Plane,SharpDX.Plane)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Plane.op_Inequality(SharpDX.Plane,SharpDX.Plane)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Plane.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Plane.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Plane.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Plane.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Plane.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Plane.Equals(SharpDX.Plane@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Plane.Equals(SharpDX.Plane)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Plane.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:SharpDX.Point">
- <summary>
- Structure using the same layout than <see cref="!:System.Drawing.Point"/>.
- </summary>
- </member>
- <member name="F:SharpDX.Point.Zero">
- <summary>
- A point with (0,0) coordinates.
- </summary>
- </member>
- <member name="M:SharpDX.Point.#ctor(System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Point"/> struct.
- </summary>
- <param name="x">The x.</param>
- <param name="y">The y.</param>
- </member>
- <member name="F:SharpDX.Point.X">
- <summary>
- Left coordinate.
- </summary>
- </member>
- <member name="F:SharpDX.Point.Y">
- <summary>
- Top coordinate.
- </summary>
- </member>
- <member name="M:SharpDX.Point.Equals(SharpDX.Point@)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Point.Equals(SharpDX.Point)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Point.Equals(System.Object)">
- <inheritdoc/>
- </member>
- <member name="M:SharpDX.Point.GetHashCode">
- <inheritdoc/>
- </member>
- <member name="M:SharpDX.Point.op_Equality(SharpDX.Point,SharpDX.Point)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>
- The result of the operator.
- </returns>
- </member>
- <member name="M:SharpDX.Point.op_Inequality(SharpDX.Point,SharpDX.Point)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>
- The result of the operator.
- </returns>
- </member>
- <member name="M:SharpDX.Point.op_Explicit(SharpDX.Vector2)~SharpDX.Point">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector2"/> to <see cref="T:SharpDX.Point"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Point.op_Implicit(SharpDX.Point)~SharpDX.Vector2">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Point"/> to <see cref="T:SharpDX.Vector2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Point.op_Implicit(SharpDX.Point)~SharpDX.Mathematics.Interop.RawPoint">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Point"/> to <see cref="T:SharpDX.Mathematics.Interop.RawPoint"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Point.op_Implicit(SharpDX.Mathematics.Interop.RawPoint)~SharpDX.Point">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawPoint"/> to <see cref="T:SharpDX.Point"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.Quaternion">
- <summary>
- Represents a four dimensional mathematical quaternion.
- </summary>
- </member>
- <member name="F:SharpDX.Quaternion.SizeInBytes">
- <summary>
- The size of the <see cref="T:SharpDX.Quaternion"/> type, in bytes.
- </summary>
- </member>
- <member name="F:SharpDX.Quaternion.Zero">
- <summary>
- A <see cref="T:SharpDX.Quaternion"/> with all of its components set to zero.
- </summary>
- </member>
- <member name="F:SharpDX.Quaternion.One">
- <summary>
- A <see cref="T:SharpDX.Quaternion"/> with all of its components set to one.
- </summary>
- </member>
- <member name="F:SharpDX.Quaternion.Identity">
- <summary>
- The identity <see cref="T:SharpDX.Quaternion"/> (0, 0, 0, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Quaternion.X">
- <summary>
- The X component of the quaternion.
- </summary>
- </member>
- <member name="F:SharpDX.Quaternion.Y">
- <summary>
- The Y component of the quaternion.
- </summary>
- </member>
- <member name="F:SharpDX.Quaternion.Z">
- <summary>
- The Z component of the quaternion.
- </summary>
- </member>
- <member name="F:SharpDX.Quaternion.W">
- <summary>
- The W component of the quaternion.
- </summary>
- </member>
- <member name="M:SharpDX.Quaternion.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Quaternion"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Quaternion.#ctor(SharpDX.Vector4)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Quaternion"/> struct.
- </summary>
- <param name="value">A vector containing the values with which to initialize the components.</param>
- </member>
- <member name="M:SharpDX.Quaternion.#ctor(SharpDX.Vector3,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Quaternion"/> struct.
- </summary>
- <param name="value">A vector containing the values with which to initialize the X, Y, and Z components.</param>
- <param name="w">Initial value for the W component of the quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.#ctor(SharpDX.Vector2,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Quaternion"/> struct.
- </summary>
- <param name="value">A vector containing the values with which to initialize the X and Y components.</param>
- <param name="z">Initial value for the Z component of the quaternion.</param>
- <param name="w">Initial value for the W component of the quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.#ctor(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Quaternion"/> struct.
- </summary>
- <param name="x">Initial value for the X component of the quaternion.</param>
- <param name="y">Initial value for the Y component of the quaternion.</param>
- <param name="z">Initial value for the Z component of the quaternion.</param>
- <param name="w">Initial value for the W component of the quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Quaternion"/> struct.
- </summary>
- <param name="values">The values to assign to the X, Y, Z, and W components of the quaternion. This must be an array with four elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than four elements.</exception>
- </member>
- <member name="P:SharpDX.Quaternion.IsIdentity">
- <summary>
- Gets a value indicating whether this instance is equivalent to the identity quaternion.
- </summary>
- <value>
- <c>true</c> if this instance is an identity quaternion; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SharpDX.Quaternion.IsNormalized">
- <summary>
- Gets a value indicting whether this instance is normalized.
- </summary>
- </member>
- <member name="P:SharpDX.Quaternion.Angle">
- <summary>
- Gets the angle of the quaternion.
- </summary>
- <value>The quaternion's angle.</value>
- </member>
- <member name="P:SharpDX.Quaternion.Axis">
- <summary>
- Gets the axis components of the quaternion.
- </summary>
- <value>The axis components of the quaternion.</value>
- </member>
- <member name="P:SharpDX.Quaternion.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the X, Y, Z, or W component, depending on the index.</value>
- <param name="index">The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Quaternion.Conjugate">
- <summary>
- Conjugates the quaternion.
- </summary>
- </member>
- <member name="M:SharpDX.Quaternion.Invert">
- <summary>
- Conjugates and renormalizes the quaternion.
- </summary>
- </member>
- <member name="M:SharpDX.Quaternion.Length">
- <summary>
- Calculates the length of the quaternion.
- </summary>
- <returns>The length of the quaternion.</returns>
- <remarks>
- <see cref="M:SharpDX.Quaternion.LengthSquared"/> may be preferred when only the relative length is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Quaternion.LengthSquared">
- <summary>
- Calculates the squared length of the quaternion.
- </summary>
- <returns>The squared length of the quaternion.</returns>
- <remarks>
- This method may be preferred to <see cref="M:SharpDX.Quaternion.Length"/> when only a relative length is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Quaternion.Normalize">
- <summary>
- Converts the quaternion into a unit quaternion.
- </summary>
- </member>
- <member name="M:SharpDX.Quaternion.ToArray">
- <summary>
- Creates an array containing the elements of the quaternion.
- </summary>
- <returns>A four-element array containing the components of the quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Add(SharpDX.Quaternion@,SharpDX.Quaternion@,SharpDX.Quaternion@)">
- <summary>
- Adds two quaternions.
- </summary>
- <param name="left">The first quaternion to add.</param>
- <param name="right">The second quaternion to add.</param>
- <param name="result">When the method completes, contains the sum of the two quaternions.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Add(SharpDX.Quaternion,SharpDX.Quaternion)">
- <summary>
- Adds two quaternions.
- </summary>
- <param name="left">The first quaternion to add.</param>
- <param name="right">The second quaternion to add.</param>
- <returns>The sum of the two quaternions.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Subtract(SharpDX.Quaternion@,SharpDX.Quaternion@,SharpDX.Quaternion@)">
- <summary>
- Subtracts two quaternions.
- </summary>
- <param name="left">The first quaternion to subtract.</param>
- <param name="right">The second quaternion to subtract.</param>
- <param name="result">When the method completes, contains the difference of the two quaternions.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Subtract(SharpDX.Quaternion,SharpDX.Quaternion)">
- <summary>
- Subtracts two quaternions.
- </summary>
- <param name="left">The first quaternion to subtract.</param>
- <param name="right">The second quaternion to subtract.</param>
- <returns>The difference of the two quaternions.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Multiply(SharpDX.Quaternion@,System.Single,SharpDX.Quaternion@)">
- <summary>
- Scales a quaternion by the given value.
- </summary>
- <param name="value">The quaternion to scale.</param>
- <param name="scale">The amount by which to scale the quaternion.</param>
- <param name="result">When the method completes, contains the scaled quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Multiply(SharpDX.Quaternion,System.Single)">
- <summary>
- Scales a quaternion by the given value.
- </summary>
- <param name="value">The quaternion to scale.</param>
- <param name="scale">The amount by which to scale the quaternion.</param>
- <returns>The scaled quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Multiply(SharpDX.Quaternion@,SharpDX.Quaternion@,SharpDX.Quaternion@)">
- <summary>
- Multiplies a quaternion by another.
- </summary>
- <param name="left">The first quaternion to multiply.</param>
- <param name="right">The second quaternion to multiply.</param>
- <param name="result">When the method completes, contains the multiplied quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Multiply(SharpDX.Quaternion,SharpDX.Quaternion)">
- <summary>
- Multiplies a quaternion by another.
- </summary>
- <param name="left">The first quaternion to multiply.</param>
- <param name="right">The second quaternion to multiply.</param>
- <returns>The multiplied quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Negate(SharpDX.Quaternion@,SharpDX.Quaternion@)">
- <summary>
- Reverses the direction of a given quaternion.
- </summary>
- <param name="value">The quaternion to negate.</param>
- <param name="result">When the method completes, contains a quaternion facing in the opposite direction.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Negate(SharpDX.Quaternion)">
- <summary>
- Reverses the direction of a given quaternion.
- </summary>
- <param name="value">The quaternion to negate.</param>
- <returns>A quaternion facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Barycentric(SharpDX.Quaternion@,SharpDX.Quaternion@,SharpDX.Quaternion@,System.Single,System.Single,SharpDX.Quaternion@)">
- <summary>
- Returns a <see cref="T:SharpDX.Quaternion"/> containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle.
- </summary>
- <param name="value1">A <see cref="T:SharpDX.Quaternion"/> containing the 4D Cartesian coordinates of vertex 1 of the triangle.</param>
- <param name="value2">A <see cref="T:SharpDX.Quaternion"/> containing the 4D Cartesian coordinates of vertex 2 of the triangle.</param>
- <param name="value3">A <see cref="T:SharpDX.Quaternion"/> containing the 4D Cartesian coordinates of vertex 3 of the triangle.</param>
- <param name="amount1">Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in <paramref name="value2"/>).</param>
- <param name="amount2">Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in <paramref name="value3"/>).</param>
- <param name="result">When the method completes, contains a new <see cref="T:SharpDX.Quaternion"/> containing the 4D Cartesian coordinates of the specified point.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Barycentric(SharpDX.Quaternion,SharpDX.Quaternion,SharpDX.Quaternion,System.Single,System.Single)">
- <summary>
- Returns a <see cref="T:SharpDX.Quaternion"/> containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle.
- </summary>
- <param name="value1">A <see cref="T:SharpDX.Quaternion"/> containing the 4D Cartesian coordinates of vertex 1 of the triangle.</param>
- <param name="value2">A <see cref="T:SharpDX.Quaternion"/> containing the 4D Cartesian coordinates of vertex 2 of the triangle.</param>
- <param name="value3">A <see cref="T:SharpDX.Quaternion"/> containing the 4D Cartesian coordinates of vertex 3 of the triangle.</param>
- <param name="amount1">Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in <paramref name="value2"/>).</param>
- <param name="amount2">Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in <paramref name="value3"/>).</param>
- <returns>A new <see cref="T:SharpDX.Quaternion"/> containing the 4D Cartesian coordinates of the specified point.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Conjugate(SharpDX.Quaternion@,SharpDX.Quaternion@)">
- <summary>
- Conjugates a quaternion.
- </summary>
- <param name="value">The quaternion to conjugate.</param>
- <param name="result">When the method completes, contains the conjugated quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Conjugate(SharpDX.Quaternion)">
- <summary>
- Conjugates a quaternion.
- </summary>
- <param name="value">The quaternion to conjugate.</param>
- <returns>The conjugated quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Dot(SharpDX.Quaternion@,SharpDX.Quaternion@,System.Single@)">
- <summary>
- Calculates the dot product of two quaternions.
- </summary>
- <param name="left">First source quaternion.</param>
- <param name="right">Second source quaternion.</param>
- <param name="result">When the method completes, contains the dot product of the two quaternions.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Dot(SharpDX.Quaternion,SharpDX.Quaternion)">
- <summary>
- Calculates the dot product of two quaternions.
- </summary>
- <param name="left">First source quaternion.</param>
- <param name="right">Second source quaternion.</param>
- <returns>The dot product of the two quaternions.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Exponential(SharpDX.Quaternion@,SharpDX.Quaternion@)">
- <summary>
- Exponentiates a quaternion.
- </summary>
- <param name="value">The quaternion to exponentiate.</param>
- <param name="result">When the method completes, contains the exponentiated quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Exponential(SharpDX.Quaternion)">
- <summary>
- Exponentiates a quaternion.
- </summary>
- <param name="value">The quaternion to exponentiate.</param>
- <returns>The exponentiated quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Invert(SharpDX.Quaternion@,SharpDX.Quaternion@)">
- <summary>
- Conjugates and renormalizes the quaternion.
- </summary>
- <param name="value">The quaternion to conjugate and renormalize.</param>
- <param name="result">When the method completes, contains the conjugated and renormalized quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Invert(SharpDX.Quaternion)">
- <summary>
- Conjugates and renormalizes the quaternion.
- </summary>
- <param name="value">The quaternion to conjugate and renormalize.</param>
- <returns>The conjugated and renormalized quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Lerp(SharpDX.Quaternion@,SharpDX.Quaternion@,System.Single,SharpDX.Quaternion@)">
- <summary>
- Performs a linear interpolation between two quaternions.
- </summary>
- <param name="start">Start quaternion.</param>
- <param name="end">End quaternion.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two quaternions.</param>
- <remarks>
- This method performs the linear interpolation based on the following formula.
- <code>start + (end - start) * amount</code>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Quaternion.Lerp(SharpDX.Quaternion,SharpDX.Quaternion,System.Single)">
- <summary>
- Performs a linear interpolation between two quaternion.
- </summary>
- <param name="start">Start quaternion.</param>
- <param name="end">End quaternion.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two quaternions.</returns>
- <remarks>
- This method performs the linear interpolation based on the following formula.
- <code>start + (end - start) * amount</code>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Quaternion.Logarithm(SharpDX.Quaternion@,SharpDX.Quaternion@)">
- <summary>
- Calculates the natural logarithm of the specified quaternion.
- </summary>
- <param name="value">The quaternion whose logarithm will be calculated.</param>
- <param name="result">When the method completes, contains the natural logarithm of the quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Logarithm(SharpDX.Quaternion)">
- <summary>
- Calculates the natural logarithm of the specified quaternion.
- </summary>
- <param name="value">The quaternion whose logarithm will be calculated.</param>
- <returns>The natural logarithm of the quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Normalize(SharpDX.Quaternion@,SharpDX.Quaternion@)">
- <summary>
- Converts the quaternion into a unit quaternion.
- </summary>
- <param name="value">The quaternion to normalize.</param>
- <param name="result">When the method completes, contains the normalized quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Normalize(SharpDX.Quaternion)">
- <summary>
- Converts the quaternion into a unit quaternion.
- </summary>
- <param name="value">The quaternion to normalize.</param>
- <returns>The normalized quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.RotationAxis(SharpDX.Vector3@,System.Single,SharpDX.Quaternion@)">
- <summary>
- Creates a quaternion given a rotation and an axis.
- </summary>
- <param name="axis">The axis of rotation.</param>
- <param name="angle">The angle of rotation.</param>
- <param name="result">When the method completes, contains the newly created quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.RotationAxis(SharpDX.Vector3,System.Single)">
- <summary>
- Creates a quaternion given a rotation and an axis.
- </summary>
- <param name="axis">The axis of rotation.</param>
- <param name="angle">The angle of rotation.</param>
- <returns>The newly created quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.RotationMatrix(SharpDX.Matrix@,SharpDX.Quaternion@)">
- <summary>
- Creates a quaternion given a rotation matrix.
- </summary>
- <param name="matrix">The rotation matrix.</param>
- <param name="result">When the method completes, contains the newly created quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.RotationMatrix(SharpDX.Matrix3x3@,SharpDX.Quaternion@)">
- <summary>
- Creates a quaternion given a rotation matrix.
- </summary>
- <param name="matrix">The rotation matrix.</param>
- <param name="result">When the method completes, contains the newly created quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.LookAtLH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Quaternion@)">
- <summary>
- Creates a left-handed, look-at quaternion.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <param name="result">When the method completes, contains the created look-at quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.LookAtLH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a left-handed, look-at quaternion.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <returns>The created look-at quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.RotationLookAtLH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Quaternion@)">
- <summary>
- Creates a left-handed, look-at quaternion.
- </summary>
- <param name="forward">The camera's forward direction.</param>
- <param name="up">The camera's up vector.</param>
- <param name="result">When the method completes, contains the created look-at quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.RotationLookAtLH(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a left-handed, look-at quaternion.
- </summary>
- <param name="forward">The camera's forward direction.</param>
- <param name="up">The camera's up vector.</param>
- <returns>The created look-at quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.LookAtRH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Quaternion@)">
- <summary>
- Creates a right-handed, look-at quaternion.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <param name="result">When the method completes, contains the created look-at quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.LookAtRH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a right-handed, look-at quaternion.
- </summary>
- <param name="eye">The position of the viewer's eye.</param>
- <param name="target">The camera look-at target.</param>
- <param name="up">The camera's up vector.</param>
- <returns>The created look-at quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.RotationLookAtRH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Quaternion@)">
- <summary>
- Creates a right-handed, look-at quaternion.
- </summary>
- <param name="forward">The camera's forward direction.</param>
- <param name="up">The camera's up vector.</param>
- <param name="result">When the method completes, contains the created look-at quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.RotationLookAtRH(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a right-handed, look-at quaternion.
- </summary>
- <param name="forward">The camera's forward direction.</param>
- <param name="up">The camera's up vector.</param>
- <returns>The created look-at quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.BillboardLH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Quaternion@)">
- <summary>
- Creates a left-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <param name="result">When the method completes, contains the created billboard quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.BillboardLH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a left-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <returns>The created billboard quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.BillboardRH(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Quaternion@)">
- <summary>
- Creates a right-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <param name="result">When the method completes, contains the created billboard quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.BillboardRH(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Creates a right-handed spherical billboard that rotates around a specified object position.
- </summary>
- <param name="objectPosition">The position of the object around which the billboard will rotate.</param>
- <param name="cameraPosition">The position of the camera.</param>
- <param name="cameraUpVector">The up vector of the camera.</param>
- <param name="cameraForwardVector">The forward vector of the camera.</param>
- <returns>The created billboard quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.RotationMatrix(SharpDX.Matrix)">
- <summary>
- Creates a quaternion given a rotation matrix.
- </summary>
- <param name="matrix">The rotation matrix.</param>
- <returns>The newly created quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.RotationYawPitchRoll(System.Single,System.Single,System.Single,SharpDX.Quaternion@)">
- <summary>
- Creates a quaternion given a yaw, pitch, and roll value.
- </summary>
- <param name="yaw">The yaw of rotation.</param>
- <param name="pitch">The pitch of rotation.</param>
- <param name="roll">The roll of rotation.</param>
- <param name="result">When the method completes, contains the newly created quaternion.</param>
- </member>
- <member name="M:SharpDX.Quaternion.RotationYawPitchRoll(System.Single,System.Single,System.Single)">
- <summary>
- Creates a quaternion given a yaw, pitch, and roll value.
- </summary>
- <param name="yaw">The yaw of rotation.</param>
- <param name="pitch">The pitch of rotation.</param>
- <param name="roll">The roll of rotation.</param>
- <returns>The newly created quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Slerp(SharpDX.Quaternion@,SharpDX.Quaternion@,System.Single,SharpDX.Quaternion@)">
- <summary>
- Interpolates between two quaternions, using spherical linear interpolation.
- </summary>
- <param name="start">Start quaternion.</param>
- <param name="end">End quaternion.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the spherical linear interpolation of the two quaternions.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Slerp(SharpDX.Quaternion,SharpDX.Quaternion,System.Single)">
- <summary>
- Interpolates between two quaternions, using spherical linear interpolation.
- </summary>
- <param name="start">Start quaternion.</param>
- <param name="end">End quaternion.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The spherical linear interpolation of the two quaternions.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.Squad(SharpDX.Quaternion@,SharpDX.Quaternion@,SharpDX.Quaternion@,SharpDX.Quaternion@,System.Single,SharpDX.Quaternion@)">
- <summary>
- Interpolates between quaternions, using spherical quadrangle interpolation.
- </summary>
- <param name="value1">First source quaternion.</param>
- <param name="value2">Second source quaternion.</param>
- <param name="value3">Third source quaternion.</param>
- <param name="value4">Fourth source quaternion.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of interpolation.</param>
- <param name="result">When the method completes, contains the spherical quadrangle interpolation of the quaternions.</param>
- </member>
- <member name="M:SharpDX.Quaternion.Squad(SharpDX.Quaternion,SharpDX.Quaternion,SharpDX.Quaternion,SharpDX.Quaternion,System.Single)">
- <summary>
- Interpolates between quaternions, using spherical quadrangle interpolation.
- </summary>
- <param name="value1">First source quaternion.</param>
- <param name="value2">Second source quaternion.</param>
- <param name="value3">Third source quaternion.</param>
- <param name="value4">Fourth source quaternion.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of interpolation.</param>
- <returns>The spherical quadrangle interpolation of the quaternions.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.SquadSetup(SharpDX.Quaternion,SharpDX.Quaternion,SharpDX.Quaternion,SharpDX.Quaternion)">
- <summary>
- Sets up control points for spherical quadrangle interpolation.
- </summary>
- <param name="value1">First source quaternion.</param>
- <param name="value2">Second source quaternion.</param>
- <param name="value3">Third source quaternion.</param>
- <param name="value4">Fourth source quaternion.</param>
- <returns>An array of three quaternions that represent control points for spherical quadrangle interpolation.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.op_Addition(SharpDX.Quaternion,SharpDX.Quaternion)">
- <summary>
- Adds two quaternions.
- </summary>
- <param name="left">The first quaternion to add.</param>
- <param name="right">The second quaternion to add.</param>
- <returns>The sum of the two quaternions.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.op_Subtraction(SharpDX.Quaternion,SharpDX.Quaternion)">
- <summary>
- Subtracts two quaternions.
- </summary>
- <param name="left">The first quaternion to subtract.</param>
- <param name="right">The second quaternion to subtract.</param>
- <returns>The difference of the two quaternions.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.op_UnaryNegation(SharpDX.Quaternion)">
- <summary>
- Reverses the direction of a given quaternion.
- </summary>
- <param name="value">The quaternion to negate.</param>
- <returns>A quaternion facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.op_Multiply(System.Single,SharpDX.Quaternion)">
- <summary>
- Scales a quaternion by the given value.
- </summary>
- <param name="value">The quaternion to scale.</param>
- <param name="scale">The amount by which to scale the quaternion.</param>
- <returns>The scaled quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.op_Multiply(SharpDX.Quaternion,System.Single)">
- <summary>
- Scales a quaternion by the given value.
- </summary>
- <param name="value">The quaternion to scale.</param>
- <param name="scale">The amount by which to scale the quaternion.</param>
- <returns>The scaled quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.op_Multiply(SharpDX.Quaternion,SharpDX.Quaternion)">
- <summary>
- Multiplies a quaternion by another.
- </summary>
- <param name="left">The first quaternion to multiply.</param>
- <param name="right">The second quaternion to multiply.</param>
- <returns>The multiplied quaternion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.op_Equality(SharpDX.Quaternion,SharpDX.Quaternion)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.op_Inequality(SharpDX.Quaternion,SharpDX.Quaternion)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Quaternion.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Quaternion.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Quaternion.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Quaternion.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Quaternion.Equals(SharpDX.Quaternion@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Quaternion"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Quaternion"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Quaternion"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Quaternion.Equals(SharpDX.Quaternion)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Quaternion"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Quaternion"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Quaternion"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Quaternion.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Quaternion.op_Implicit(SharpDX.Quaternion)~SharpDX.Mathematics.Interop.RawQuaternion">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Quaternion"/> to <see cref="T:SharpDX.Mathematics.Interop.RawQuaternion"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Quaternion.op_Implicit(SharpDX.Mathematics.Interop.RawQuaternion)~SharpDX.Quaternion">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawQuaternion"/> to <see cref="T:SharpDX.Quaternion"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.RandomUtil">
- <summary>
- Random functions on commun types.
- </summary>
- </member>
- <member name="M:SharpDX.RandomUtil.NextFloat(System.Random,System.Single,System.Single)">
- <summary>
- Gets random <c>float</c> number within range.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="min">Minimum.</param>
- <param name="max">Maximum.</param>
- <returns>Random <c>float</c> number.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextDouble(System.Random,System.Double,System.Double)">
- <summary>
- Gets random <c>double</c> number within range.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="min">Minimum.</param>
- <param name="max">Maximum.</param>
- <returns>Random <c>double</c> number.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextLong(System.Random)">
- <summary>
- Gets random <c>long</c> number.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <returns>Random <c>long</c> number.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextLong(System.Random,System.Int64,System.Int64)">
- <summary>
- Gets random <c>long</c> number within range.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="min">Minimum.</param>
- <param name="max">Maximum.</param>
- <returns>Random <c>long</c> number.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextVector2(System.Random,SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Gets random <see cref="T:SharpDX.Vector2"/> within range.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="min">Minimum.</param>
- <param name="max">Maximum.</param>
- <returns>Random <see cref="T:SharpDX.Vector2"/>.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextVector3(System.Random,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Gets random <see cref="T:SharpDX.Vector3"/> within range.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="min">Minimum.</param>
- <param name="max">Maximum.</param>
- <returns>Random <see cref="T:SharpDX.Vector3"/>.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextVector4(System.Random,SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Gets random <see cref="T:SharpDX.Vector4"/> within range.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="min">Minimum.</param>
- <param name="max">Maximum.</param>
- <returns>Random <see cref="T:SharpDX.Vector4"/>.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextColor(System.Random)">
- <summary>
- Gets random opaque <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <returns>Random <see cref="T:SharpDX.Color"/>.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextColor(System.Random,System.Single,System.Single)">
- <summary>
- Gets random opaque <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="minBrightness">Minimum brightness.</param>
- <param name="maxBrightness">Maximum brightness</param>
- <returns>Random <see cref="T:SharpDX.Color"/>.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextColor(System.Random,System.Single,System.Single,System.Single)">
- <summary>
- Gets random <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="minBrightness">Minimum brightness.</param>
- <param name="maxBrightness">Maximum brightness</param>
- <param name="alpha">Alpha value.</param>
- <returns>Random <see cref="T:SharpDX.Color"/>.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextColor(System.Random,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Gets random <see cref="T:SharpDX.Color"/>.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="minBrightness">Minimum brightness.</param>
- <param name="maxBrightness">Maximum brightness</param>
- <param name="minAlpha">Minimum alpha.</param>
- <param name="maxAlpha">Maximum alpha.</param>
- <returns>Random <see cref="T:SharpDX.Color"/>.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextPoint(System.Random,SharpDX.Point,SharpDX.Point)">
- <summary>
- Gets random <see cref="T:SharpDX.Point"/>.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="min">Minimum.</param>
- <param name="max">Maximum.</param>
- <returns>Random <see cref="T:SharpDX.Point"/>.</returns>
- </member>
- <member name="M:SharpDX.RandomUtil.NextTime(System.Random,System.TimeSpan,System.TimeSpan)">
- <summary>
- Gets random <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="random">Current <see cref="T:System.Random"/>.</param>
- <param name="min">Minimum.</param>
- <param name="max">Maximum.</param>
- <returns>Random <see cref="T:System.TimeSpan"/>.</returns>
- </member>
- <member name="T:SharpDX.Ray">
- <summary>
- Represents a three dimensional line based on a point in space and a direction.
- </summary>
- </member>
- <member name="F:SharpDX.Ray.Position">
- <summary>
- The position in three dimensional space where the ray starts.
- </summary>
- </member>
- <member name="F:SharpDX.Ray.Direction">
- <summary>
- The normalized direction in which the ray points.
- </summary>
- </member>
- <member name="M:SharpDX.Ray.#ctor(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Ray"/> struct.
- </summary>
- <param name="position">The position in three dimensional space of the origin of the ray.</param>
- <param name="direction">The normalized direction of the ray.</param>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a point.
- </summary>
- <param name="point">The point to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.Ray@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.Ray@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Ray"/>.
- </summary>
- <param name="ray">The ray to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.Plane@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="plane">The plane to test</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.Plane@,System.Single@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="plane">The plane to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.Plane@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.Plane"/>.
- </summary>
- <param name="plane">The plane to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a triangle.
- </summary>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,System.Single@)">
- <summary>
- Determines if there is an intersection between the current object and a triangle.
- </summary>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a triangle.
- </summary>
- <param name="vertex1">The first vertex of the triangle to test.</param>
- <param name="vertex2">The second vertex of the triangle to test.</param>
- <param name="vertex3">The third vertex of the triangle to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.BoundingBox@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.BoundingBox)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.BoundingBox@,System.Single@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.BoundingBox@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingBox"/>.
- </summary>
- <param name="box">The box to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.BoundingSphere@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.BoundingSphere)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.BoundingSphere@,System.Single@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <param name="distance">When the method completes, contains the distance of the intersection,
- or 0 if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.Intersects(SharpDX.BoundingSphere@,SharpDX.Vector3@)">
- <summary>
- Determines if there is an intersection between the current object and a <see cref="T:SharpDX.BoundingSphere"/>.
- </summary>
- <param name="sphere">The sphere to test.</param>
- <param name="point">When the method completes, contains the point of intersection,
- or <see cref="F:SharpDX.Vector3.Zero"/> if there was no intersection.</param>
- <returns>Whether the two objects intersected.</returns>
- </member>
- <member name="M:SharpDX.Ray.GetPickRay(System.Int32,System.Int32,SharpDX.ViewportF,SharpDX.Matrix)">
- <summary>
- Calculates a world space <see cref="T:SharpDX.Ray"/> from 2d screen coordinates.
- </summary>
- <param name="x">X coordinate on 2d screen.</param>
- <param name="y">Y coordinate on 2d screen.</param>
- <param name="viewport"><see cref="T:SharpDX.ViewportF"/>.</param>
- <param name="worldViewProjection">Transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <returns>Resulting <see cref="T:SharpDX.Ray"/>.</returns>
- </member>
- <member name="M:SharpDX.Ray.op_Equality(SharpDX.Ray,SharpDX.Ray)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Ray.op_Inequality(SharpDX.Ray,SharpDX.Ray)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Ray.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Ray.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Ray.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Ray.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Ray.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Ray.Equals(SharpDX.Ray@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Ray.Equals(SharpDX.Ray)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Ray.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:SharpDX.Rectangle">
- <summary>
- Define a Rectangle. This structure is slightly different from System.Drawing.Rectangle as it is
- internally storing Left,Top,Right,Bottom instead of Left,Top,Width,Height.
- </summary>
- </member>
- <member name="F:SharpDX.Rectangle.Left">
- <summary>
- The left.
- </summary>
- </member>
- <member name="F:SharpDX.Rectangle.Top">
- <summary>
- The top.
- </summary>
- </member>
- <member name="F:SharpDX.Rectangle.Right">
- <summary>
- The right.
- </summary>
- </member>
- <member name="F:SharpDX.Rectangle.Bottom">
- <summary>
- The bottom.
- </summary>
- </member>
- <member name="F:SharpDX.Rectangle.Empty">
- <summary>
- An empty rectangle.
- </summary>
- </member>
- <member name="M:SharpDX.Rectangle.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Rectangle"/> struct.
- </summary>
- <param name="x">The left.</param>
- <param name="y">The top.</param>
- <param name="width">The width.</param>
- <param name="height">The height.</param>
- </member>
- <member name="P:SharpDX.Rectangle.X">
- <summary>
- Gets or sets the X position.
- </summary>
- <value>The X position.</value>
- </member>
- <member name="P:SharpDX.Rectangle.Y">
- <summary>
- Gets or sets the Y position.
- </summary>
- <value>The Y position.</value>
- </member>
- <member name="P:SharpDX.Rectangle.Width">
- <summary>
- Gets or sets the width.
- </summary>
- <value>The width.</value>
- </member>
- <member name="P:SharpDX.Rectangle.Height">
- <summary>
- Gets or sets the height.
- </summary>
- <value>The height.</value>
- </member>
- <member name="P:SharpDX.Rectangle.IsEmpty">
- <summary>
- Gets a value that indicates whether the rectangle is empty.
- </summary>
- <value>
- <c>true</c> if [is empty]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="M:SharpDX.Rectangle.Offset(System.Int32,System.Int32)">
- <summary>Changes the position of the rectangle.</summary>
- <param name="offsetX">Change in the x-position.</param>
- <param name="offsetY">Change in the y-position.</param>
- </member>
- <member name="M:SharpDX.Rectangle.Inflate(System.Int32,System.Int32)">
- <summary>Pushes the edges of the rectangle out by the horizontal and vertical values specified.</summary>
- <param name="horizontalAmount">Value to push the sides out by.</param>
- <param name="verticalAmount">Value to push the top and bottom out by.</param>
- </member>
- <member name="M:SharpDX.Rectangle.Contains(System.Int32,System.Int32)">
- <summary>Determines whether this rectangle contains a specified point represented by its x- and y-coordinates.</summary>
- <param name="x">The x-coordinate of the specified point.</param>
- <param name="y">The y-coordinate of the specified point.</param>
- </member>
- <member name="M:SharpDX.Rectangle.Contains(SharpDX.Rectangle)">
- <summary>Determines whether this rectangle entirely contains a specified rectangle.</summary>
- <param name="value">The rectangle to evaluate.</param>
- </member>
- <member name="M:SharpDX.Rectangle.Contains(SharpDX.Rectangle@,System.Boolean@)">
- <summary>Determines whether this rectangle entirely contains a specified rectangle.</summary>
- <param name="value">The rectangle to evaluate.</param>
- <param name="result">[OutAttribute] On exit, is true if this rectangle entirely contains the specified rectangle, or false if not.</param>
- </member>
- <member name="M:SharpDX.Rectangle.Contains(System.Single,System.Single)">
- <summary>
- Checks, if specified point is inside <see cref="T:SharpDX.Rectangle"/>.
- </summary>
- <param name="x">X point coordinate.</param>
- <param name="y">Y point coordinate.</param>
- <returns><c>true</c> if point is inside <see cref="T:SharpDX.Rectangle"/>, otherwise <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Rectangle.Intersects(SharpDX.Rectangle)">
- <summary>Determines whether a specified rectangle intersects with this rectangle.</summary>
- <param name="value">The rectangle to evaluate.</param>
- </member>
- <member name="M:SharpDX.Rectangle.Intersects(SharpDX.Rectangle@,System.Boolean@)">
- <summary>
- Determines whether a specified rectangle intersects with this rectangle.
- </summary>
- <param name="value">The rectangle to evaluate</param>
- <param name="result">[OutAttribute] true if the specified rectangle intersects with this one; false otherwise.</param>
- </member>
- <member name="M:SharpDX.Rectangle.Intersect(SharpDX.Rectangle,SharpDX.Rectangle)">
- <summary>
- Creates a rectangle defining the area where one rectangle overlaps with another rectangle.
- </summary>
- <param name="value1">The first rectangle to compare.</param>
- <param name="value2">The second rectangle to compare.</param>
- <returns>The intersection rectangle.</returns>
- </member>
- <member name="M:SharpDX.Rectangle.Intersect(SharpDX.Rectangle@,SharpDX.Rectangle@,SharpDX.Rectangle@)">
- <summary>Creates a rectangle defining the area where one rectangle overlaps with another rectangle.</summary>
- <param name="value1">The first rectangle to compare.</param>
- <param name="value2">The second rectangle to compare.</param>
- <param name="result">[OutAttribute] The area where the two first parameters overlap.</param>
- </member>
- <member name="M:SharpDX.Rectangle.Union(SharpDX.Rectangle,SharpDX.Rectangle)">
- <summary>
- Creates a new rectangle that exactly contains two other rectangles.
- </summary>
- <param name="value1">The first rectangle to contain.</param>
- <param name="value2">The second rectangle to contain.</param>
- <returns>The union rectangle.</returns>
- </member>
- <member name="M:SharpDX.Rectangle.Union(SharpDX.Rectangle@,SharpDX.Rectangle@,SharpDX.Rectangle@)">
- <summary>
- Creates a new rectangle that exactly contains two other rectangles.
- </summary>
- <param name="value1">The first rectangle to contain.</param>
- <param name="value2">The second rectangle to contain.</param>
- <param name="result">[OutAttribute] The rectangle that must be the union of the first two rectangles.</param>
- </member>
- <member name="M:SharpDX.Rectangle.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Rectangle.Equals(SharpDX.Rectangle@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Rectangle"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Rectangle"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Rectangle"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Rectangle.Equals(SharpDX.Rectangle)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Rectangle"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Rectangle"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Rectangle"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Rectangle.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Rectangle.op_Equality(SharpDX.Rectangle,SharpDX.Rectangle)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:SharpDX.Rectangle.op_Inequality(SharpDX.Rectangle,SharpDX.Rectangle)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:SharpDX.Rectangle.op_Implicit(SharpDX.Rectangle)~SharpDX.Mathematics.Interop.RawRectangle">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Rectangle"/> to <see cref="T:SharpDX.Mathematics.Interop.RawRectangle"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Rectangle.op_Implicit(SharpDX.Mathematics.Interop.RawRectangle)~SharpDX.Rectangle">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawRectangle"/> to <see cref="T:SharpDX.Rectangle"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Rectangle.op_Implicit(SharpDX.Rectangle)~SharpDX.Mathematics.Interop.RawBox">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Rectangle"/> to <see cref="T:SharpDX.Mathematics.Interop.RawRectangle"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Rectangle.op_Implicit(SharpDX.Mathematics.Interop.RawBox)~SharpDX.Rectangle">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawRectangle"/> to <see cref="T:SharpDX.Rectangle"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.RectangleF">
- <summary>
- Define a RectangleF. This structure is slightly different from System.Drawing.RectangleF as it is
- internally storing Left,Top,Right,Bottom instead of Left,Top,Width,Height.
- </summary>
- </member>
- <member name="F:SharpDX.RectangleF.Left">
- <summary>
- The left.
- </summary>
- </member>
- <member name="F:SharpDX.RectangleF.Top">
- <summary>
- The top.
- </summary>
- </member>
- <member name="F:SharpDX.RectangleF.Right">
- <summary>
- The right.
- </summary>
- </member>
- <member name="F:SharpDX.RectangleF.Bottom">
- <summary>
- The bottom.
- </summary>
- </member>
- <member name="F:SharpDX.RectangleF.Empty">
- <summary>
- An empty rectangle.
- </summary>
- </member>
- <member name="F:SharpDX.RectangleF.Infinite">
- <summary>
- An infinite rectangle. See remarks.
- </summary>
- <remarks>
- http://msdn.microsoft.com/en-us/library/windows/desktop/dd372261%28v=vs.85%29.aspx
- Any properties that involve computations, like <see cref="P:SharpDX.RectangleF.Center"/>, <see cref="P:SharpDX.RectangleF.Width"/> or <see cref="P:SharpDX.RectangleF.Height"/>
- may return incorrect results - <see cref="F:System.Single.NaN"/>.
- </remarks>
- </member>
- <member name="M:SharpDX.RectangleF.#ctor(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.RectangleF"/> struct.
- </summary>
- <param name="x">The left.</param>
- <param name="y">The top.</param>
- <param name="width">The width.</param>
- <param name="height">The height.</param>
- </member>
- <member name="P:SharpDX.RectangleF.X">
- <summary>
- Gets or sets the X position.
- </summary>
- <value>The X position.</value>
- </member>
- <member name="P:SharpDX.RectangleF.Y">
- <summary>
- Gets or sets the Y position.
- </summary>
- <value>The Y position.</value>
- </member>
- <member name="P:SharpDX.RectangleF.Width">
- <summary>
- Gets or sets the width.
- </summary>
- <value>The width.</value>
- </member>
- <member name="P:SharpDX.RectangleF.Height">
- <summary>
- Gets or sets the height.
- </summary>
- <value>The height.</value>
- </member>
- <member name="P:SharpDX.RectangleF.Location">
- <summary>
- Gets or sets the location.
- </summary>
- <value>
- The location.
- </value>
- </member>
- <member name="P:SharpDX.RectangleF.Center">
- <summary>
- Gets the Point that specifies the center of the rectangle.
- </summary>
- <value>
- The center.
- </value>
- </member>
- <member name="P:SharpDX.RectangleF.IsEmpty">
- <summary>
- Gets a value that indicates whether the rectangle is empty.
- </summary>
- <value>
- <c>true</c> if [is empty]; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:SharpDX.RectangleF.Size">
- <summary>
- Gets or sets the size of the rectangle.
- </summary>
- <value>The size of the rectangle.</value>
- </member>
- <member name="P:SharpDX.RectangleF.TopLeft">
- <summary>
- Gets the position of the top-left corner of the rectangle.
- </summary>
- <value>The top-left corner of the rectangle.</value>
- </member>
- <member name="P:SharpDX.RectangleF.TopRight">
- <summary>
- Gets the position of the top-right corner of the rectangle.
- </summary>
- <value>The top-right corner of the rectangle.</value>
- </member>
- <member name="P:SharpDX.RectangleF.BottomLeft">
- <summary>
- Gets the position of the bottom-left corner of the rectangle.
- </summary>
- <value>The bottom-left corner of the rectangle.</value>
- </member>
- <member name="P:SharpDX.RectangleF.BottomRight">
- <summary>
- Gets the position of the bottom-right corner of the rectangle.
- </summary>
- <value>The bottom-right corner of the rectangle.</value>
- </member>
- <member name="M:SharpDX.RectangleF.Offset(SharpDX.Point)">
- <summary>Changes the position of the rectangle.</summary>
- <param name="amount">The values to adjust the position of the rectangle by.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Offset(SharpDX.Vector2)">
- <summary>Changes the position of the rectangle.</summary>
- <param name="amount">The values to adjust the position of the rectangle by.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Offset(System.Single,System.Single)">
- <summary>Changes the position of the rectangle.</summary>
- <param name="offsetX">Change in the x-position.</param>
- <param name="offsetY">Change in the y-position.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Inflate(System.Single,System.Single)">
- <summary>Pushes the edges of the rectangle out by the horizontal and vertical values specified.</summary>
- <param name="horizontalAmount">Value to push the sides out by.</param>
- <param name="verticalAmount">Value to push the top and bottom out by.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Contains(SharpDX.Vector2@,System.Boolean@)">
- <summary>Determines whether this rectangle contains a specified Point.</summary>
- <param name="value">The Point to evaluate.</param>
- <param name="result">[OutAttribute] true if the specified Point is contained within this rectangle; false otherwise.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Contains(SharpDX.Rectangle)">
- <summary>Determines whether this rectangle entirely contains a specified rectangle.</summary>
- <param name="value">The rectangle to evaluate.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Contains(SharpDX.RectangleF@,System.Boolean@)">
- <summary>Determines whether this rectangle entirely contains a specified rectangle.</summary>
- <param name="value">The rectangle to evaluate.</param>
- <param name="result">[OutAttribute] On exit, is true if this rectangle entirely contains the specified rectangle, or false if not.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Contains(System.Single,System.Single)">
- <summary>
- Checks, if specified point is inside <see cref="T:SharpDX.RectangleF"/>.
- </summary>
- <param name="x">X point coordinate.</param>
- <param name="y">Y point coordinate.</param>
- <returns><c>true</c> if point is inside <see cref="T:SharpDX.RectangleF"/>, otherwise <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.RectangleF.Contains(SharpDX.Vector2)">
- <summary>
- Checks, if specified <see cref="T:SharpDX.Vector2"/> is inside <see cref="T:SharpDX.RectangleF"/>.
- </summary>
- <param name="vector2D">Coordinate <see cref="T:SharpDX.Vector2"/>.</param>
- <returns><c>true</c> if <see cref="T:SharpDX.Vector2"/> is inside <see cref="T:SharpDX.RectangleF"/>, otherwise <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.RectangleF.Contains(SharpDX.Point)">
- <summary>
- Checks, if specified <see cref="T:SharpDX.Point"/> is inside <see cref="T:SharpDX.RectangleF"/>.
- </summary>
- <param name="point">Coordinate <see cref="T:SharpDX.Point"/>.</param>
- <returns><c>true</c> if <see cref="T:SharpDX.Point"/> is inside <see cref="T:SharpDX.RectangleF"/>, otherwise <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.RectangleF.Intersects(SharpDX.RectangleF)">
- <summary>Determines whether a specified rectangle intersects with this rectangle.</summary>
- <param name="value">The rectangle to evaluate.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Intersects(SharpDX.RectangleF@,System.Boolean@)">
- <summary>
- Determines whether a specified rectangle intersects with this rectangle.
- </summary>
- <param name="value">The rectangle to evaluate</param>
- <param name="result">[OutAttribute] true if the specified rectangle intersects with this one; false otherwise.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Intersect(SharpDX.RectangleF,SharpDX.RectangleF)">
- <summary>
- Creates a rectangle defining the area where one rectangle overlaps with another rectangle.
- </summary>
- <param name="value1">The first Rectangle to compare.</param>
- <param name="value2">The second Rectangle to compare.</param>
- <returns>The intersection rectangle.</returns>
- </member>
- <member name="M:SharpDX.RectangleF.Intersect(SharpDX.RectangleF@,SharpDX.RectangleF@,SharpDX.RectangleF@)">
- <summary>Creates a rectangle defining the area where one rectangle overlaps with another rectangle.</summary>
- <param name="value1">The first rectangle to compare.</param>
- <param name="value2">The second rectangle to compare.</param>
- <param name="result">[OutAttribute] The area where the two first parameters overlap.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Union(SharpDX.RectangleF,SharpDX.RectangleF)">
- <summary>
- Creates a new rectangle that exactly contains two other rectangles.
- </summary>
- <param name="value1">The first rectangle to contain.</param>
- <param name="value2">The second rectangle to contain.</param>
- <returns>The union rectangle.</returns>
- </member>
- <member name="M:SharpDX.RectangleF.Union(SharpDX.RectangleF@,SharpDX.RectangleF@,SharpDX.RectangleF@)">
- <summary>
- Creates a new rectangle that exactly contains two other rectangles.
- </summary>
- <param name="value1">The first rectangle to contain.</param>
- <param name="value2">The second rectangle to contain.</param>
- <param name="result">[OutAttribute] The rectangle that must be the union of the first two rectangles.</param>
- </member>
- <member name="M:SharpDX.RectangleF.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.RectangleF.Equals(SharpDX.RectangleF@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.RectangleF"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.RectangleF"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.RectangleF"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.RectangleF.Equals(SharpDX.RectangleF)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.RectangleF"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.RectangleF"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.RectangleF"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.RectangleF.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.RectangleF.op_Equality(SharpDX.RectangleF,SharpDX.RectangleF)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:SharpDX.RectangleF.op_Inequality(SharpDX.RectangleF,SharpDX.RectangleF)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:SharpDX.RectangleF.op_Explicit(SharpDX.RectangleF)~SharpDX.Rectangle">
- <summary>
- Performs an explicit conversion to <see cref="T:SharpDX.Rectangle"/> structure.
- </summary>
- <remarks>Performs direct float to int conversion, any fractional data is truncated.</remarks>
- <param name="value">The source <see cref="T:SharpDX.RectangleF"/> value.</param>
- <returns>A converted <see cref="T:SharpDX.Rectangle"/> structure.</returns>
- </member>
- <member name="M:SharpDX.RectangleF.op_Implicit(SharpDX.RectangleF)~SharpDX.Mathematics.Interop.RawRectangle">
- <summary>
- Performs an explicit conversion to <see cref="T:SharpDX.Rectangle"/> structure.
- </summary>
- <remarks>Performs direct float to int conversion, any fractional data is truncated.</remarks>
- <param name="value">The source <see cref="T:SharpDX.Mathematics.Interop.RawRectangle"/> value.</param>
- <returns>A converted <see cref="T:SharpDX.Rectangle"/> structure.</returns>
- </member>
- <member name="M:SharpDX.RectangleF.op_Implicit(SharpDX.RectangleF)~SharpDX.Mathematics.Interop.RawRectangleF">
- <summary>
- Performs an explicit conversion to <see cref="T:SharpDX.Mathematics.Interop.RawRectangleF"/> structure.
- </summary>
- <remarks>Performs direct float to int conversion, any fractional data is truncated.</remarks>
- <param name="value">The source <see cref="T:SharpDX.RectangleF"/> value.</param>
- <returns>A converted <see cref="T:SharpDX.Rectangle"/> structure.</returns>
- </member>
- <member name="T:SharpDX.Vector2">
- <summary>
- Represents a two dimensional mathematical vector.
- </summary>
- </member>
- <member name="F:SharpDX.Vector2.SizeInBytes">
- <summary>
- The size of the <see cref="T:SharpDX.Vector2"/> type, in bytes.
- </summary>
- </member>
- <member name="F:SharpDX.Vector2.Zero">
- <summary>
- A <see cref="T:SharpDX.Vector2"/> with all of its components set to zero.
- </summary>
- </member>
- <member name="F:SharpDX.Vector2.UnitX">
- <summary>
- The X unit <see cref="T:SharpDX.Vector2"/> (1, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Vector2.UnitY">
- <summary>
- The Y unit <see cref="T:SharpDX.Vector2"/> (0, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Vector2.One">
- <summary>
- A <see cref="T:SharpDX.Vector2"/> with all of its components set to one.
- </summary>
- </member>
- <member name="F:SharpDX.Vector2.X">
- <summary>
- The X component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Vector2.Y">
- <summary>
- The Y component of the vector.
- </summary>
- </member>
- <member name="M:SharpDX.Vector2.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector2"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Vector2.#ctor(System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector2"/> struct.
- </summary>
- <param name="x">Initial value for the X component of the vector.</param>
- <param name="y">Initial value for the Y component of the vector.</param>
- </member>
- <member name="M:SharpDX.Vector2.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector2"/> struct.
- </summary>
- <param name="values">The values to assign to the X and Y components of the vector. This must be an array with two elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than two elements.</exception>
- </member>
- <member name="P:SharpDX.Vector2.IsNormalized">
- <summary>
- Gets a value indicting whether this instance is normalized.
- </summary>
- </member>
- <member name="P:SharpDX.Vector2.IsZero">
- <summary>
- Gets a value indicting whether this vector is zero
- </summary>
- </member>
- <member name="P:SharpDX.Vector2.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the X or Y component, depending on the index.</value>
- <param name="index">The index of the component to access. Use 0 for the X component and 1 for the Y component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 1].</exception>
- </member>
- <member name="M:SharpDX.Vector2.Length">
- <summary>
- Calculates the length of the vector.
- </summary>
- <returns>The length of the vector.</returns>
- <remarks>
- <see cref="M:SharpDX.Vector2.LengthSquared"/> may be preferred when only the relative length is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.LengthSquared">
- <summary>
- Calculates the squared length of the vector.
- </summary>
- <returns>The squared length of the vector.</returns>
- <remarks>
- This method may be preferred to <see cref="M:SharpDX.Vector2.Length"/> when only a relative length is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.Normalize">
- <summary>
- Converts the vector into a unit vector.
- </summary>
- </member>
- <member name="M:SharpDX.Vector2.ToArray">
- <summary>
- Creates an array containing the elements of the vector.
- </summary>
- <returns>A two-element array containing the components of the vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Add(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Adds two vectors.
- </summary>
- <param name="left">The first vector to add.</param>
- <param name="right">The second vector to add.</param>
- <param name="result">When the method completes, contains the sum of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector2.Add(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Adds two vectors.
- </summary>
- <param name="left">The first vector to add.</param>
- <param name="right">The second vector to add.</param>
- <returns>The sum of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Add(SharpDX.Vector2@,System.Single@,SharpDX.Vector2@)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be added to elements</param>
- <param name="result">The vector with added scalar for each element.</param>
- </member>
- <member name="M:SharpDX.Vector2.Add(SharpDX.Vector2,System.Single)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be added to elements</param>
- <returns>The vector with added scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Subtract(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name="left">The first vector to subtract.</param>
- <param name="right">The second vector to subtract.</param>
- <param name="result">When the method completes, contains the difference of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector2.Subtract(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name="left">The first vector to subtract.</param>
- <param name="right">The second vector to subtract.</param>
- <returns>The difference of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Subtract(SharpDX.Vector2@,System.Single@,SharpDX.Vector2@)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be subtraced from elements</param>
- <param name="result">The vector with subtracted scalar for each element.</param>
- </member>
- <member name="M:SharpDX.Vector2.Subtract(SharpDX.Vector2,System.Single)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be subtraced from elements</param>
- <returns>The vector with subtracted scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Subtract(System.Single@,SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The scalar value to be subtraced from elements</param>
- <param name="right">The input vector</param>
- <param name="result">The vector with subtracted scalar for each element.</param>
- </member>
- <member name="M:SharpDX.Vector2.Subtract(System.Single,SharpDX.Vector2)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The scalar value to be subtraced from elements</param>
- <param name="right">The input vector</param>
- <returns>The vector with subtracted scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Multiply(SharpDX.Vector2@,System.Single,SharpDX.Vector2@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Vector2.Multiply(SharpDX.Vector2,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Multiply(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Multiplies a vector with another by performing component-wise multiplication.
- </summary>
- <param name="left">The first vector to multiply.</param>
- <param name="right">The second vector to multiply.</param>
- <param name="result">When the method completes, contains the multiplied vector.</param>
- </member>
- <member name="M:SharpDX.Vector2.Multiply(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Multiplies a vector with another by performing component-wise multiplication.
- </summary>
- <param name="left">The first vector to multiply.</param>
- <param name="right">The second vector to multiply.</param>
- <returns>The multiplied vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Divide(SharpDX.Vector2@,System.Single,SharpDX.Vector2@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Vector2.Divide(SharpDX.Vector2,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Divide(System.Single,SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="value">The vector to scale.</param>
- <param name="result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Vector2.Divide(System.Single,SharpDX.Vector2)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Negate(SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name="value">The vector to negate.</param>
- <param name="result">When the method completes, contains a vector facing in the opposite direction.</param>
- </member>
- <member name="M:SharpDX.Vector2.Negate(SharpDX.Vector2)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name="value">The vector to negate.</param>
- <returns>A vector facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Barycentric(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@,System.Single,System.Single,SharpDX.Vector2@)">
- <summary>
- Returns a <see cref="T:SharpDX.Vector2"/> containing the 2D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle.
- </summary>
- <param name="value1">A <see cref="T:SharpDX.Vector2"/> containing the 2D Cartesian coordinates of vertex 1 of the triangle.</param>
- <param name="value2">A <see cref="T:SharpDX.Vector2"/> containing the 2D Cartesian coordinates of vertex 2 of the triangle.</param>
- <param name="value3">A <see cref="T:SharpDX.Vector2"/> containing the 2D Cartesian coordinates of vertex 3 of the triangle.</param>
- <param name="amount1">Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in <paramref name="value2"/>).</param>
- <param name="amount2">Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in <paramref name="value3"/>).</param>
- <param name="result">When the method completes, contains the 2D Cartesian coordinates of the specified point.</param>
- </member>
- <member name="M:SharpDX.Vector2.Barycentric(SharpDX.Vector2,SharpDX.Vector2,SharpDX.Vector2,System.Single,System.Single)">
- <summary>
- Returns a <see cref="T:SharpDX.Vector2"/> containing the 2D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 2D triangle.
- </summary>
- <param name="value1">A <see cref="T:SharpDX.Vector2"/> containing the 2D Cartesian coordinates of vertex 1 of the triangle.</param>
- <param name="value2">A <see cref="T:SharpDX.Vector2"/> containing the 2D Cartesian coordinates of vertex 2 of the triangle.</param>
- <param name="value3">A <see cref="T:SharpDX.Vector2"/> containing the 2D Cartesian coordinates of vertex 3 of the triangle.</param>
- <param name="amount1">Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in <paramref name="value2"/>).</param>
- <param name="amount2">Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in <paramref name="value3"/>).</param>
- <returns>A new <see cref="T:SharpDX.Vector2"/> containing the 2D Cartesian coordinates of the specified point.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Clamp(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <param name="result">When the method completes, contains the clamped value.</param>
- </member>
- <member name="M:SharpDX.Vector2.Clamp(SharpDX.Vector2,SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <returns>The clamped value.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Saturate">
- <summary>
- Saturates this instance in the range [0,1]
- </summary>
- </member>
- <member name="M:SharpDX.Vector2.Distance(SharpDX.Vector2@,SharpDX.Vector2@,System.Single@)">
- <summary>
- Calculates the distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <param name="result">When the method completes, contains the distance between the two vectors.</param>
- <remarks>
- <see cref="M:SharpDX.Vector2.DistanceSquared(SharpDX.Vector2@,SharpDX.Vector2@,System.Single@)"/> may be preferred when only the relative distance is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.Distance(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Calculates the distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <returns>The distance between the two vectors.</returns>
- <remarks>
- <see cref="M:SharpDX.Vector2.DistanceSquared(SharpDX.Vector2,SharpDX.Vector2)"/> may be preferred when only the relative distance is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.DistanceSquared(SharpDX.Vector2@,SharpDX.Vector2@,System.Single@)">
- <summary>
- Calculates the squared distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector</param>
- <param name="result">When the method completes, contains the squared distance between the two vectors.</param>
- <remarks>Distance squared is the value before taking the square root.
- Distance squared can often be used in place of distance if relative comparisons are being made.
- For example, consider three points A, B, and C. To determine whether B or C is further from A,
- compare the distance between A and B to the distance between A and C. Calculating the two distances
- involves two square roots, which are computationally expensive. However, using distance squared
- provides the same information and avoids calculating two square roots.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.DistanceSquared(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Calculates the squared distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <returns>The squared distance between the two vectors.</returns>
- <remarks>Distance squared is the value before taking the square root.
- Distance squared can often be used in place of distance if relative comparisons are being made.
- For example, consider three points A, B, and C. To determine whether B or C is further from A,
- compare the distance between A and B to the distance between A and C. Calculating the two distances
- involves two square roots, which are computationally expensive. However, using distance squared
- provides the same information and avoids calculating two square roots.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.Dot(SharpDX.Vector2@,SharpDX.Vector2@,System.Single@)">
- <summary>
- Calculates the dot product of two vectors.
- </summary>
- <param name="left">First source vector.</param>
- <param name="right">Second source vector.</param>
- <param name="result">When the method completes, contains the dot product of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector2.Dot(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Calculates the dot product of two vectors.
- </summary>
- <param name="left">First source vector.</param>
- <param name="right">Second source vector.</param>
- <returns>The dot product of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Normalize(SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Converts the vector into a unit vector.
- </summary>
- <param name="value">The vector to normalize.</param>
- <param name="result">When the method completes, contains the normalized vector.</param>
- </member>
- <member name="M:SharpDX.Vector2.Normalize(SharpDX.Vector2)">
- <summary>
- Converts the vector into a unit vector.
- </summary>
- <param name="value">The vector to normalize.</param>
- <returns>The normalized vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Lerp(SharpDX.Vector2@,SharpDX.Vector2@,System.Single,SharpDX.Vector2@)">
- <summary>
- Performs a linear interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two vectors.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.Lerp(SharpDX.Vector2,SharpDX.Vector2,System.Single)">
- <summary>
- Performs a linear interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two vectors.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.SmoothStep(SharpDX.Vector2@,SharpDX.Vector2@,System.Single,SharpDX.Vector2@)">
- <summary>
- Performs a cubic interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector2.SmoothStep(SharpDX.Vector2,SharpDX.Vector2,System.Single)">
- <summary>
- Performs a cubic interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Hermite(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@,System.Single,SharpDX.Vector2@)">
- <summary>
- Performs a Hermite spline interpolation.
- </summary>
- <param name="value1">First source position vector.</param>
- <param name="tangent1">First source tangent vector.</param>
- <param name="value2">Second source position vector.</param>
- <param name="tangent2">Second source tangent vector.</param>
- <param name="amount">Weighting factor.</param>
- <param name="result">When the method completes, contains the result of the Hermite spline interpolation.</param>
- </member>
- <member name="M:SharpDX.Vector2.Hermite(SharpDX.Vector2,SharpDX.Vector2,SharpDX.Vector2,SharpDX.Vector2,System.Single)">
- <summary>
- Performs a Hermite spline interpolation.
- </summary>
- <param name="value1">First source position vector.</param>
- <param name="tangent1">First source tangent vector.</param>
- <param name="value2">Second source position vector.</param>
- <param name="tangent2">Second source tangent vector.</param>
- <param name="amount">Weighting factor.</param>
- <returns>The result of the Hermite spline interpolation.</returns>
- </member>
- <member name="M:SharpDX.Vector2.CatmullRom(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@,System.Single,SharpDX.Vector2@)">
- <summary>
- Performs a Catmull-Rom interpolation using the specified positions.
- </summary>
- <param name="value1">The first position in the interpolation.</param>
- <param name="value2">The second position in the interpolation.</param>
- <param name="value3">The third position in the interpolation.</param>
- <param name="value4">The fourth position in the interpolation.</param>
- <param name="amount">Weighting factor.</param>
- <param name="result">When the method completes, contains the result of the Catmull-Rom interpolation.</param>
- </member>
- <member name="M:SharpDX.Vector2.CatmullRom(SharpDX.Vector2,SharpDX.Vector2,SharpDX.Vector2,SharpDX.Vector2,System.Single)">
- <summary>
- Performs a Catmull-Rom interpolation using the specified positions.
- </summary>
- <param name="value1">The first position in the interpolation.</param>
- <param name="value2">The second position in the interpolation.</param>
- <param name="value3">The third position in the interpolation.</param>
- <param name="value4">The fourth position in the interpolation.</param>
- <param name="amount">Weighting factor.</param>
- <returns>A vector that is the result of the Catmull-Rom interpolation.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Max(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Returns a vector containing the largest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <param name="result">When the method completes, contains an new vector composed of the largest components of the source vectors.</param>
- </member>
- <member name="M:SharpDX.Vector2.Max(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Returns a vector containing the largest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <returns>A vector containing the largest components of the source vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Min(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <param name="result">When the method completes, contains an new vector composed of the smallest components of the source vectors.</param>
- </member>
- <member name="M:SharpDX.Vector2.Min(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <returns>A vector containing the smallest components of the source vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Reflect(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@)">
- <summary>
- Returns the reflection of a vector off a surface that has the specified normal.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="normal">Normal of the surface.</param>
- <param name="result">When the method completes, contains the reflected vector.</param>
- <remarks>Reflect only gives the direction of a reflection off a surface, it does not determine
- whether the original vector was close enough to the surface to hit it.</remarks>
- </member>
- <member name="M:SharpDX.Vector2.Reflect(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Returns the reflection of a vector off a surface that has the specified normal.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="normal">Normal of the surface.</param>
- <returns>The reflected vector.</returns>
- <remarks>Reflect only gives the direction of a reflection off a surface, it does not determine
- whether the original vector was close enough to the surface to hit it.</remarks>
- </member>
- <member name="M:SharpDX.Vector2.Orthogonalize(SharpDX.Vector2[],SharpDX.Vector2[])">
- <summary>
- Orthogonalizes a list of vectors.
- </summary>
- <param name="destination">The list of orthogonalized vectors.</param>
- <param name="source">The list of vectors to orthogonalize.</param>
- <remarks>
- <para>Orthogonalization is the process of making all vectors orthogonal to each other. This
- means that any given vector in the list will be orthogonal to any other given vector in the
- list.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting vectors
- tend to be numerically unstable. The numeric stability decreases according to the vectors
- position in the list so that the first vector is the most stable and the last vector is the
- least stable.</para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector2.Orthonormalize(SharpDX.Vector2[],SharpDX.Vector2[])">
- <summary>
- Orthonormalizes a list of vectors.
- </summary>
- <param name="destination">The list of orthonormalized vectors.</param>
- <param name="source">The list of vectors to orthonormalize.</param>
- <remarks>
- <para>Orthonormalization is the process of making all vectors orthogonal to each
- other and making all vectors of unit length. This means that any given vector will
- be orthogonal to any other given vector in the list.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting vectors
- tend to be numerically unstable. The numeric stability decreases according to the vectors
- position in the list so that the first vector is the most stable and the last vector is the
- least stable.</para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector2.Transform(SharpDX.Vector2@,SharpDX.Quaternion@,SharpDX.Vector2@)">
- <summary>
- Transforms a 2D vector by the given <see cref="T:SharpDX.Quaternion"/> rotation.
- </summary>
- <param name="vector">The vector to rotate.</param>
- <param name="rotation">The <see cref="T:SharpDX.Quaternion"/> rotation to apply.</param>
- <param name="result">When the method completes, contains the transformed <see cref="T:SharpDX.Vector4"/>.</param>
- </member>
- <member name="M:SharpDX.Vector2.Transform(SharpDX.Vector2,SharpDX.Quaternion)">
- <summary>
- Transforms a 2D vector by the given <see cref="T:SharpDX.Quaternion"/> rotation.
- </summary>
- <param name="vector">The vector to rotate.</param>
- <param name="rotation">The <see cref="T:SharpDX.Quaternion"/> rotation to apply.</param>
- <returns>The transformed <see cref="T:SharpDX.Vector4"/>.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Transform(SharpDX.Vector2[],SharpDX.Quaternion@,SharpDX.Vector2[])">
- <summary>
- Transforms an array of vectors by the given <see cref="T:SharpDX.Quaternion"/> rotation.
- </summary>
- <param name="source">The array of vectors to transform.</param>
- <param name="rotation">The <see cref="T:SharpDX.Quaternion"/> rotation to apply.</param>
- <param name="destination">The array for which the transformed vectors are stored.
- This array may be the same array as <paramref name="source"/>.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector2.Transform(SharpDX.Vector2@,SharpDX.Matrix@,SharpDX.Vector4@)">
- <summary>
- Transforms a 2D vector by the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="result">When the method completes, contains the transformed <see cref="T:SharpDX.Vector4"/>.</param>
- </member>
- <member name="M:SharpDX.Vector2.Transform(SharpDX.Vector2,SharpDX.Matrix)">
- <summary>
- Transforms a 2D vector by the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <returns>The transformed <see cref="T:SharpDX.Vector4"/>.</returns>
- </member>
- <member name="M:SharpDX.Vector2.Transform(SharpDX.Vector2[],SharpDX.Matrix@,SharpDX.Vector4[])">
- <summary>
- Transforms an array of 2D vectors by the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="source">The array of vectors to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="destination">The array for which the transformed vectors are stored.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector2.TransformCoordinate(SharpDX.Vector2@,SharpDX.Matrix@,SharpDX.Vector2@)">
- <summary>
- Performs a coordinate transformation using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="coordinate">The coordinate vector to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="result">When the method completes, contains the transformed coordinates.</param>
- <remarks>
- A coordinate transform performs the transformation with the assumption that the w component
- is one. The four dimensional vector obtained from the transformation operation has each
- component in the vector divided by the w component. This forces the w component to be one and
- therefore makes the vector homogeneous. The homogeneous vector is often preferred when working
- with coordinates as the w component can safely be ignored.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.TransformCoordinate(SharpDX.Vector2,SharpDX.Matrix)">
- <summary>
- Performs a coordinate transformation using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="coordinate">The coordinate vector to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <returns>The transformed coordinates.</returns>
- <remarks>
- A coordinate transform performs the transformation with the assumption that the w component
- is one. The four dimensional vector obtained from the transformation operation has each
- component in the vector divided by the w component. This forces the w component to be one and
- therefore makes the vector homogeneous. The homogeneous vector is often preferred when working
- with coordinates as the w component can safely be ignored.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.TransformCoordinate(SharpDX.Vector2[],SharpDX.Matrix@,SharpDX.Vector2[])">
- <summary>
- Performs a coordinate transformation on an array of vectors using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="source">The array of coordinate vectors to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="destination">The array for which the transformed vectors are stored.
- This array may be the same array as <paramref name="source"/>.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- <remarks>
- A coordinate transform performs the transformation with the assumption that the w component
- is one. The four dimensional vector obtained from the transformation operation has each
- component in the vector divided by the w component. This forces the w component to be one and
- therefore makes the vector homogeneous. The homogeneous vector is often preferred when working
- with coordinates as the w component can safely be ignored.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.TransformNormal(SharpDX.Vector2@,SharpDX.Matrix@,SharpDX.Vector2@)">
- <summary>
- Performs a normal transformation using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="normal">The normal vector to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="result">When the method completes, contains the transformed normal.</param>
- <remarks>
- A normal transform performs the transformation with the assumption that the w component
- is zero. This causes the fourth row and fourth column of the matrix to be unused. The
- end result is a vector that is not translated, but all other transformation properties
- apply. This is often preferred for normal vectors as normals purely represent direction
- rather than location because normal vectors should not be translated.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.TransformNormal(SharpDX.Vector2,SharpDX.Matrix)">
- <summary>
- Performs a normal transformation using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="normal">The normal vector to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <returns>The transformed normal.</returns>
- <remarks>
- A normal transform performs the transformation with the assumption that the w component
- is zero. This causes the fourth row and fourth column of the matrix to be unused. The
- end result is a vector that is not translated, but all other transformation properties
- apply. This is often preferred for normal vectors as normals purely represent direction
- rather than location because normal vectors should not be translated.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.TransformNormal(SharpDX.Vector2[],SharpDX.Matrix@,SharpDX.Vector2[])">
- <summary>
- Performs a normal transformation on an array of vectors using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="source">The array of normal vectors to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="destination">The array for which the transformed vectors are stored.
- This array may be the same array as <paramref name="source"/>.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- <remarks>
- A normal transform performs the transformation with the assumption that the w component
- is zero. This causes the fourth row and fourth column of the matrix to be unused. The
- end result is a vector that is not translated, but all other transformation properties
- apply. This is often preferred for normal vectors as normals purely represent direction
- rather than location because normal vectors should not be translated.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector2.op_Addition(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Adds two vectors.
- </summary>
- <param name="left">The first vector to add.</param>
- <param name="right">The second vector to add.</param>
- <returns>The sum of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Multiply(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Multiplies a vector with another by performing component-wise multiplication equivalent to <see cref="M:SharpDX.Vector2.Multiply(SharpDX.Vector2@,SharpDX.Vector2@,SharpDX.Vector2@)"/>.
- </summary>
- <param name="left">The first vector to multiply.</param>
- <param name="right">The second vector to multiply.</param>
- <returns>The multiplication of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_UnaryPlus(SharpDX.Vector2)">
- <summary>
- Assert a vector (return it unchanged).
- </summary>
- <param name="value">The vector to assert (unchanged).</param>
- <returns>The asserted (unchanged) vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Subtraction(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name="left">The first vector to subtract.</param>
- <param name="right">The second vector to subtract.</param>
- <returns>The difference of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_UnaryNegation(SharpDX.Vector2)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name="value">The vector to negate.</param>
- <returns>A vector facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Multiply(System.Single,SharpDX.Vector2)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Multiply(SharpDX.Vector2,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Division(SharpDX.Vector2,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Division(System.Single,SharpDX.Vector2)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="value">The vector to scale.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Division(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Addition(SharpDX.Vector2,System.Single)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be added on elements</param>
- <returns>The vector with added scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Addition(System.Single,SharpDX.Vector2)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be added on elements</param>
- <returns>The vector with added scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Subtraction(SharpDX.Vector2,System.Single)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be subtraced from elements</param>
- <returns>The vector with subtraced scalar from each element.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Subtraction(System.Single,SharpDX.Vector2)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be subtraced from elements</param>
- <returns>The vector with subtraced scalar from each element.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Equality(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Inequality(SharpDX.Vector2,SharpDX.Vector2)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Explicit(SharpDX.Vector2)~SharpDX.Vector3">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector2"/> to <see cref="T:SharpDX.Vector3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Explicit(SharpDX.Vector2)~SharpDX.Vector4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector2"/> to <see cref="T:SharpDX.Vector4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Vector2.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector2.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector2.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector2.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector2.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Vector2.Equals(SharpDX.Vector2@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector2"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Vector2"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector2"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Vector2.Equals(SharpDX.Vector2)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector2"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Vector2"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector2"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Vector2.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Implicit(SharpDX.Vector2)~SharpDX.Mathematics.Interop.RawVector2">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Vector2"/> to <see cref="T:SharpDX.Mathematics.Interop.RawVector2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Vector2.op_Implicit(SharpDX.Mathematics.Interop.RawVector2)~SharpDX.Vector2">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawVector2"/> to <see cref="T:SharpDX.Vector2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.Vector3">
- <summary>
- Represents a three dimensional mathematical vector.
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.SizeInBytes">
- <summary>
- The size of the <see cref="T:SharpDX.Vector3"/> type, in bytes.
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.Zero">
- <summary>
- A <see cref="T:SharpDX.Vector3"/> with all of its components set to zero.
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.UnitX">
- <summary>
- The X unit <see cref="T:SharpDX.Vector3"/> (1, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.UnitY">
- <summary>
- The Y unit <see cref="T:SharpDX.Vector3"/> (0, 1, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.UnitZ">
- <summary>
- The Z unit <see cref="T:SharpDX.Vector3"/> (0, 0, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.One">
- <summary>
- A <see cref="T:SharpDX.Vector3"/> with all of its components set to one.
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.Up">
- <summary>
- A unit <see cref="T:SharpDX.Vector3"/> designating up (0, 1, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.Down">
- <summary>
- A unit <see cref="T:SharpDX.Vector3"/> designating down (0, -1, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.Left">
- <summary>
- A unit <see cref="T:SharpDX.Vector3"/> designating left (-1, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.Right">
- <summary>
- A unit <see cref="T:SharpDX.Vector3"/> designating right (1, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.ForwardRH">
- <summary>
- A unit <see cref="T:SharpDX.Vector3"/> designating forward in a right-handed coordinate system (0, 0, -1).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.ForwardLH">
- <summary>
- A unit <see cref="T:SharpDX.Vector3"/> designating forward in a left-handed coordinate system (0, 0, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.BackwardRH">
- <summary>
- A unit <see cref="T:SharpDX.Vector3"/> designating backward in a right-handed coordinate system (0, 0, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.BackwardLH">
- <summary>
- A unit <see cref="T:SharpDX.Vector3"/> designating backward in a left-handed coordinate system (0, 0, -1).
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.X">
- <summary>
- The X component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.Y">
- <summary>
- The Y component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Vector3.Z">
- <summary>
- The Z component of the vector.
- </summary>
- </member>
- <member name="M:SharpDX.Vector3.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector3"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Vector3.#ctor(System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector3"/> struct.
- </summary>
- <param name="x">Initial value for the X component of the vector.</param>
- <param name="y">Initial value for the Y component of the vector.</param>
- <param name="z">Initial value for the Z component of the vector.</param>
- </member>
- <member name="M:SharpDX.Vector3.#ctor(SharpDX.Vector2,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector3"/> struct.
- </summary>
- <param name="value">A vector containing the values with which to initialize the X and Y components.</param>
- <param name="z">Initial value for the Z component of the vector.</param>
- </member>
- <member name="M:SharpDX.Vector3.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector3"/> struct.
- </summary>
- <param name="values">The values to assign to the X, Y, and Z components of the vector. This must be an array with three elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than three elements.</exception>
- </member>
- <member name="P:SharpDX.Vector3.IsNormalized">
- <summary>
- Gets a value indicting whether this instance is normalized.
- </summary>
- </member>
- <member name="P:SharpDX.Vector3.IsZero">
- <summary>
- Gets a value indicting whether this vector is zero
- </summary>
- </member>
- <member name="P:SharpDX.Vector3.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the X, Y, or Z component, depending on the index.</value>
- <param name="index">The index of the component to access. Use 0 for the X component, 1 for the Y component, and 2 for the Z component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 2].</exception>
- </member>
- <member name="M:SharpDX.Vector3.Length">
- <summary>
- Calculates the length of the vector.
- </summary>
- <returns>The length of the vector.</returns>
- <remarks>
- <see cref="M:SharpDX.Vector3.LengthSquared"/> may be preferred when only the relative length is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.LengthSquared">
- <summary>
- Calculates the squared length of the vector.
- </summary>
- <returns>The squared length of the vector.</returns>
- <remarks>
- This method may be preferred to <see cref="M:SharpDX.Vector3.Length"/> when only a relative length is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.Normalize">
- <summary>
- Converts the vector into a unit vector.
- </summary>
- </member>
- <member name="M:SharpDX.Vector3.ToArray">
- <summary>
- Creates an array containing the elements of the vector.
- </summary>
- <returns>A three-element array containing the components of the vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Add(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Adds two vectors.
- </summary>
- <param name="left">The first vector to add.</param>
- <param name="right">The second vector to add.</param>
- <param name="result">When the method completes, contains the sum of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector3.Add(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Adds two vectors.
- </summary>
- <param name="left">The first vector to add.</param>
- <param name="right">The second vector to add.</param>
- <returns>The sum of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Add(SharpDX.Vector3@,System.Single@,SharpDX.Vector3@)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be added to elements</param>
- <param name="result">The vector with added scalar for each element.</param>
- </member>
- <member name="M:SharpDX.Vector3.Add(SharpDX.Vector3,System.Single)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be added to elements</param>
- <returns>The vector with added scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Subtract(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name="left">The first vector to subtract.</param>
- <param name="right">The second vector to subtract.</param>
- <param name="result">When the method completes, contains the difference of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector3.Subtract(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name="left">The first vector to subtract.</param>
- <param name="right">The second vector to subtract.</param>
- <returns>The difference of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Subtract(SharpDX.Vector3@,System.Single@,SharpDX.Vector3@)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be subtraced from elements</param>
- <param name="result">The vector with subtracted scalar for each element.</param>
- </member>
- <member name="M:SharpDX.Vector3.Subtract(SharpDX.Vector3,System.Single)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be subtraced from elements</param>
- <returns>The vector with subtracted scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Subtract(System.Single@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The scalar value to be subtraced from elements</param>
- <param name="right">The input vector.</param>
- <param name="result">The vector with subtracted scalar for each element.</param>
- </member>
- <member name="M:SharpDX.Vector3.Subtract(System.Single,SharpDX.Vector3)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The scalar value to be subtraced from elements</param>
- <param name="right">The input vector.</param>
- <returns>The vector with subtracted scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Multiply(SharpDX.Vector3@,System.Single,SharpDX.Vector3@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Vector3.Multiply(SharpDX.Vector3,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Multiply(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Multiply a vector with another by performing component-wise multiplication.
- </summary>
- <param name="left">The first vector to multiply.</param>
- <param name="right">The second vector to multiply.</param>
- <param name="result">When the method completes, contains the multiplied vector.</param>
- </member>
- <member name="M:SharpDX.Vector3.Multiply(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Multiply a vector with another by performing component-wise multiplication.
- </summary>
- <param name="left">The first vector to Multiply.</param>
- <param name="right">The second vector to multiply.</param>
- <returns>The multiplied vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Divide(SharpDX.Vector3@,System.Single,SharpDX.Vector3@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Vector3.Divide(SharpDX.Vector3,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Divide(System.Single,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="value">The vector to scale.</param>
- <param name="result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Vector3.Divide(System.Single,SharpDX.Vector3)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Negate(SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name="value">The vector to negate.</param>
- <param name="result">When the method completes, contains a vector facing in the opposite direction.</param>
- </member>
- <member name="M:SharpDX.Vector3.Negate(SharpDX.Vector3)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name="value">The vector to negate.</param>
- <returns>A vector facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Barycentric(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,System.Single,System.Single,SharpDX.Vector3@)">
- <summary>
- Returns a <see cref="T:SharpDX.Vector3"/> containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle.
- </summary>
- <param name="value1">A <see cref="T:SharpDX.Vector3"/> containing the 3D Cartesian coordinates of vertex 1 of the triangle.</param>
- <param name="value2">A <see cref="T:SharpDX.Vector3"/> containing the 3D Cartesian coordinates of vertex 2 of the triangle.</param>
- <param name="value3">A <see cref="T:SharpDX.Vector3"/> containing the 3D Cartesian coordinates of vertex 3 of the triangle.</param>
- <param name="amount1">Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in <paramref name="value2"/>).</param>
- <param name="amount2">Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in <paramref name="value3"/>).</param>
- <param name="result">When the method completes, contains the 3D Cartesian coordinates of the specified point.</param>
- </member>
- <member name="M:SharpDX.Vector3.Barycentric(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,System.Single,System.Single)">
- <summary>
- Returns a <see cref="T:SharpDX.Vector3"/> containing the 3D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 3D triangle.
- </summary>
- <param name="value1">A <see cref="T:SharpDX.Vector3"/> containing the 3D Cartesian coordinates of vertex 1 of the triangle.</param>
- <param name="value2">A <see cref="T:SharpDX.Vector3"/> containing the 3D Cartesian coordinates of vertex 2 of the triangle.</param>
- <param name="value3">A <see cref="T:SharpDX.Vector3"/> containing the 3D Cartesian coordinates of vertex 3 of the triangle.</param>
- <param name="amount1">Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in <paramref name="value2"/>).</param>
- <param name="amount2">Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in <paramref name="value3"/>).</param>
- <returns>A new <see cref="T:SharpDX.Vector3"/> containing the 3D Cartesian coordinates of the specified point.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Clamp(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <param name="result">When the method completes, contains the clamped value.</param>
- </member>
- <member name="M:SharpDX.Vector3.Clamp(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <returns>The clamped value.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Cross(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Calculates the cross product of two vectors.
- </summary>
- <param name="left">First source vector.</param>
- <param name="right">Second source vector.</param>
- <param name="result">When the method completes, contains he cross product of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector3.Cross(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Calculates the cross product of two vectors.
- </summary>
- <param name="left">First source vector.</param>
- <param name="right">Second source vector.</param>
- <returns>The cross product of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Distance(SharpDX.Vector3@,SharpDX.Vector3@,System.Single@)">
- <summary>
- Calculates the distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <param name="result">When the method completes, contains the distance between the two vectors.</param>
- <remarks>
- <see cref="M:SharpDX.Vector3.DistanceSquared(SharpDX.Vector3@,SharpDX.Vector3@,System.Single@)"/> may be preferred when only the relative distance is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.Distance(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Calculates the distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <returns>The distance between the two vectors.</returns>
- <remarks>
- <see cref="M:SharpDX.Vector3.DistanceSquared(SharpDX.Vector3,SharpDX.Vector3)"/> may be preferred when only the relative distance is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.DistanceSquared(SharpDX.Vector3@,SharpDX.Vector3@,System.Single@)">
- <summary>
- Calculates the squared distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <param name="result">When the method completes, contains the squared distance between the two vectors.</param>
- <remarks>Distance squared is the value before taking the square root.
- Distance squared can often be used in place of distance if relative comparisons are being made.
- For example, consider three points A, B, and C. To determine whether B or C is further from A,
- compare the distance between A and B to the distance between A and C. Calculating the two distances
- involves two square roots, which are computationally expensive. However, using distance squared
- provides the same information and avoids calculating two square roots.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.DistanceSquared(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Calculates the squared distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <returns>The squared distance between the two vectors.</returns>
- <remarks>Distance squared is the value before taking the square root.
- Distance squared can often be used in place of distance if relative comparisons are being made.
- For example, consider three points A, B, and C. To determine whether B or C is further from A,
- compare the distance between A and B to the distance between A and C. Calculating the two distances
- involves two square roots, which are computationally expensive. However, using distance squared
- provides the same information and avoids calculating two square roots.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.NearEqual(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Tests whether one 3D vector is near another 3D vector.
- </summary>
- <param name="left">The left vector.</param>
- <param name="right">The right vector.</param>
- <param name="epsilon">The epsilon.</param>
- <returns><c>true</c> if left and right are near another 3D, <c>false</c> otherwise</returns>
- </member>
- <member name="M:SharpDX.Vector3.NearEqual(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Tests whether one 3D vector is near another 3D vector.
- </summary>
- <param name="left">The left vector.</param>
- <param name="right">The right vector.</param>
- <param name="epsilon">The epsilon.</param>
- <returns><c>true</c> if left and right are near another 3D, <c>false</c> otherwise</returns>
- </member>
- <member name="M:SharpDX.Vector3.Dot(SharpDX.Vector3@,SharpDX.Vector3@,System.Single@)">
- <summary>
- Calculates the dot product of two vectors.
- </summary>
- <param name="left">First source vector.</param>
- <param name="right">Second source vector.</param>
- <param name="result">When the method completes, contains the dot product of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector3.Dot(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Calculates the dot product of two vectors.
- </summary>
- <param name="left">First source vector.</param>
- <param name="right">Second source vector.</param>
- <returns>The dot product of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Normalize(SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Converts the vector into a unit vector.
- </summary>
- <param name="value">The vector to normalize.</param>
- <param name="result">When the method completes, contains the normalized vector.</param>
- </member>
- <member name="M:SharpDX.Vector3.Normalize(SharpDX.Vector3)">
- <summary>
- Converts the vector into a unit vector.
- </summary>
- <param name="value">The vector to normalize.</param>
- <returns>The normalized vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Lerp(SharpDX.Vector3@,SharpDX.Vector3@,System.Single,SharpDX.Vector3@)">
- <summary>
- Performs a linear interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two vectors.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.Lerp(SharpDX.Vector3,SharpDX.Vector3,System.Single)">
- <summary>
- Performs a linear interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two vectors.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.SmoothStep(SharpDX.Vector3@,SharpDX.Vector3@,System.Single,SharpDX.Vector3@)">
- <summary>
- Performs a cubic interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector3.SmoothStep(SharpDX.Vector3,SharpDX.Vector3,System.Single)">
- <summary>
- Performs a cubic interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Hermite(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,System.Single,SharpDX.Vector3@)">
- <summary>
- Performs a Hermite spline interpolation.
- </summary>
- <param name="value1">First source position vector.</param>
- <param name="tangent1">First source tangent vector.</param>
- <param name="value2">Second source position vector.</param>
- <param name="tangent2">Second source tangent vector.</param>
- <param name="amount">Weighting factor.</param>
- <param name="result">When the method completes, contains the result of the Hermite spline interpolation.</param>
- </member>
- <member name="M:SharpDX.Vector3.Hermite(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,System.Single)">
- <summary>
- Performs a Hermite spline interpolation.
- </summary>
- <param name="value1">First source position vector.</param>
- <param name="tangent1">First source tangent vector.</param>
- <param name="value2">Second source position vector.</param>
- <param name="tangent2">Second source tangent vector.</param>
- <param name="amount">Weighting factor.</param>
- <returns>The result of the Hermite spline interpolation.</returns>
- </member>
- <member name="M:SharpDX.Vector3.CatmullRom(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@,System.Single,SharpDX.Vector3@)">
- <summary>
- Performs a Catmull-Rom interpolation using the specified positions.
- </summary>
- <param name="value1">The first position in the interpolation.</param>
- <param name="value2">The second position in the interpolation.</param>
- <param name="value3">The third position in the interpolation.</param>
- <param name="value4">The fourth position in the interpolation.</param>
- <param name="amount">Weighting factor.</param>
- <param name="result">When the method completes, contains the result of the Catmull-Rom interpolation.</param>
- </member>
- <member name="M:SharpDX.Vector3.CatmullRom(SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,SharpDX.Vector3,System.Single)">
- <summary>
- Performs a Catmull-Rom interpolation using the specified positions.
- </summary>
- <param name="value1">The first position in the interpolation.</param>
- <param name="value2">The second position in the interpolation.</param>
- <param name="value3">The third position in the interpolation.</param>
- <param name="value4">The fourth position in the interpolation.</param>
- <param name="amount">Weighting factor.</param>
- <returns>A vector that is the result of the Catmull-Rom interpolation.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Max(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Returns a vector containing the largest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <param name="result">When the method completes, contains an new vector composed of the largest components of the source vectors.</param>
- </member>
- <member name="M:SharpDX.Vector3.Max(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Returns a vector containing the largest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <returns>A vector containing the largest components of the source vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Min(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <param name="result">When the method completes, contains an new vector composed of the smallest components of the source vectors.</param>
- </member>
- <member name="M:SharpDX.Vector3.Min(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <returns>A vector containing the smallest components of the source vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Project(SharpDX.Vector3@,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@,SharpDX.Vector3@)">
- <summary>
- Projects a 3D vector from object space into screen space.
- </summary>
- <param name="vector">The vector to project.</param>
- <param name="x">The X position of the viewport.</param>
- <param name="y">The Y position of the viewport.</param>
- <param name="width">The width of the viewport.</param>
- <param name="height">The height of the viewport.</param>
- <param name="minZ">The minimum depth of the viewport.</param>
- <param name="maxZ">The maximum depth of the viewport.</param>
- <param name="worldViewProjection">The combined world-view-projection matrix.</param>
- <param name="result">When the method completes, contains the vector in screen space.</param>
- </member>
- <member name="M:SharpDX.Vector3.Project(SharpDX.Vector3,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix)">
- <summary>
- Projects a 3D vector from object space into screen space.
- </summary>
- <param name="vector">The vector to project.</param>
- <param name="x">The X position of the viewport.</param>
- <param name="y">The Y position of the viewport.</param>
- <param name="width">The width of the viewport.</param>
- <param name="height">The height of the viewport.</param>
- <param name="minZ">The minimum depth of the viewport.</param>
- <param name="maxZ">The maximum depth of the viewport.</param>
- <param name="worldViewProjection">The combined world-view-projection matrix.</param>
- <returns>The vector in screen space.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Unproject(SharpDX.Vector3@,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix@,SharpDX.Vector3@)">
- <summary>
- Projects a 3D vector from screen space into object space.
- </summary>
- <param name="vector">The vector to project.</param>
- <param name="x">The X position of the viewport.</param>
- <param name="y">The Y position of the viewport.</param>
- <param name="width">The width of the viewport.</param>
- <param name="height">The height of the viewport.</param>
- <param name="minZ">The minimum depth of the viewport.</param>
- <param name="maxZ">The maximum depth of the viewport.</param>
- <param name="worldViewProjection">The combined world-view-projection matrix.</param>
- <param name="result">When the method completes, contains the vector in object space.</param>
- </member>
- <member name="M:SharpDX.Vector3.Unproject(SharpDX.Vector3,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,SharpDX.Matrix)">
- <summary>
- Projects a 3D vector from screen space into object space.
- </summary>
- <param name="vector">The vector to project.</param>
- <param name="x">The X position of the viewport.</param>
- <param name="y">The Y position of the viewport.</param>
- <param name="width">The width of the viewport.</param>
- <param name="height">The height of the viewport.</param>
- <param name="minZ">The minimum depth of the viewport.</param>
- <param name="maxZ">The maximum depth of the viewport.</param>
- <param name="worldViewProjection">The combined world-view-projection matrix.</param>
- <returns>The vector in object space.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Reflect(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)">
- <summary>
- Returns the reflection of a vector off a surface that has the specified normal.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="normal">Normal of the surface.</param>
- <param name="result">When the method completes, contains the reflected vector.</param>
- <remarks>Reflect only gives the direction of a reflection off a surface, it does not determine
- whether the original vector was close enough to the surface to hit it.</remarks>
- </member>
- <member name="M:SharpDX.Vector3.Reflect(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Returns the reflection of a vector off a surface that has the specified normal.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="normal">Normal of the surface.</param>
- <returns>The reflected vector.</returns>
- <remarks>Reflect only gives the direction of a reflection off a surface, it does not determine
- whether the original vector was close enough to the surface to hit it.</remarks>
- </member>
- <member name="M:SharpDX.Vector3.Orthogonalize(SharpDX.Vector3[],SharpDX.Vector3[])">
- <summary>
- Orthogonalizes a list of vectors.
- </summary>
- <param name="destination">The list of orthogonalized vectors.</param>
- <param name="source">The list of vectors to orthogonalize.</param>
- <remarks>
- <para>Orthogonalization is the process of making all vectors orthogonal to each other. This
- means that any given vector in the list will be orthogonal to any other given vector in the
- list.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting vectors
- tend to be numerically unstable. The numeric stability decreases according to the vectors
- position in the list so that the first vector is the most stable and the last vector is the
- least stable.</para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector3.Orthonormalize(SharpDX.Vector3[],SharpDX.Vector3[])">
- <summary>
- Orthonormalizes a list of vectors.
- </summary>
- <param name="destination">The list of orthonormalized vectors.</param>
- <param name="source">The list of vectors to orthonormalize.</param>
- <remarks>
- <para>Orthonormalization is the process of making all vectors orthogonal to each
- other and making all vectors of unit length. This means that any given vector will
- be orthogonal to any other given vector in the list.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting vectors
- tend to be numerically unstable. The numeric stability decreases according to the vectors
- position in the list so that the first vector is the most stable and the last vector is the
- least stable.</para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector3.Transform(SharpDX.Vector3@,SharpDX.Quaternion@,SharpDX.Vector3@)">
- <summary>
- Transforms a 3D vector by the given <see cref="T:SharpDX.Quaternion"/> rotation.
- </summary>
- <param name="vector">The vector to rotate.</param>
- <param name="rotation">The <see cref="T:SharpDX.Quaternion"/> rotation to apply.</param>
- <param name="result">When the method completes, contains the transformed <see cref="T:SharpDX.Vector4"/>.</param>
- </member>
- <member name="M:SharpDX.Vector3.Transform(SharpDX.Vector3,SharpDX.Quaternion)">
- <summary>
- Transforms a 3D vector by the given <see cref="T:SharpDX.Quaternion"/> rotation.
- </summary>
- <param name="vector">The vector to rotate.</param>
- <param name="rotation">The <see cref="T:SharpDX.Quaternion"/> rotation to apply.</param>
- <returns>The transformed <see cref="T:SharpDX.Vector4"/>.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Transform(SharpDX.Vector3[],SharpDX.Quaternion@,SharpDX.Vector3[])">
- <summary>
- Transforms an array of vectors by the given <see cref="T:SharpDX.Quaternion"/> rotation.
- </summary>
- <param name="source">The array of vectors to transform.</param>
- <param name="rotation">The <see cref="T:SharpDX.Quaternion"/> rotation to apply.</param>
- <param name="destination">The array for which the transformed vectors are stored.
- This array may be the same array as <paramref name="source"/>.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector3.Transform(SharpDX.Vector3@,SharpDX.Matrix3x3@,SharpDX.Vector3@)">
- <summary>
- Transforms a 3D vector by the given <see cref="T:SharpDX.Matrix3x3"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix3x3"/>.</param>
- <param name="result">When the method completes, contains the transformed <see cref="T:SharpDX.Vector3"/>.</param>
- </member>
- <member name="M:SharpDX.Vector3.Transform(SharpDX.Vector3,SharpDX.Matrix3x3)">
- <summary>
- Transforms a 3D vector by the given <see cref="T:SharpDX.Matrix3x3"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix3x3"/>.</param>
- <returns>The transformed <see cref="T:SharpDX.Vector3"/>.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Transform(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
- <summary>
- Transforms a 3D vector by the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="result">When the method completes, contains the transformed <see cref="T:SharpDX.Vector3"/>.</param>
- </member>
- <member name="M:SharpDX.Vector3.Transform(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector4@)">
- <summary>
- Transforms a 3D vector by the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="result">When the method completes, contains the transformed <see cref="T:SharpDX.Vector4"/>.</param>
- </member>
- <member name="M:SharpDX.Vector3.Transform(SharpDX.Vector3,SharpDX.Matrix)">
- <summary>
- Transforms a 3D vector by the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <returns>The transformed <see cref="T:SharpDX.Vector4"/>.</returns>
- </member>
- <member name="M:SharpDX.Vector3.Transform(SharpDX.Vector3[],SharpDX.Matrix@,SharpDX.Vector4[])">
- <summary>
- Transforms an array of 3D vectors by the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="source">The array of vectors to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="destination">The array for which the transformed vectors are stored.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector3.TransformCoordinate(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
- <summary>
- Performs a coordinate transformation using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="coordinate">The coordinate vector to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="result">When the method completes, contains the transformed coordinates.</param>
- <remarks>
- A coordinate transform performs the transformation with the assumption that the w component
- is one. The four dimensional vector obtained from the transformation operation has each
- component in the vector divided by the w component. This forces the w component to be one and
- therefore makes the vector homogeneous. The homogeneous vector is often preferred when working
- with coordinates as the w component can safely be ignored.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.TransformCoordinate(SharpDX.Vector3,SharpDX.Matrix)">
- <summary>
- Performs a coordinate transformation using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="coordinate">The coordinate vector to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <returns>The transformed coordinates.</returns>
- <remarks>
- A coordinate transform performs the transformation with the assumption that the w component
- is one. The four dimensional vector obtained from the transformation operation has each
- component in the vector divided by the w component. This forces the w component to be one and
- therefore makes the vector homogeneous. The homogeneous vector is often preferred when working
- with coordinates as the w component can safely be ignored.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.TransformCoordinate(SharpDX.Vector3[],SharpDX.Matrix@,SharpDX.Vector3[])">
- <summary>
- Performs a coordinate transformation on an array of vectors using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="source">The array of coordinate vectors to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="destination">The array for which the transformed vectors are stored.
- This array may be the same array as <paramref name="source"/>.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- <remarks>
- A coordinate transform performs the transformation with the assumption that the w component
- is one. The four dimensional vector obtained from the transformation operation has each
- component in the vector divided by the w component. This forces the w component to be one and
- therefore makes the vector homogeneous. The homogeneous vector is often preferred when working
- with coordinates as the w component can safely be ignored.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.TransformNormal(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
- <summary>
- Performs a normal transformation using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="normal">The normal vector to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="result">When the method completes, contains the transformed normal.</param>
- <remarks>
- A normal transform performs the transformation with the assumption that the w component
- is zero. This causes the fourth row and fourth column of the matrix to be unused. The
- end result is a vector that is not translated, but all other transformation properties
- apply. This is often preferred for normal vectors as normals purely represent direction
- rather than location because normal vectors should not be translated.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.TransformNormal(SharpDX.Vector3,SharpDX.Matrix)">
- <summary>
- Performs a normal transformation using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="normal">The normal vector to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <returns>The transformed normal.</returns>
- <remarks>
- A normal transform performs the transformation with the assumption that the w component
- is zero. This causes the fourth row and fourth column of the matrix to be unused. The
- end result is a vector that is not translated, but all other transformation properties
- apply. This is often preferred for normal vectors as normals purely represent direction
- rather than location because normal vectors should not be translated.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.TransformNormal(SharpDX.Vector3[],SharpDX.Matrix@,SharpDX.Vector3[])">
- <summary>
- Performs a normal transformation on an array of vectors using the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="source">The array of normal vectors to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="destination">The array for which the transformed vectors are stored.
- This array may be the same array as <paramref name="source"/>.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- <remarks>
- A normal transform performs the transformation with the assumption that the w component
- is zero. This causes the fourth row and fourth column of the matrix to be unused. The
- end result is a vector that is not translated, but all other transformation properties
- apply. This is often preferred for normal vectors as normals purely represent direction
- rather than location because normal vectors should not be translated.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector3.op_Addition(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Adds two vectors.
- </summary>
- <param name="left">The first vector to add.</param>
- <param name="right">The second vector to add.</param>
- <returns>The sum of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Multiply(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Multiplies a vector with another by performing component-wise multiplication equivalent to <see cref="M:SharpDX.Vector3.Multiply(SharpDX.Vector3@,SharpDX.Vector3@,SharpDX.Vector3@)"/>.
- </summary>
- <param name="left">The first vector to multiply.</param>
- <param name="right">The second vector to multiply.</param>
- <returns>The multiplication of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_UnaryPlus(SharpDX.Vector3)">
- <summary>
- Assert a vector (return it unchanged).
- </summary>
- <param name="value">The vector to assert (unchanged).</param>
- <returns>The asserted (unchanged) vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Subtraction(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name="left">The first vector to subtract.</param>
- <param name="right">The second vector to subtract.</param>
- <returns>The difference of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_UnaryNegation(SharpDX.Vector3)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name="value">The vector to negate.</param>
- <returns>A vector facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Multiply(System.Single,SharpDX.Vector3)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Multiply(SharpDX.Vector3,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Division(SharpDX.Vector3,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Division(System.Single,SharpDX.Vector3)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="value">The vector to scale.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Division(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Addition(SharpDX.Vector3,System.Single)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be added on elements</param>
- <returns>The vector with added scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Addition(System.Single,SharpDX.Vector3)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be added on elements</param>
- <returns>The vector with added scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Subtraction(SharpDX.Vector3,System.Single)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be subtraced from elements</param>
- <returns>The vector with added scalar from each element.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Subtraction(System.Single,SharpDX.Vector3)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be subtraced from elements</param>
- <returns>The vector with subtraced scalar from each element.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Equality(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Inequality(SharpDX.Vector3,SharpDX.Vector3)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Explicit(SharpDX.Vector3)~SharpDX.Vector2">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector3"/> to <see cref="T:SharpDX.Vector2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Explicit(SharpDX.Vector3)~SharpDX.Vector4">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector3"/> to <see cref="T:SharpDX.Vector4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Vector3.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector3.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector3.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector3.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector3.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Vector3.Equals(SharpDX.Vector3@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector3"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Vector3"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector3"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Vector3.Equals(SharpDX.Vector3)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector3"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Vector3"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector3"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Vector3.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Implicit(SharpDX.Vector3)~SharpDX.Mathematics.Interop.RawVector3">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Vector3"/> to <see cref="T:SharpDX.Mathematics.Interop.RawVector3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Vector3.op_Implicit(SharpDX.Mathematics.Interop.RawVector3)~SharpDX.Vector3">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawVector3"/> to <see cref="T:SharpDX.Vector3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.Vector4">
- <summary>
- Represents a four dimensional mathematical vector.
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.SizeInBytes">
- <summary>
- The size of the <see cref="T:SharpDX.Vector4"/> type, in bytes.
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.Zero">
- <summary>
- A <see cref="T:SharpDX.Vector4"/> with all of its components set to zero.
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.UnitX">
- <summary>
- The X unit <see cref="T:SharpDX.Vector4"/> (1, 0, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.UnitY">
- <summary>
- The Y unit <see cref="T:SharpDX.Vector4"/> (0, 1, 0, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.UnitZ">
- <summary>
- The Z unit <see cref="T:SharpDX.Vector4"/> (0, 0, 1, 0).
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.UnitW">
- <summary>
- The W unit <see cref="T:SharpDX.Vector4"/> (0, 0, 0, 1).
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.One">
- <summary>
- A <see cref="T:SharpDX.Vector4"/> with all of its components set to one.
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.X">
- <summary>
- The X component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.Y">
- <summary>
- The Y component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.Z">
- <summary>
- The Z component of the vector.
- </summary>
- </member>
- <member name="F:SharpDX.Vector4.W">
- <summary>
- The W component of the vector.
- </summary>
- </member>
- <member name="M:SharpDX.Vector4.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector4"/> struct.
- </summary>
- <param name="value">The value that will be assigned to all components.</param>
- </member>
- <member name="M:SharpDX.Vector4.#ctor(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector4"/> struct.
- </summary>
- <param name="x">Initial value for the X component of the vector.</param>
- <param name="y">Initial value for the Y component of the vector.</param>
- <param name="z">Initial value for the Z component of the vector.</param>
- <param name="w">Initial value for the W component of the vector.</param>
- </member>
- <member name="M:SharpDX.Vector4.#ctor(SharpDX.Vector3,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector4"/> struct.
- </summary>
- <param name="value">A vector containing the values with which to initialize the X, Y, and Z components.</param>
- <param name="w">Initial value for the W component of the vector.</param>
- </member>
- <member name="M:SharpDX.Vector4.#ctor(SharpDX.Vector2,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector4"/> struct.
- </summary>
- <param name="value">A vector containing the values with which to initialize the X and Y components.</param>
- <param name="z">Initial value for the Z component of the vector.</param>
- <param name="w">Initial value for the W component of the vector.</param>
- </member>
- <member name="M:SharpDX.Vector4.#ctor(System.Single[])">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Vector4"/> struct.
- </summary>
- <param name="values">The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="values"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="values"/> contains more or less than four elements.</exception>
- </member>
- <member name="P:SharpDX.Vector4.IsNormalized">
- <summary>
- Gets a value indicting whether this instance is normalized.
- </summary>
- </member>
- <member name="P:SharpDX.Vector4.IsZero">
- <summary>
- Gets a value indicting whether this vector is zero
- </summary>
- </member>
- <member name="P:SharpDX.Vector4.Item(System.Int32)">
- <summary>
- Gets or sets the component at the specified index.
- </summary>
- <value>The value of the X, Y, Z, or W component, depending on the index.</value>
- <param name="index">The index of the component to access. Use 0 for the X component, 1 for the Y component, 2 for the Z component, and 3 for the W component.</param>
- <returns>The value of the component at the specified index.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when the <paramref name="index"/> is out of the range [0, 3].</exception>
- </member>
- <member name="M:SharpDX.Vector4.Length">
- <summary>
- Calculates the length of the vector.
- </summary>
- <returns>The length of the vector.</returns>
- <remarks>
- <see cref="M:SharpDX.Vector4.LengthSquared"/> may be preferred when only the relative length is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector4.LengthSquared">
- <summary>
- Calculates the squared length of the vector.
- </summary>
- <returns>The squared length of the vector.</returns>
- <remarks>
- This method may be preferred to <see cref="M:SharpDX.Vector4.Length"/> when only a relative length is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector4.Normalize">
- <summary>
- Converts the vector into a unit vector.
- </summary>
- </member>
- <member name="M:SharpDX.Vector4.ToArray">
- <summary>
- Creates an array containing the elements of the vector.
- </summary>
- <returns>A four-element array containing the components of the vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Add(SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@)">
- <summary>
- Adds two vectors.
- </summary>
- <param name="left">The first vector to add.</param>
- <param name="right">The second vector to add.</param>
- <param name="result">When the method completes, contains the sum of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector4.Add(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Adds two vectors.
- </summary>
- <param name="left">The first vector to add.</param>
- <param name="right">The second vector to add.</param>
- <returns>The sum of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Add(SharpDX.Vector4@,System.Single@,SharpDX.Vector4@)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be added to elements</param>
- <param name="result">The vector with added scalar for each element.</param>
- </member>
- <member name="M:SharpDX.Vector4.Add(SharpDX.Vector4,System.Single)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be added to elements</param>
- <returns>The vector with added scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Subtract(SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name="left">The first vector to subtract.</param>
- <param name="right">The second vector to subtract.</param>
- <param name="result">When the method completes, contains the difference of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector4.Subtract(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name="left">The first vector to subtract.</param>
- <param name="right">The second vector to subtract.</param>
- <returns>The difference of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Subtract(SharpDX.Vector4@,System.Single@,SharpDX.Vector4@)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be subtraced from elements</param>
- <param name="result">The vector with subtracted scalar for each element.</param>
- </member>
- <member name="M:SharpDX.Vector4.Subtract(SharpDX.Vector4,System.Single)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The input vector</param>
- <param name="right">The scalar value to be subtraced from elements</param>
- <returns>The vector with subtracted scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Subtract(System.Single@,SharpDX.Vector4@,SharpDX.Vector4@)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The scalar value to be subtraced from elements</param>
- <param name="right">The input vector.</param>
- <param name="result">The vector with subtracted scalar for each element.</param>
- </member>
- <member name="M:SharpDX.Vector4.Subtract(System.Single,SharpDX.Vector4)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="left">The scalar value to be subtraced from elements</param>
- <param name="right">The input vector.</param>
- <returns>The vector with subtracted scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Multiply(SharpDX.Vector4@,System.Single,SharpDX.Vector4@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Vector4.Multiply(SharpDX.Vector4,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Multiply(SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@)">
- <summary>
- Multiplies a vector with another by performing component-wise multiplication.
- </summary>
- <param name="left">The first vector to multiply.</param>
- <param name="right">The second vector to multiply.</param>
- <param name="result">When the method completes, contains the multiplied vector.</param>
- </member>
- <member name="M:SharpDX.Vector4.Multiply(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Multiplies a vector with another by performing component-wise multiplication.
- </summary>
- <param name="left">The first vector to multiply.</param>
- <param name="right">The second vector to multiply.</param>
- <returns>The multiplied vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Divide(SharpDX.Vector4@,System.Single,SharpDX.Vector4@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Vector4.Divide(SharpDX.Vector4,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Divide(System.Single,SharpDX.Vector4@,SharpDX.Vector4@)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="value">The vector to scale.</param>
- <param name="result">When the method completes, contains the scaled vector.</param>
- </member>
- <member name="M:SharpDX.Vector4.Divide(System.Single,SharpDX.Vector4)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Negate(SharpDX.Vector4@,SharpDX.Vector4@)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name="value">The vector to negate.</param>
- <param name="result">When the method completes, contains a vector facing in the opposite direction.</param>
- </member>
- <member name="M:SharpDX.Vector4.Negate(SharpDX.Vector4)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name="value">The vector to negate.</param>
- <returns>A vector facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Barycentric(SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@,System.Single,System.Single,SharpDX.Vector4@)">
- <summary>
- Returns a <see cref="T:SharpDX.Vector4"/> containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 4D triangle.
- </summary>
- <param name="value1">A <see cref="T:SharpDX.Vector4"/> containing the 4D Cartesian coordinates of vertex 1 of the triangle.</param>
- <param name="value2">A <see cref="T:SharpDX.Vector4"/> containing the 4D Cartesian coordinates of vertex 2 of the triangle.</param>
- <param name="value3">A <see cref="T:SharpDX.Vector4"/> containing the 4D Cartesian coordinates of vertex 3 of the triangle.</param>
- <param name="amount1">Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in <paramref name="value2"/>).</param>
- <param name="amount2">Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in <paramref name="value3"/>).</param>
- <param name="result">When the method completes, contains the 4D Cartesian coordinates of the specified point.</param>
- </member>
- <member name="M:SharpDX.Vector4.Barycentric(SharpDX.Vector4,SharpDX.Vector4,SharpDX.Vector4,System.Single,System.Single)">
- <summary>
- Returns a <see cref="T:SharpDX.Vector4"/> containing the 4D Cartesian coordinates of a point specified in Barycentric coordinates relative to a 4D triangle.
- </summary>
- <param name="value1">A <see cref="T:SharpDX.Vector4"/> containing the 4D Cartesian coordinates of vertex 1 of the triangle.</param>
- <param name="value2">A <see cref="T:SharpDX.Vector4"/> containing the 4D Cartesian coordinates of vertex 2 of the triangle.</param>
- <param name="value3">A <see cref="T:SharpDX.Vector4"/> containing the 4D Cartesian coordinates of vertex 3 of the triangle.</param>
- <param name="amount1">Barycentric coordinate b2, which expresses the weighting factor toward vertex 2 (specified in <paramref name="value2"/>).</param>
- <param name="amount2">Barycentric coordinate b3, which expresses the weighting factor toward vertex 3 (specified in <paramref name="value3"/>).</param>
- <returns>A new <see cref="T:SharpDX.Vector4"/> containing the 4D Cartesian coordinates of the specified point.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Clamp(SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <param name="result">When the method completes, contains the clamped value.</param>
- </member>
- <member name="M:SharpDX.Vector4.Clamp(SharpDX.Vector4,SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Restricts a value to be within a specified range.
- </summary>
- <param name="value">The value to clamp.</param>
- <param name="min">The minimum value.</param>
- <param name="max">The maximum value.</param>
- <returns>The clamped value.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Distance(SharpDX.Vector4@,SharpDX.Vector4@,System.Single@)">
- <summary>
- Calculates the distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <param name="result">When the method completes, contains the distance between the two vectors.</param>
- <remarks>
- <see cref="M:SharpDX.Vector4.DistanceSquared(SharpDX.Vector4@,SharpDX.Vector4@,System.Single@)"/> may be preferred when only the relative distance is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector4.Distance(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Calculates the distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <returns>The distance between the two vectors.</returns>
- <remarks>
- <see cref="M:SharpDX.Vector4.DistanceSquared(SharpDX.Vector4,SharpDX.Vector4)"/> may be preferred when only the relative distance is needed
- and speed is of the essence.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector4.DistanceSquared(SharpDX.Vector4@,SharpDX.Vector4@,System.Single@)">
- <summary>
- Calculates the squared distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <param name="result">When the method completes, contains the squared distance between the two vectors.</param>
- <remarks>Distance squared is the value before taking the square root.
- Distance squared can often be used in place of distance if relative comparisons are being made.
- For example, consider three points A, B, and C. To determine whether B or C is further from A,
- compare the distance between A and B to the distance between A and C. Calculating the two distances
- involves two square roots, which are computationally expensive. However, using distance squared
- provides the same information and avoids calculating two square roots.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector4.DistanceSquared(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Calculates the squared distance between two vectors.
- </summary>
- <param name="value1">The first vector.</param>
- <param name="value2">The second vector.</param>
- <returns>The squared distance between the two vectors.</returns>
- <remarks>Distance squared is the value before taking the square root.
- Distance squared can often be used in place of distance if relative comparisons are being made.
- For example, consider three points A, B, and C. To determine whether B or C is further from A,
- compare the distance between A and B to the distance between A and C. Calculating the two distances
- involves two square roots, which are computationally expensive. However, using distance squared
- provides the same information and avoids calculating two square roots.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector4.Dot(SharpDX.Vector4@,SharpDX.Vector4@,System.Single@)">
- <summary>
- Calculates the dot product of two vectors.
- </summary>
- <param name="left">First source vector</param>
- <param name="right">Second source vector.</param>
- <param name="result">When the method completes, contains the dot product of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector4.Dot(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Calculates the dot product of two vectors.
- </summary>
- <param name="left">First source vector.</param>
- <param name="right">Second source vector.</param>
- <returns>The dot product of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Normalize(SharpDX.Vector4@,SharpDX.Vector4@)">
- <summary>
- Converts the vector into a unit vector.
- </summary>
- <param name="value">The vector to normalize.</param>
- <param name="result">When the method completes, contains the normalized vector.</param>
- </member>
- <member name="M:SharpDX.Vector4.Normalize(SharpDX.Vector4)">
- <summary>
- Converts the vector into a unit vector.
- </summary>
- <param name="value">The vector to normalize.</param>
- <returns>The normalized vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Lerp(SharpDX.Vector4@,SharpDX.Vector4@,System.Single,SharpDX.Vector4@)">
- <summary>
- Performs a linear interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the linear interpolation of the two vectors.</param>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector4.Lerp(SharpDX.Vector4,SharpDX.Vector4,System.Single)">
- <summary>
- Performs a linear interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The linear interpolation of the two vectors.</returns>
- <remarks>
- Passing <paramref name="amount"/> a value of 0 will cause <paramref name="start"/> to be returned; a value of 1 will cause <paramref name="end"/> to be returned.
- </remarks>
- </member>
- <member name="M:SharpDX.Vector4.SmoothStep(SharpDX.Vector4@,SharpDX.Vector4@,System.Single,SharpDX.Vector4@)">
- <summary>
- Performs a cubic interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <param name="result">When the method completes, contains the cubic interpolation of the two vectors.</param>
- </member>
- <member name="M:SharpDX.Vector4.SmoothStep(SharpDX.Vector4,SharpDX.Vector4,System.Single)">
- <summary>
- Performs a cubic interpolation between two vectors.
- </summary>
- <param name="start">Start vector.</param>
- <param name="end">End vector.</param>
- <param name="amount">Value between 0 and 1 indicating the weight of <paramref name="end"/>.</param>
- <returns>The cubic interpolation of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Hermite(SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@,System.Single,SharpDX.Vector4@)">
- <summary>
- Performs a Hermite spline interpolation.
- </summary>
- <param name="value1">First source position vector.</param>
- <param name="tangent1">First source tangent vector.</param>
- <param name="value2">Second source position vector.</param>
- <param name="tangent2">Second source tangent vector.</param>
- <param name="amount">Weighting factor.</param>
- <param name="result">When the method completes, contains the result of the Hermite spline interpolation.</param>
- </member>
- <member name="M:SharpDX.Vector4.Hermite(SharpDX.Vector4,SharpDX.Vector4,SharpDX.Vector4,SharpDX.Vector4,System.Single)">
- <summary>
- Performs a Hermite spline interpolation.
- </summary>
- <param name="value1">First source position vector.</param>
- <param name="tangent1">First source tangent vector.</param>
- <param name="value2">Second source position vector.</param>
- <param name="tangent2">Second source tangent vector.</param>
- <param name="amount">Weighting factor.</param>
- <returns>The result of the Hermite spline interpolation.</returns>
- </member>
- <member name="M:SharpDX.Vector4.CatmullRom(SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@,System.Single,SharpDX.Vector4@)">
- <summary>
- Performs a Catmull-Rom interpolation using the specified positions.
- </summary>
- <param name="value1">The first position in the interpolation.</param>
- <param name="value2">The second position in the interpolation.</param>
- <param name="value3">The third position in the interpolation.</param>
- <param name="value4">The fourth position in the interpolation.</param>
- <param name="amount">Weighting factor.</param>
- <param name="result">When the method completes, contains the result of the Catmull-Rom interpolation.</param>
- </member>
- <member name="M:SharpDX.Vector4.CatmullRom(SharpDX.Vector4,SharpDX.Vector4,SharpDX.Vector4,SharpDX.Vector4,System.Single)">
- <summary>
- Performs a Catmull-Rom interpolation using the specified positions.
- </summary>
- <param name="value1">The first position in the interpolation.</param>
- <param name="value2">The second position in the interpolation.</param>
- <param name="value3">The third position in the interpolation.</param>
- <param name="value4">The fourth position in the interpolation.</param>
- <param name="amount">Weighting factor.</param>
- <returns>A vector that is the result of the Catmull-Rom interpolation.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Max(SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@)">
- <summary>
- Returns a vector containing the largest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <param name="result">When the method completes, contains an new vector composed of the largest components of the source vectors.</param>
- </member>
- <member name="M:SharpDX.Vector4.Max(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Returns a vector containing the largest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <returns>A vector containing the largest components of the source vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Min(SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <param name="result">When the method completes, contains an new vector composed of the smallest components of the source vectors.</param>
- </member>
- <member name="M:SharpDX.Vector4.Min(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Returns a vector containing the smallest components of the specified vectors.
- </summary>
- <param name="left">The first source vector.</param>
- <param name="right">The second source vector.</param>
- <returns>A vector containing the smallest components of the source vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Orthogonalize(SharpDX.Vector4[],SharpDX.Vector4[])">
- <summary>
- Orthogonalizes a list of vectors.
- </summary>
- <param name="destination">The list of orthogonalized vectors.</param>
- <param name="source">The list of vectors to orthogonalize.</param>
- <remarks>
- <para>Orthogonalization is the process of making all vectors orthogonal to each other. This
- means that any given vector in the list will be orthogonal to any other given vector in the
- list.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting vectors
- tend to be numerically unstable. The numeric stability decreases according to the vectors
- position in the list so that the first vector is the most stable and the last vector is the
- least stable.</para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector4.Orthonormalize(SharpDX.Vector4[],SharpDX.Vector4[])">
- <summary>
- Orthonormalizes a list of vectors.
- </summary>
- <param name="destination">The list of orthonormalized vectors.</param>
- <param name="source">The list of vectors to orthonormalize.</param>
- <remarks>
- <para>Orthonormalization is the process of making all vectors orthogonal to each
- other and making all vectors of unit length. This means that any given vector will
- be orthogonal to any other given vector in the list.</para>
- <para>Because this method uses the modified Gram-Schmidt process, the resulting vectors
- tend to be numerically unstable. The numeric stability decreases according to the vectors
- position in the list so that the first vector is the most stable and the last vector is the
- least stable.</para>
- </remarks>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector4.Transform(SharpDX.Vector4@,SharpDX.Quaternion@,SharpDX.Vector4@)">
- <summary>
- Transforms a 4D vector by the given <see cref="T:SharpDX.Quaternion"/> rotation.
- </summary>
- <param name="vector">The vector to rotate.</param>
- <param name="rotation">The <see cref="T:SharpDX.Quaternion"/> rotation to apply.</param>
- <param name="result">When the method completes, contains the transformed <see cref="T:SharpDX.Vector4"/>.</param>
- </member>
- <member name="M:SharpDX.Vector4.Transform(SharpDX.Vector4,SharpDX.Quaternion)">
- <summary>
- Transforms a 4D vector by the given <see cref="T:SharpDX.Quaternion"/> rotation.
- </summary>
- <param name="vector">The vector to rotate.</param>
- <param name="rotation">The <see cref="T:SharpDX.Quaternion"/> rotation to apply.</param>
- <returns>The transformed <see cref="T:SharpDX.Vector4"/>.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Transform(SharpDX.Vector4[],SharpDX.Quaternion@,SharpDX.Vector4[])">
- <summary>
- Transforms an array of vectors by the given <see cref="T:SharpDX.Quaternion"/> rotation.
- </summary>
- <param name="source">The array of vectors to transform.</param>
- <param name="rotation">The <see cref="T:SharpDX.Quaternion"/> rotation to apply.</param>
- <param name="destination">The array for which the transformed vectors are stored.
- This array may be the same array as <paramref name="source"/>.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector4.Transform(SharpDX.Vector4@,SharpDX.Matrix@,SharpDX.Vector4@)">
- <summary>
- Transforms a 4D vector by the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="result">When the method completes, contains the transformed <see cref="T:SharpDX.Vector4"/>.</param>
- </member>
- <member name="M:SharpDX.Vector4.Transform(SharpDX.Vector4,SharpDX.Matrix)">
- <summary>
- Transforms a 4D vector by the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <returns>The transformed <see cref="T:SharpDX.Vector4"/>.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Transform(SharpDX.Vector4@,SharpDX.Matrix5x4@,SharpDX.Vector4@)">
- <summary>
- Transforms a 4D vector by the given <see cref="T:SharpDX.Matrix5x4"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix5x4"/>.</param>
- <param name="result">When the method completes, contains the transformed <see cref="T:SharpDX.Vector4"/>.</param>
- </member>
- <member name="M:SharpDX.Vector4.Transform(SharpDX.Vector4,SharpDX.Matrix5x4)">
- <summary>
- Transforms a 4D vector by the given <see cref="T:SharpDX.Matrix5x4"/>.
- </summary>
- <param name="vector">The source vector.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix5x4"/>.</param>
- <returns>The transformed <see cref="T:SharpDX.Vector4"/>.</returns>
- </member>
- <member name="M:SharpDX.Vector4.Transform(SharpDX.Vector4[],SharpDX.Matrix@,SharpDX.Vector4[])">
- <summary>
- Transforms an array of 4D vectors by the given <see cref="T:SharpDX.Matrix"/>.
- </summary>
- <param name="source">The array of vectors to transform.</param>
- <param name="transform">The transformation <see cref="T:SharpDX.Matrix"/>.</param>
- <param name="destination">The array for which the transformed vectors are stored.
- This array may be the same array as <paramref name="source"/>.</param>
- <exception cref="T:System.ArgumentNullException">Thrown when <paramref name="source"/> or <paramref name="destination"/> is <c>null</c>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when <paramref name="destination"/> is shorter in length than <paramref name="source"/>.</exception>
- </member>
- <member name="M:SharpDX.Vector4.op_Addition(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Adds two vectors.
- </summary>
- <param name="left">The first vector to add.</param>
- <param name="right">The second vector to add.</param>
- <returns>The sum of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Multiply(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Multiplies a vector with another by performing component-wise multiplication equivalent to <see cref="M:SharpDX.Vector4.Multiply(SharpDX.Vector4@,SharpDX.Vector4@,SharpDX.Vector4@)"/>.
- </summary>
- <param name="left">The first vector to multiply.</param>
- <param name="right">The second vector to multiply.</param>
- <returns>The multiplication of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_UnaryPlus(SharpDX.Vector4)">
- <summary>
- Assert a vector (return it unchanged).
- </summary>
- <param name="value">The vector to assert (unchanged).</param>
- <returns>The asserted (unchanged) vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Subtraction(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Subtracts two vectors.
- </summary>
- <param name="left">The first vector to subtract.</param>
- <param name="right">The second vector to subtract.</param>
- <returns>The difference of the two vectors.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_UnaryNegation(SharpDX.Vector4)">
- <summary>
- Reverses the direction of a given vector.
- </summary>
- <param name="value">The vector to negate.</param>
- <returns>A vector facing in the opposite direction.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Multiply(System.Single,SharpDX.Vector4)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Multiply(SharpDX.Vector4,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Division(SharpDX.Vector4,System.Single)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Division(System.Single,SharpDX.Vector4)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="scale">The amount by which to scale the vector.</param>
- <param name="value">The vector to scale.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Division(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Scales a vector by the given value.
- </summary>
- <param name="value">The vector to scale.</param>
- <param name="scale">The amount by which to scale the vector.</param>
- <returns>The scaled vector.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Addition(SharpDX.Vector4,System.Single)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be added on elements</param>
- <returns>The vector with added scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Addition(System.Single,SharpDX.Vector4)">
- <summary>
- Perform a component-wise addition
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be added on elements</param>
- <returns>The vector with added scalar for each element.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Subtraction(SharpDX.Vector4,System.Single)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be subtraced from elements</param>
- <returns>The vector with subtraced scalar from each element.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Subtraction(System.Single,SharpDX.Vector4)">
- <summary>
- Perform a component-wise subtraction
- </summary>
- <param name="value">The input vector.</param>
- <param name="scalar">The scalar value to be subtraced from elements</param>
- <returns>The vector with subtraced scalar from each element.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Equality(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Tests for equality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has the same value as <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Inequality(SharpDX.Vector4,SharpDX.Vector4)">
- <summary>
- Tests for inequality between two objects.
- </summary>
- <param name="left">The first value to compare.</param>
- <param name="right">The second value to compare.</param>
- <returns><c>true</c> if <paramref name="left"/> has a different value than <paramref name="right"/>; otherwise, <c>false</c>.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Explicit(SharpDX.Vector4)~SharpDX.Vector2">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector4"/> to <see cref="T:SharpDX.Vector2"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Explicit(SharpDX.Vector4)~SharpDX.Vector3">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Vector4"/> to <see cref="T:SharpDX.Vector3"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Vector4.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector4.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector4.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector4.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:SharpDX.Vector4.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Vector4.Equals(SharpDX.Vector4@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Vector4.Equals(SharpDX.Vector4)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Vector4.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Implicit(SharpDX.Vector4)~SharpDX.Mathematics.Interop.RawVector4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Vector4"/> to <see cref="T:SharpDX.Mathematics.Interop.RawVector4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Vector4.op_Implicit(SharpDX.Mathematics.Interop.RawVector4)~SharpDX.Vector4">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawVector4"/> to <see cref="T:SharpDX.Vector4"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.Viewport">
- <summary>
- Defines the viewport dimensions.
- </summary>
- </member>
- <member name="F:SharpDX.Viewport.X">
- <summary>
- Position of the pixel coordinate of the upper-left corner of the viewport.
- </summary>
- </member>
- <member name="F:SharpDX.Viewport.Y">
- <summary>
- Position of the pixel coordinate of the upper-left corner of the viewport.
- </summary>
- </member>
- <member name="F:SharpDX.Viewport.Width">
- <summary>
- Width dimension of the viewport.
- </summary>
- </member>
- <member name="F:SharpDX.Viewport.Height">
- <summary>
- Height dimension of the viewport.
- </summary>
- </member>
- <member name="F:SharpDX.Viewport.MinDepth">
- <summary>
- Gets or sets the minimum depth of the clip volume.
- </summary>
- </member>
- <member name="F:SharpDX.Viewport.MaxDepth">
- <summary>
- Gets or sets the maximum depth of the clip volume.
- </summary>
- </member>
- <member name="M:SharpDX.Viewport.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Viewport"/> struct.
- </summary>
- <param name="x">The x coordinate of the upper-left corner of the viewport in pixels.</param>
- <param name="y">The y coordinate of the upper-left corner of the viewport in pixels.</param>
- <param name="width">The width of the viewport in pixels.</param>
- <param name="height">The height of the viewport in pixels.</param>
- </member>
- <member name="M:SharpDX.Viewport.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Viewport"/> struct.
- </summary>
- <param name="x">The x coordinate of the upper-left corner of the viewport in pixels.</param>
- <param name="y">The y coordinate of the upper-left corner of the viewport in pixels.</param>
- <param name="width">The width of the viewport in pixels.</param>
- <param name="height">The height of the viewport in pixels.</param>
- <param name="minDepth">The minimum depth of the clip volume.</param>
- <param name="maxDepth">The maximum depth of the clip volume.</param>
- </member>
- <member name="M:SharpDX.Viewport.#ctor(SharpDX.Rectangle)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.Viewport"/> struct.
- </summary>
- <param name="bounds">A bounding box that defines the location and size of the viewport in a render target.</param>
- </member>
- <member name="P:SharpDX.Viewport.Bounds">
- <summary>
- Gets the size of this resource.
- </summary>
- <value>The bounds.</value>
- </member>
- <member name="M:SharpDX.Viewport.Equals(SharpDX.Viewport@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Viewport"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Viewport"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Viewport"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Viewport.Equals(SharpDX.Viewport)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.Viewport"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.Viewport"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.Viewport"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Viewport.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal to this instance.
- </summary>
- <param name="obj">The object to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified object is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.Viewport.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.Viewport.op_Equality(SharpDX.Viewport,SharpDX.Viewport)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:SharpDX.Viewport.op_Inequality(SharpDX.Viewport,SharpDX.Viewport)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:SharpDX.Viewport.ToString">
- <summary>
- Retrieves a string representation of this object.
- </summary>
- <returns>A <see cref="T:System.String" /> that represents this instance.</returns>
- </member>
- <member name="M:SharpDX.Viewport.Project(SharpDX.Vector3,SharpDX.Matrix,SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Projects a 3D vector from object space into screen space.
- </summary>
- <param name="source">The vector to project.</param>
- <param name="projection">The projection matrix.</param>
- <param name="view">The view matrix.</param>
- <param name="world">The world matrix.</param>
- <returns>The projected vector.</returns>
- </member>
- <member name="M:SharpDX.Viewport.Project(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
- <summary>
- Projects a 3D vector from object space into screen space.
- </summary>
- <param name="source">The vector to project.</param>
- <param name="matrix">A combined WorldViewProjection matrix.</param>
- <param name="vector">The projected vector.</param>
- </member>
- <member name="M:SharpDX.Viewport.Unproject(SharpDX.Vector3,SharpDX.Matrix,SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Converts a screen space point into a corresponding point in world space.
- </summary>
- <param name="source">The vector to project.</param>
- <param name="projection">The projection matrix.</param>
- <param name="view">The view matrix.</param>
- <param name="world">The world matrix.</param>
- <returns>The unprojected Vector.</returns>
- </member>
- <member name="M:SharpDX.Viewport.Unproject(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
- <summary>
- Converts a screen space point into a corresponding point in world space.
- </summary>
- <param name="source">The vector to project.</param>
- <param name="matrix">An inverted combined WorldViewProjection matrix.</param>
- <param name="vector">The unprojected vector.</param>
- </member>
- <member name="P:SharpDX.Viewport.AspectRatio">
- <summary>
- Gets the aspect ratio used by the viewport.
- </summary>
- <value>The aspect ratio.</value>
- </member>
- <member name="M:SharpDX.Viewport.op_Implicit(SharpDX.Viewport)~SharpDX.Mathematics.Interop.RawViewport">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Viewport"/> to <see cref="T:SharpDX.Mathematics.Interop.RawViewport"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Viewport.op_Implicit(SharpDX.Viewport)~SharpDX.Mathematics.Interop.RawViewportF">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Viewport"/> to <see cref="T:SharpDX.Mathematics.Interop.RawViewport"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.Viewport.op_Implicit(SharpDX.Mathematics.Interop.RawViewport)~SharpDX.Viewport">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawViewport"/> to <see cref="T:SharpDX.Viewport"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="T:SharpDX.ViewportF">
- <summary>
- Defines the viewport dimensions using float coordinates for (X,Y,Width,Height).
- </summary>
- </member>
- <member name="F:SharpDX.ViewportF.X">
- <summary>
- Position of the pixel coordinate of the upper-left corner of the viewport.
- </summary>
- </member>
- <member name="F:SharpDX.ViewportF.Y">
- <summary>
- Position of the pixel coordinate of the upper-left corner of the viewport.
- </summary>
- </member>
- <member name="F:SharpDX.ViewportF.Width">
- <summary>
- Width dimension of the viewport.
- </summary>
- </member>
- <member name="F:SharpDX.ViewportF.Height">
- <summary>
- Height dimension of the viewport.
- </summary>
- </member>
- <member name="F:SharpDX.ViewportF.MinDepth">
- <summary>
- Gets or sets the minimum depth of the clip volume.
- </summary>
- </member>
- <member name="F:SharpDX.ViewportF.MaxDepth">
- <summary>
- Gets or sets the maximum depth of the clip volume.
- </summary>
- </member>
- <member name="M:SharpDX.ViewportF.#ctor(System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ViewportF"/> struct.
- </summary>
- <param name="x">The x coordinate of the upper-left corner of the viewport in pixels.</param>
- <param name="y">The y coordinate of the upper-left corner of the viewport in pixels.</param>
- <param name="width">The width of the viewport in pixels.</param>
- <param name="height">The height of the viewport in pixels.</param>
- </member>
- <member name="M:SharpDX.ViewportF.#ctor(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ViewportF"/> struct.
- </summary>
- <param name="x">The x coordinate of the upper-left corner of the viewport in pixels.</param>
- <param name="y">The y coordinate of the upper-left corner of the viewport in pixels.</param>
- <param name="width">The width of the viewport in pixels.</param>
- <param name="height">The height of the viewport in pixels.</param>
- <param name="minDepth">The minimum depth of the clip volume.</param>
- <param name="maxDepth">The maximum depth of the clip volume.</param>
- </member>
- <member name="M:SharpDX.ViewportF.#ctor(SharpDX.RectangleF)">
- <summary>
- Initializes a new instance of the <see cref="T:SharpDX.ViewportF"/> struct.
- </summary>
- <param name="bounds">A bounding box that defines the location and size of the viewport in a render target.</param>
- </member>
- <member name="P:SharpDX.ViewportF.Bounds">
- <summary>
- Gets the size of this resource.
- </summary>
- <value>The bounds.</value>
- </member>
- <member name="M:SharpDX.ViewportF.Equals(SharpDX.ViewportF@)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.ViewportF"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.ViewportF"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.ViewportF"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.ViewportF.Equals(SharpDX.ViewportF)">
- <summary>
- Determines whether the specified <see cref="T:SharpDX.ViewportF"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:SharpDX.ViewportF"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:SharpDX.ViewportF"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.ViewportF.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal to this instance.
- </summary>
- <param name="obj">The object to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified object is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:SharpDX.ViewportF.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="M:SharpDX.ViewportF.op_Equality(SharpDX.ViewportF,SharpDX.ViewportF)">
- <summary>
- Implements the operator ==.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:SharpDX.ViewportF.op_Inequality(SharpDX.ViewportF,SharpDX.ViewportF)">
- <summary>
- Implements the operator !=.
- </summary>
- <param name="left">The left.</param>
- <param name="right">The right.</param>
- <returns>The result of the operator.</returns>
- </member>
- <member name="M:SharpDX.ViewportF.ToString">
- <summary>
- Retrieves a string representation of this object.
- </summary>
- <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
- </member>
- <!-- Badly formed XML comment ignored for member "M:SharpDX.ViewportF.Project(SharpDX.Vector3,SharpDX.Matrix,SharpDX.Matrix,SharpDX.Matrix)" -->
- <member name="M:SharpDX.ViewportF.Project(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
- <summary>
- Projects a 3D vector from object space into screen space.
- </summary>
- <param name="source">The vector to project.</param>
- <param name="matrix">A combined WorldViewProjection matrix.</param>
- <param name="vector">The projected vector.</param>
- </member>
- <member name="M:SharpDX.ViewportF.Unproject(SharpDX.Vector3,SharpDX.Matrix,SharpDX.Matrix,SharpDX.Matrix)">
- <summary>
- Converts a screen space point into a corresponding point in world space.
- </summary>
- <param name="source">The vector to project.</param>
- <param name="projection">The projection matrix.</param>
- <param name="view">The view matrix.</param>
- <param name="world">The world matrix.</param>
- <returns>The unprojected Vector.</returns>
- </member>
- <member name="M:SharpDX.ViewportF.Unproject(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
- <summary>
- Converts a screen space point into a corresponding point in world space.
- </summary>
- <param name="source">The vector to project.</param>
- <param name="matrix">An inverted combined WorldViewProjection matrix.</param>
- <param name="vector">The unprojected vector.</param>
- </member>
- <member name="P:SharpDX.ViewportF.AspectRatio">
- <summary>
- Gets the aspect ratio used by the viewport.
- </summary>
- <value>The aspect ratio.</value>
- </member>
- <member name="M:SharpDX.ViewportF.op_Implicit(SharpDX.Viewport)~SharpDX.ViewportF">
- <summary>
- Performs an explicit conversion from <see cref="T:SharpDX.Viewport"/> to <see cref="T:SharpDX.ViewportF"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ViewportF.op_Implicit(SharpDX.ViewportF)~SharpDX.Mathematics.Interop.RawViewportF">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.ViewportF"/> to <see cref="T:SharpDX.Mathematics.Interop.RawViewportF"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:SharpDX.ViewportF.op_Implicit(SharpDX.Mathematics.Interop.RawViewportF)~SharpDX.ViewportF">
- <summary>
- Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawViewportF"/> to <see cref="T:SharpDX.ViewportF"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- </members>
- </doc>
|