Struct Int4

Namespace

Stride.Core.Mathematics

Assembly

Stride.Core.Mathematics.dll

Represents a four dimensional mathematical vector.

[DataContract("Int4")]
[DataStyle(DataStyle.Compact)]
public struct Int4 : IEquatable<Int4>, IFormattable

Implements

IEquatable<Int4>

IFormattable

Constructors

Int4(int)

Initializes a new instance of the Int4 struct.

public Int4(int value)

Parameters

value int

The value that will be assigned to all components.

Int4(int, int, int, int)

Initializes a new instance of the Int4 struct.

public Int4(int x, int y, int z, int w)

Parameters

x int

Initial value for the X component of the vector.

y int

Initial value for the Y component of the vector.

z int

Initial value for the Z component of the vector.

w int

Initial value for the W component of the vector.

Int4(int[])

Initializes a new instance of the Int4 struct.

public Int4(int[] values)

Parameters

values int[]

The values to assign to the X, Y, Z, and W components of the vector. This must be an array with four elements.

Exceptions

ArgumentNullException

Thrown when values is null.

ArgumentOutOfRangeException

Thrown when values contains more or less than four elements.

Fields

One

A Int4 with all of its components set to one.

public static readonly Int4 One

Field Value

Int4

SizeInBytes

The size of the Int4 type, in bytes.

public static readonly int SizeInBytes

Field Value

int

UnitW

The W unit Int4 (0, 0, 0, 1).

public static readonly Int4 UnitW

Field Value

Int4

UnitX

The X unit Int4 (1, 0, 0, 0).

public static readonly Int4 UnitX

Field Value

Int4

UnitY

The Y unit Int4 (0, 1, 0, 0).

public static readonly Int4 UnitY

Field Value

Int4

UnitZ

The Z unit Int4 (0, 0, 1, 0).

public static readonly Int4 UnitZ

Field Value

Int4

W

The W component of the vector.

[DataMember(3)]
public int W

Field Value

int

X

The X component of the vector.

[DataMember(0)]
public int X

Field Value

int

Y

The Y component of the vector.

[DataMember(1)]
public int Y

Field Value

int

Z

The Z component of the vector.

[DataMember(2)]
public int Z

Field Value

int

Zero

A Int4 with all of its components set to zero.

public static readonly Int4 Zero

Field Value

Int4

Properties

this[int]

Gets or sets the component at the specified index.

public int this[int index] { get; set; }

Parameters

index int

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.

Property Value

int

The value of the X, Y, Z, or W component, depending on the index.

Exceptions

ArgumentOutOfRangeException

Thrown when the index is out of the range [0, 3].

Methods

Add(Int4, Int4)

Adds two vectors.

public static Int4 Add(Int4 left, Int4 right)

Parameters

left Int4

The first vector to add.

right Int4

The second vector to add.

Returns

Int4

The sum of the two vectors.

Add(ref readonly Int4, ref readonly Int4, out Int4)

Adds two vectors.

public static void Add(ref readonly Int4 left, ref readonly Int4 right, out Int4 result)

Parameters

left Int4

The first vector to add.

right Int4

The second vector to add.

result Int4

When the method completes, contains the sum of the two vectors.

Clamp(Int4, Int4, Int4)

Restricts a value to be within a specified range.

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

Parameters

value Int4

The value to clamp.

min Int4

The minimum value.

max Int4

The maximum value.

Returns

Int4

The clamped value.

Clamp(ref readonly Int4, ref readonly Int4, ref readonly Int4, out Int4)

Restricts a value to be within a specified range.

public static void Clamp(ref readonly Int4 value, ref readonly Int4 min, ref readonly Int4 max, out Int4 result)

Parameters

value Int4

The value to clamp.

min Int4

The minimum value.

max Int4

The maximum value.

result Int4

When the method completes, contains the clamped value.

Deconstruct(out int, out int, out int, out int)

Deconstructs the vector's components into named variables.

public void Deconstruct(out int x, out int y, out int z, out int w)

Parameters

x int

The X component

y int

The Y component

z int

The Z component

w int

The W component

Divide(Int4, int)

Scales a vector by the given value.

public static Int4 Divide(Int4 value, int scale)

Parameters

value Int4

The vector to scale.

scale int

The amount by which to scale the vector.

Returns

Int4

