Struct XMComparisonRecord

A comparison value.

Implements

IEquatable<XMComparisonRecord>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: JeremyAnsel.DirectX.DXMath

Assembly: JeremyAnsel.DirectX.DXMath.dll

Syntax

public struct XMComparisonRecord : IEquatable<XMComparisonRecord>

Constructors

XMComparisonRecord(uint)

Initializes a new instance of the XMComparisonRecord struct.

Declaration

public XMComparisonRecord(uint record)

Parameters

Type	Name	Description
uint	record	A comparison record.

Fields

Mask

Mask to get a comparison result.

Declaration

public const uint Mask = 240

Field Value

Type	Description
uint

MaskBounds

Mask to get a comparison result, and verify if the result indicates that some of the inputs were out of bounds.

Declaration

public const uint MaskBounds = 32

Field Value

Type	Description
uint

MaskFalse

Mask to get a comparison result, and verify if it is a logical false.

Declaration

public const uint MaskFalse = 32

Field Value

Type	Description
uint

MaskTrue

Mask to get a comparison result, and verify if it is a logical true.

Declaration

public const uint MaskTrue = 128

Field Value

Type	Description
uint

Properties

IsAllFalse

Gets a value indicating whether all of the compared components are false.

Declaration

public bool IsAllFalse { get; }

Property Value

Type	Description
bool

IsAllInBounds

Gets a value indicating whether all of the compared components are within set bounds.

Declaration

public bool IsAllInBounds { get; }

Property Value

Type	Description
bool

IsAllTrue

Gets a value indicating whether all of the compared components are true.

Declaration

public bool IsAllTrue { get; }

Property Value

Type	Description
bool

IsAnyFalse

Gets a value indicating whether any of the compared components are false.

Declaration

public bool IsAnyFalse { get; }

Property Value

Type	Description
bool

IsAnyOutOfBounds

Gets a value indicating whether any of the compared components are outside the set bounds.

Declaration

public bool IsAnyOutOfBounds { get; }

Property Value

Type	Description
bool

IsAnyTrue

Gets a value indicating whether any of the compared components are true

Declaration

public bool IsAnyTrue { get; }

Property Value

Type	Description
bool

IsMixed

Gets a value indicating whether the compared components had mixed results: some true and some false.

Declaration

public bool IsMixed { get; }

Property Value

Type	Description
bool

Methods

Equals(XMComparisonRecord)

Determines whether the specified object is equal to the current object.

Declaration

public bool Equals(XMComparisonRecord other)

Parameters

Type	Name	Description
XMComparisonRecord	other	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

Operators

operator ==(XMComparisonRecord, XMComparisonRecord)

Compares two XMComparisonRecord objects. The result specifies whether the values of the two objects are equal.

Declaration

public static bool operator ==(XMComparisonRecord left, XMComparisonRecord right)

Parameters

Type	Name	Description
XMComparisonRecord	left	The left XMComparisonRecord to compare.
XMComparisonRecord	right	The right XMComparisonRecord to compare.

Returns

Type	Description
bool	true if the values of left and right are equal; otherwise, false.

operator !=(XMComparisonRecord, XMComparisonRecord)

Compares two XMComparisonRecord objects. The result specifies whether the values of the two objects are unequal.

Declaration

public static bool operator !=(XMComparisonRecord left, XMComparisonRecord right)

Parameters

Type	Name	Description
XMComparisonRecord	left	The left XMComparisonRecord to compare.
XMComparisonRecord	right	The right XMComparisonRecord to compare.

Returns

Type	Description
bool	true if the values of left and right differ; otherwise, false.

Implements

IEquatable<T>