Vector2I

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.Vector2I
Namespace	Electron2D
Kind	struct
Category	Math and Data

Overview

Represents the vector2 i value type.

Syntax

public struct Electron2D.Vector2I : System.IEquatable<Electron2D.Vector2I>

Remarks

This type is part of the Electron2D 0.1.0 Preview public API.

Thread Safety

Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
Down	Field	Represents the down value.
Left	Field	Represents the left value.
One	Field	Represents the one value.
Right	Field	Represents the right value.
Up	Field	Represents the up value.
Zero	Field	Represents the zero value.
X	Property	Gets or sets the x value.
Y	Property	Gets or sets the y value.
Electron2D.Vector2I(System.Int32, System.Int32)	Constructor	Initializes a new instance of the Vector2I type.
Abs()	Method	Executes the abs operation.
Aspect()	Method	Executes the aspect operation.
Clamp(Electron2D.Vector2I, Electron2D.Vector2I)	Method	Executes the clamp operation.
Equals(Electron2D.Vector2I)	Method	Executes the equals operation.
Equals(System.Object)	Method	Executes the equals operation.
GetHashCode()	Method	Gets the hash code value.
Length()	Method	Executes the length operation.
LengthSquared()	Method	Executes the length squared operation.
Max(Electron2D.Vector2I)	Method	Executes the max operation.
Min(Electron2D.Vector2I)	Method	Executes the min operation.
Sign()	Method	Executes the sign operation.
ToString()	Method	Executes the to string operation.
op_Addition(Electron2D.Vector2I, Electron2D.Vector2I)	Method	Applies the + operator.
op_Division(Electron2D.Vector2I, Electron2D.Vector2I)	Method	Applies the / operator.
op_Division(Electron2D.Vector2I, System.Int32)	Method	Applies the / operator.
op_Equality(Electron2D.Vector2I, Electron2D.Vector2I)	Method	Applies the == operator.
op_Explicit(Electron2D.Vector2)	Method	Converts the supplied value to the target type.
op_Implicit(Electron2D.Vector2I)	Method	Converts the supplied value to the target type.
op_Inequality(Electron2D.Vector2I, Electron2D.Vector2I)	Method	Applies the != operator.
op_Modulus(Electron2D.Vector2I, Electron2D.Vector2I)	Method	Applies the % operator.
op_Multiply(Electron2D.Vector2I, Electron2D.Vector2I)	Method	Applies the * operator.
op_Multiply(Electron2D.Vector2I, System.Int32)	Method	Applies the * operator.
op_Multiply(System.Int32, Electron2D.Vector2I)	Method	Applies the * operator.
op_Subtraction(Electron2D.Vector2I, Electron2D.Vector2I)	Method	Applies the - operator.
op_UnaryNegation(Electron2D.Vector2I)	Method	Applies the - operator.

Member Details

Down

Kind: Field

public static Electron2D.Vector2I Down

Summary

Represents the down value.

Remarks

Use this field as a stable value supplied by the declaring type.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Left

Kind: Field

public static Electron2D.Vector2I Left

Summary

Represents the left value.

Remarks

Use this field as a stable value supplied by the declaring type.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

One

Kind: Field

public static Electron2D.Vector2I One

Summary

Represents the one value.

Remarks

Use this field as a stable value supplied by the declaring type.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Right

Kind: Field

public static Electron2D.Vector2I Right

Summary

Represents the right value.

Remarks

Use this field as a stable value supplied by the declaring type.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Up

Kind: Field

public static Electron2D.Vector2I Up

Summary

Represents the up value.

Remarks

Use this field as a stable value supplied by the declaring type.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Zero

Kind: Field

public static Electron2D.Vector2I Zero

Summary

Represents the zero value.

Remarks

Use this field as a stable value supplied by the declaring type.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

X

Kind: Property

public System.Int32 X { get; set; }

Summary

Gets or sets the x value.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current x value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Y

Kind: Property

public System.Int32 Y { get; set; }

Summary

Gets or sets the y value.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current y value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Electron2D.Vector2I(System.Int32, System.Int32)

Kind: Constructor

public Electron2D.Vector2I(System.Int32 x, System.Int32 y)

Summary

Initializes a new instance of the Vector2I type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Parameters

• x: The X coordinate or component.
• y: The Y coordinate or component.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Abs()

Kind: Method

public Electron2D.Vector2I Abs()()

Summary

Executes the abs operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Aspect()

Kind: Method

public System.Single Aspect()()

Summary

Executes the aspect operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Clamp(Electron2D.Vector2I, Electron2D.Vector2I)

Kind: Method

public Electron2D.Vector2I Clamp(Electron2D.Vector2I, Electron2D.Vector2I)(Electron2D.Vector2I min, Electron2D.Vector2I max)

Summary

Executes the clamp operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• min: The min value.
• max: The max value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Equals(Electron2D.Vector2I)

Kind: Method

public System.Boolean Equals(Electron2D.Vector2I)(Electron2D.Vector2I other)

Summary

Executes the equals operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• other: The other value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Equals(System.Object)

Kind: Method

public System.Boolean Equals(System.Object)(System.Object obj)

Summary

Executes the equals operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• obj: The obj value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

GetHashCode()