The scaled vector.

Divide(ref readonly Int4, int, out Int4)

Scales a vector by the given value.

public static void Divide(ref readonly Int4 value, int scale, out Int4 result)

Parameters

value Int4

The vector to scale.

scale int

The amount by which to scale the vector.

result Int4

When the method completes, contains the scaled vector.

Equals(Int4)

Determines whether the specified Int4 is equal to this instance.

public bool Equals(Int4 other)

Parameters

other Int4

The Int4 to compare with this instance.

Returns

bool

true if the specified Int4 is equal to this instance; otherwise, false.

Equals(object)

Determines whether the specified object is equal to this instance.

public override bool Equals(object value)

Parameters

value object

The object to compare with this instance.

Returns

bool

true if the specified object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Length()

Calculates the length of the vector.

public int Length()

Returns

int

The length of the vector.

Remarks

LengthSquared() may be preferred when only the relative length is needed and speed is of the essence.

LengthSquared()

Calculates the squared length of the vector.

public int LengthSquared()

Returns

int

The squared length of the vector.

Remarks

This method may be preferred to Length() when only a relative length is needed and speed is of the essence.

Max(Int4, Int4)

Returns a vector containing the largest components of the specified vectors.

public static Int4 Max(Int4 left, Int4 right)

Parameters

left Int4

The first source vector.

right Int4

The second source vector.

Returns

Int4

A vector containing the largest components of the source vectors.

Max(ref readonly Int4, ref readonly Int4, out Int4)

Returns a vector containing the smallest components of the specified vectors.

public static void Max(ref readonly Int4 left, ref readonly Int4 right, out Int4 result)

Parameters

left Int4

The first source vector.

right Int4

The second source vector.

result Int4

When the method completes, contains an new vector composed of the largest components of the source vectors.

Min(Int4, Int4)

Returns a vector containing the smallest components of the specified vectors.

public static Int4 Min(Int4 left, Int4 right)

Parameters

left Int4

The first source vector.

right Int4

The second source vector.

Returns

Int4

A vector containing the smallest components of the source vectors.

Min(ref readonly Int4, ref readonly Int4, out Int4)

Returns a vector containing the smallest components of the specified vectors.

public static void Min(ref readonly Int4 left, ref readonly Int4 right, out Int4 result)

Parameters

left Int4

The first source vector.

right Int4

The second source vector.

result Int4

When the method completes, contains an new vector composed of the smallest components of the source vectors.

Modulate(Int4, Int4)

Modulates a vector with another by performing component-wise multiplication.

public static Int4 Modulate(Int4 left, Int4 right)

Parameters

left Int4

The first vector to modulate.

right Int4

The second vector to modulate.

Returns

Int4

The modulated vector.

Modulate(ref readonly Int4, ref readonly Int4, out Int4)

Modulates a vector with another by performing component-wise multiplication.

public static void Modulate(ref readonly Int4 left, ref readonly Int4 right, out Int4 result)

Parameters

left Int4

The first vector to modulate.

right Int4

The second vector to modulate.

result Int4

When the method completes, contains the modulated vector.

Multiply(Int4, int)

Scales a vector by the given value.

public static Int4 Multiply(Int4 value, int scale)

Parameters

value Int4

The vector to scale.

scale int

The amount by which to scale the vector.

Returns

Int4

The scaled vector.

Multiply(ref readonly Int4, int, out Int4)

Scales a vector by the given value.

public static void Multiply(ref readonly Int4 value, int scale, out Int4 result)

Parameters

value Int4

The vector to scale.

scale int

The amount by which to scale the vector.

result Int4

When the method completes, contains the scaled vector.

Negate(Int4)

Reverses the direction of a given vector.

public static Int4 Negate(Int4 value)

Parameters

value Int4

The vector to negate.

Returns

Int4

A vector facing in the opposite direction.

Negate(ref readonly Int4, out Int4)

Reverses the direction of a given vector.

public static void Negate(ref readonly Int4 value, out Int4 result)

Parameters

value Int4

The vector to negate.

result Int4

When the method completes, contains a vector facing in the opposite direction.

Subtract(Int4, Int4)

Subtracts two vectors.

public static Int4 Subtract(Int4 left, Int4 right)

Parameters

left Int4

The first vector to subtract.

right Int4

The second vector to subtract.

Returns

Int4

The difference of the two vectors.

Subtract(ref readonly Int4, ref readonly Int4, out Int4)

Subtracts two vectors.

public static void Subtract(ref readonly Int4 left, ref readonly Int4 right, out Int4 result)

Parameters

left Int4

The first vector to subtract.

right Int4

The second vector to subtract.

result Int4

When the method completes, contains the difference of the two vectors.

ToArray()

Creates an array containing the elements of the vector.

public int[] ToArray()

Returns

int[]

A four-element array containing the components of the vector.

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns

string

A string that represents this instance.

ToString(IFormatProvider)

Returns a string that represents this instance.

public string ToString(IFormatProvider formatProvider)

Parameters

formatProvider IFormatProvider

The format provider.

Returns

string

A string that represents this instance.

ToString(string)

Returns a string that represents this instance.

public string ToString(string format)

Parameters

format string

The format.

Returns

string

A string that represents this instance.

ToString(string, IFormatProvider)

Returns a string that represents this instance.

public string ToString(string format, IFormatProvider formatProvider)

Parameters

format string

The format.

formatProvider IFormatProvider

The format provider.

Returns

string

A string that represents this instance.

Operators

operator +(Int4, Int4)

Adds two vectors.

public static Int4 operator +(Int4 left, Int4 right)

Parameters

left Int4

The first vector to add.

right Int4

The second vector to add.

Returns

Int4

The sum of the two vectors.

operator /(Int4, int)

Scales a vector by the given value.

public static Int4 operator /(Int4 value, int scale)

Parameters

value Int4

The vector to scale.

scale int

The amount by which to scale the vector.

Returns

Int4

The scaled vector.

operator ==(Int4, Int4)

Tests for equality between two objects.

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

Parameters

left Int4

The first value to compare.

right Int4

The second value to compare.

Returns

bool

true if left has the same value as right; otherwise, false.

explicit operator Vector2(Int4)

Performs an explicit conversion from Int4 to Vector2.

public static explicit operator Vector2(Int4 value)

Parameters

value Int4

The value.

Returns

Vector2

The result of the conversion.

explicit operator Vector3(Int4)

Performs an explicit conversion from Int4 to Vector3.

public static explicit operator Vector3(Int4 value)

Parameters

value Int4

The value.

Returns

Vector3

The result of the conversion.

explicit operator Vector4(Int4)

Performs an explicit conversion from Int4 to Vector4.

public static explicit operator Vector4(Int4 value)

Parameters

value Int4

The value.

Returns

Vector4

The result of the conversion.

implicit operator int[](Int4)

Performs an implicit conversion from Int4 to int array.

public static implicit operator int[](Int4 input)

Parameters

input Int4

The input.

Returns

int[]

The result of the conversion.

implicit operator Int4(int[])

Performs an implicit conversion from int array to Int4.

public static implicit operator Int4(int[] input)

Parameters

input int[]

The input.

Returns

Int4

The result of the conversion.

operator !=(Int4, Int4)

Tests for inequality between two objects.

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

Parameters

left Int4

The first value to compare.

right Int4

The second value to compare.

Returns

bool

true if left has a different value than right; otherwise, false.

operator *(Int4, int)

Scales a vector by the given value.

public static Int4 operator *(Int4 value, int scale)

Parameters

value Int4

The vector to scale.

scale int

The amount by which to scale the vector.

Returns

Int4

The scaled vector.

operator *(int, Int4)

Scales a vector by the given value.

public static Int4 operator *(int scale, Int4 value)

Parameters

scale int

The amount by which to scale the vector.

value Int4

The vector to scale.

Returns

Int4

The scaled vector.

operator -(Int4, Int4)

Subtracts two vectors.

public static Int4 operator -(Int4 left, Int4 right)

Parameters

left Int4

The first vector to subtract.

right Int4

The second vector to subtract.

Returns

Int4

The difference of the two vectors.

operator -(Int4)

Reverses the direction of a given vector.

public static Int4 operator -(Int4 value)

Parameters

value Int4

The vector to negate.

Returns

Int4

A vector facing in the opposite direction.

operator +(Int4)

Assert a vector (return it unchanged).

public static Int4 operator +(Int4 value)

Parameters

value Int4

The vector to assert (unchange).

Returns

Int4

The asserted (unchanged) vector.