Kind: Method

public System.Int32 GetHashCode()()

Summary

Gets the hash code value.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The current hash code value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Length()

Kind: Method

public System.Single Length()()

Summary

Executes the length operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

LengthSquared()

Kind: Method

public System.Int32 LengthSquared()()

Summary

Executes the length squared operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Max(Electron2D.Vector2I)

Kind: Method

public Electron2D.Vector2I Max(Electron2D.Vector2I)(Electron2D.Vector2I with)

Summary

Executes the max operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• with: The with value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Min(Electron2D.Vector2I)

Kind: Method

public Electron2D.Vector2I Min(Electron2D.Vector2I)(Electron2D.Vector2I with)

Summary

Executes the min operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Parameters

• with: The with value.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

Sign()

Kind: Method

public Electron2D.Vector2I Sign()()

Summary

Executes the sign operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

ToString()

Kind: Method

public System.String ToString()()

Summary

Executes the to string operation.

Remarks

This method follows the validation and lifetime rules of its declaring type.

Returns

The result of the operation.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Addition(Electron2D.Vector2I, Electron2D.Vector2I)

Kind: Method

public static Electron2D.Vector2I op_Addition(Electron2D.Vector2I, Electron2D.Vector2I)(Electron2D.Vector2I left, Electron2D.Vector2I right)

Summary

Applies the + operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left value.
• right: The right value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Division(Electron2D.Vector2I, Electron2D.Vector2I)

Kind: Method

public static Electron2D.Vector2I op_Division(Electron2D.Vector2I, Electron2D.Vector2I)(Electron2D.Vector2I left, Electron2D.Vector2I right)

Summary

Applies the / operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left value.
• right: The right value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Division(Electron2D.Vector2I, System.Int32)

Kind: Method

public static Electron2D.Vector2I op_Division(Electron2D.Vector2I, System.Int32)(Electron2D.Vector2I value, System.Int32 scalar)

Summary

Applies the / operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• value: The value to use.
• scalar: The scalar value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Equality(Electron2D.Vector2I, Electron2D.Vector2I)

Kind: Method

public static System.Boolean op_Equality(Electron2D.Vector2I, Electron2D.Vector2I)(Electron2D.Vector2I left, Electron2D.Vector2I right)

Summary

Applies the == operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left value.
• right: The right value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Explicit(Electron2D.Vector2)

Kind: Method

public static Electron2D.Vector2I op_Explicit(Electron2D.Vector2)(Electron2D.Vector2 value)

Summary

Converts the supplied value to the target type.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Implicit(Electron2D.Vector2I)

Kind: Method

public static Electron2D.Vector2 op_Implicit(Electron2D.Vector2I)(Electron2D.Vector2I value)

Summary

Converts the supplied value to the target type.

Remarks

The conversion follows the validation rules of the source and target types.

Parameters

• value: The value to use.

Returns

The converted value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Inequality(Electron2D.Vector2I, Electron2D.Vector2I)

Kind: Method

public static System.Boolean op_Inequality(Electron2D.Vector2I, Electron2D.Vector2I)(Electron2D.Vector2I left, Electron2D.Vector2I right)

Summary

Applies the != operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left value.
• right: The right value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Modulus(Electron2D.Vector2I, Electron2D.Vector2I)

Kind: Method

public static Electron2D.Vector2I op_Modulus(Electron2D.Vector2I, Electron2D.Vector2I)(Electron2D.Vector2I left, Electron2D.Vector2I right)

Summary

Applies the % operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left value.
• right: The right value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Multiply(Electron2D.Vector2I, Electron2D.Vector2I)

Kind: Method

public static Electron2D.Vector2I op_Multiply(Electron2D.Vector2I, Electron2D.Vector2I)(Electron2D.Vector2I left, Electron2D.Vector2I right)

Summary

Applies the * operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left value.
• right: The right value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Multiply(Electron2D.Vector2I, System.Int32)

Kind: Method

public static Electron2D.Vector2I op_Multiply(Electron2D.Vector2I, System.Int32)(Electron2D.Vector2I value, System.Int32 scalar)

Summary

Applies the * operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• value: The value to use.
• scalar: The scalar value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Multiply(System.Int32, Electron2D.Vector2I)

Kind: Method

public static Electron2D.Vector2I op_Multiply(System.Int32, Electron2D.Vector2I)(System.Int32 scalar, Electron2D.Vector2I value)

Summary

Applies the * operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• scalar: The scalar value.
• value: The value to use.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_Subtraction(Electron2D.Vector2I, Electron2D.Vector2I)

Kind: Method

public static Electron2D.Vector2I op_Subtraction(Electron2D.Vector2I, Electron2D.Vector2I)(Electron2D.Vector2I left, Electron2D.Vector2I right)

Summary

Applies the - operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• left: The left value.
• right: The right value.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I

op_UnaryNegation(Electron2D.Vector2I)

Kind: Method

public static Electron2D.Vector2I op_UnaryNegation(Electron2D.Vector2I)(Electron2D.Vector2I value)

Summary

Applies the - operator.

Remarks

This operator returns a value derived from the supplied operands.

Parameters

• value: The value to use.

Returns

The result of the operator.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.Vector2I