Struct int2 | Package Manager UI website
docs.unity.cn
    Show / Hide Table of Contents

    Struct int2

    Namespace: Unity.Mathematics
    Syntax
    [Serializable]
    public struct int2 : IEquatable<int2>, IFormattable

    Constructors

    int2(Boolean)

    Constructs a int2 vector from a single bool value by converting it to int and assigning it to every component.

    Declaration
    public int2(bool v)
    Parameters
    Type Name Description
    System.Boolean v

    int2(Double)

    Constructs a int2 vector from a single double value by converting it to int and assigning it to every component.

    Declaration
    public int2(double v)
    Parameters
    Type Name Description
    System.Double v

    int2(Int32)

    Constructs a int2 vector from a single int value by assigning it to every component.

    Declaration
    public int2(int v)
    Parameters
    Type Name Description
    System.Int32 v

    int2(Int32, Int32)

    Constructs a int2 vector from two int values.

    Declaration
    public int2(int x, int y)
    Parameters
    Type Name Description
    System.Int32 x
    System.Int32 y

    int2(Single)

    Constructs a int2 vector from a single float value by converting it to int and assigning it to every component.

    Declaration
    public int2(float v)
    Parameters
    Type Name Description
    System.Single v

    int2(UInt32)

    Constructs a int2 vector from a single uint value by converting it to int and assigning it to every component.

    Declaration
    public int2(uint v)
    Parameters
    Type Name Description
    System.UInt32 v

    int2(bool2)

    Constructs a int2 vector from a bool2 vector by componentwise conversion.

    Declaration
    public int2(bool2 v)
    Parameters
    Type Name Description
    bool2 v

    int2(double2)

    Constructs a int2 vector from a double2 vector by componentwise conversion.

    Declaration
    public int2(double2 v)
    Parameters
    Type Name Description
    double2 v

    int2(float2)

    Constructs a int2 vector from a float2 vector by componentwise conversion.

    Declaration
    public int2(float2 v)
    Parameters
    Type Name Description
    float2 v

    int2(int2)

    Constructs a int2 vector from an int2 vector.

    Declaration
    public int2(int2 xy)
    Parameters
    Type Name Description
    int2 xy

    int2(uint2)

    Constructs a int2 vector from a uint2 vector by componentwise conversion.

    Declaration
    public int2(uint2 v)
    Parameters
    Type Name Description
    uint2 v

    Fields

    x

    Declaration
    public int x
    Field Value
    Type Description
    System.Int32

    y

    Declaration
    public int y
    Field Value
    Type Description
    System.Int32

    zero

    int2 zero value.

    Declaration
    public static readonly int2 zero
    Field Value
    Type Description
    int2

    Properties

    Item[Int32]

    Returns the int element at a specified index.

    Declaration
    public int this[int index] { get; set; }
    Parameters
    Type Name Description
    System.Int32 index
    Property Value
    Type Description
    System.Int32

    xx

    Declaration
    public int2 xx { get; }
    Property Value
    Type Description
    int2

    xxx

    Declaration
    public int3 xxx { get; }
    Property Value
    Type Description
    int3

    xxxx

    Declaration
    public int4 xxxx { get; }
    Property Value
    Type Description
    int4

    xxxy

    Declaration
    public int4 xxxy { get; }
    Property Value
    Type Description
    int4

    xxy

    Declaration
    public int3 xxy { get; }
    Property Value
    Type Description
    int3

    xxyx

    Declaration
    public int4 xxyx { get; }
    Property Value
    Type Description
    int4

    xxyy

    Declaration
    public int4 xxyy { get; }
    Property Value
    Type Description
    int4

    xy

    Declaration
    public int2 xy { get; set; }
    Property Value
    Type Description
    int2

    xyx

    Declaration
    public int3 xyx { get; }
    Property Value
    Type Description
    int3

    xyxx

    Declaration
    public int4 xyxx { get; }
    Property Value
    Type Description
    int4

    xyxy

    Declaration
    public int4 xyxy { get; }
    Property Value
    Type Description
    int4

    xyy

    Declaration
    public int3 xyy { get; }
    Property Value
    Type Description
    int3

    xyyx

    Declaration
    public int4 xyyx { get; }
    Property Value
    Type Description
    int4

    xyyy

    Declaration
    public int4 xyyy { get; }
    Property Value
    Type Description
    int4

    yx

    Declaration
    public int2 yx { get; set; }
    Property Value
    Type Description
    int2

    yxx

    Declaration
    public int3 yxx { get; }
    Property Value
    Type Description
    int3

    yxxx

    Declaration
    public int4 yxxx { get; }
    Property Value
    Type Description
    int4

    yxxy

    Declaration
    public int4 yxxy { get; }
    Property Value
    Type Description
    int4

    yxy

    Declaration
    public int3 yxy { get; }
    Property Value
    Type Description
    int3

    yxyx

    Declaration
    public int4 yxyx { get; }
    Property Value
    Type Description
    int4

    yxyy

    Declaration
    public int4 yxyy { get; }
    Property Value
    Type Description
    int4

    yy

    Declaration
    public int2 yy { get; }
    Property Value
    Type Description
    int2

    yyx

    Declaration
    public int3 yyx { get; }
    Property Value
    Type Description
    int3

    yyxx

    Declaration
    public int4 yyxx { get; }
    Property Value
    Type Description
    int4

    yyxy

    Declaration
    public int4 yyxy { get; }
    Property Value
    Type Description
    int4

    yyy

    Declaration
    public int3 yyy { get; }
    Property Value
    Type Description
    int3

    yyyx

    Declaration
    public int4 yyyx { get; }
    Property Value
    Type Description
    int4

    yyyy

    Declaration
    public int4 yyyy { get; }
    Property Value
    Type Description
    int4

    Methods

    Equals(Object)

    Returns true if the int2 is equal to a given int2, false otherwise.

    Declaration
    public override bool Equals(object o)
    Parameters
    Type Name Description
    System.Object o
    Returns
    Type Description
    System.Boolean
    Overrides
    System.ValueType.Equals(System.Object)

    Equals(int2)

    Returns true if the int2 is equal to a given int2, false otherwise.

    Declaration
    public bool Equals(int2 rhs)
    Parameters
    Type Name Description
    int2 rhs
    Returns
    Type Description
    System.Boolean

    GetHashCode()

    Returns a hash code for the int2.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    System.ValueType.GetHashCode()

    ToString()

    Returns a string representation of the int2.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    System.ValueType.ToString()

    ToString(String, IFormatProvider)

    Returns a string representation of the int2 using a specified format and culture-specific format information.

    Declaration
    public string ToString(string format, IFormatProvider formatProvider)
    Parameters
    Type Name Description
    System.String format
    System.IFormatProvider formatProvider
    Returns
    Type Description
    System.String

    Operators

    Addition(Int32, int2)

    Returns the result of a componentwise addition operation on an int value and an int2 vector.

    Declaration
    public static int2 operator +(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    int2

    Addition(int2, Int32)

    Returns the result of a componentwise addition operation on an int2 vector and an int value.

    Declaration
    public static int2 operator +(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    int2

    Addition(int2, int2)

    Returns the result of a componentwise addition operation on two int2 vectors.

    Declaration
    public static int2 operator +(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    int2

    BitwiseAnd(Int32, int2)

    Returns the result of a componentwise bitwise and operation on an int value and an int2 vector.

    Declaration
    public static int2 operator &(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    int2

    BitwiseAnd(int2, Int32)

    Returns the result of a componentwise bitwise and operation on an int2 vector and an int value.

    Declaration
    public static int2 operator &(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    int2

    BitwiseAnd(int2, int2)

    Returns the result of a componentwise bitwise and operation on two int2 vectors.

    Declaration
    public static int2 operator &(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    int2

    BitwiseOr(Int32, int2)

    Returns the result of a componentwise bitwise or operation on an int value and an int2 vector.

    Declaration
    public static int2 operator |(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    int2

    BitwiseOr(int2, Int32)

    Returns the result of a componentwise bitwise or operation on an int2 vector and an int value.

    Declaration
    public static int2 operator |(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    int2

    BitwiseOr(int2, int2)

    Returns the result of a componentwise bitwise or operation on two int2 vectors.

    Declaration
    public static int2 operator |(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    int2

    Decrement(int2)

    Returns the result of a componentwise decrement operation on an int2 vector.

    Declaration
    public static int2 operator --(int2 val)
    Parameters
    Type Name Description
    int2 val
    Returns
    Type Description
    int2

    Division(Int32, int2)

    Returns the result of a componentwise division operation on an int value and an int2 vector.

    Declaration
    public static int2 operator /(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    int2

    Division(int2, Int32)

    Returns the result of a componentwise division operation on an int2 vector and an int value.

    Declaration
    public static int2 operator /(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    int2

    Division(int2, int2)

    Returns the result of a componentwise division operation on two int2 vectors.

    Declaration
    public static int2 operator /(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    int2

    Equality(Int32, int2)

    Returns the result of a componentwise equality operation on an int value and an int2 vector.

    Declaration
    public static bool2 operator ==(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    Equality(int2, Int32)

    Returns the result of a componentwise equality operation on an int2 vector and an int value.

    Declaration
    public static bool2 operator ==(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    bool2

    Equality(int2, int2)

    Returns the result of a componentwise equality operation on two int2 vectors.

    Declaration
    public static bool2 operator ==(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    ExclusiveOr(Int32, int2)

    Returns the result of a componentwise bitwise exclusive or operation on an int value and an int2 vector.

    Declaration
    public static int2 operator ^(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    int2

    ExclusiveOr(int2, Int32)

    Returns the result of a componentwise bitwise exclusive or operation on an int2 vector and an int value.

    Declaration
    public static int2 operator ^(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    int2

    ExclusiveOr(int2, int2)

    Returns the result of a componentwise bitwise exclusive or operation on two int2 vectors.

    Declaration
    public static int2 operator ^(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    int2

    Explicit(Boolean to int2)

    Explicitly converts a single bool value to a int2 vector by converting it to int and assigning it to every component.

    Declaration
    public static explicit operator int2(bool v)
    Parameters
    Type Name Description
    System.Boolean v
    Returns
    Type Description
    int2

    Explicit(Double to int2)

    Explicitly converts a single double value to a int2 vector by converting it to int and assigning it to every component.

    Declaration
    public static explicit operator int2(double v)
    Parameters
    Type Name Description
    System.Double v
    Returns
    Type Description
    int2

    Explicit(Single to int2)

    Explicitly converts a single float value to a int2 vector by converting it to int and assigning it to every component.

    Declaration
    public static explicit operator int2(float v)
    Parameters
    Type Name Description
    System.Single v
    Returns
    Type Description
    int2

    Explicit(UInt32 to int2)

    Explicitly converts a single uint value to a int2 vector by converting it to int and assigning it to every component.

    Declaration
    public static explicit operator int2(uint v)
    Parameters
    Type Name Description
    System.UInt32 v
    Returns
    Type Description
    int2

    Explicit(bool2 to int2)

    Explicitly converts a bool2 vector to a int2 vector by componentwise conversion.

    Declaration
    public static explicit operator int2(bool2 v)
    Parameters
    Type Name Description
    bool2 v
    Returns
    Type Description
    int2

    Explicit(double2 to int2)

    Explicitly converts a double2 vector to a int2 vector by componentwise conversion.

    Declaration
    public static explicit operator int2(double2 v)
    Parameters
    Type Name Description
    double2 v
    Returns
    Type Description
    int2

    Explicit(float2 to int2)

    Explicitly converts a float2 vector to a int2 vector by componentwise conversion.

    Declaration
    public static explicit operator int2(float2 v)
    Parameters
    Type Name Description
    float2 v
    Returns
    Type Description
    int2

    Explicit(uint2 to int2)

    Explicitly converts a uint2 vector to a int2 vector by componentwise conversion.

    Declaration
    public static explicit operator int2(uint2 v)
    Parameters
    Type Name Description
    uint2 v
    Returns
    Type Description
    int2

    GreaterThan(Int32, int2)

    Returns the result of a componentwise greater than operation on an int value and an int2 vector.

    Declaration
    public static bool2 operator>(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    GreaterThan(int2, Int32)

    Returns the result of a componentwise greater than operation on an int2 vector and an int value.

    Declaration
    public static bool2 operator>(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    bool2

    GreaterThan(int2, int2)

    Returns the result of a componentwise greater than operation on two int2 vectors.

    Declaration
    public static bool2 operator>(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    GreaterThanOrEqual(Int32, int2)

    Returns the result of a componentwise greater or equal operation on an int value and an int2 vector.

    Declaration
    public static bool2 operator >=(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    GreaterThanOrEqual(int2, Int32)

    Returns the result of a componentwise greater or equal operation on an int2 vector and an int value.

    Declaration
    public static bool2 operator >=(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    bool2

    GreaterThanOrEqual(int2, int2)

    Returns the result of a componentwise greater or equal operation on two int2 vectors.

    Declaration
    public static bool2 operator >=(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    Implicit(Int32 to int2)

    Implicitly converts a single int value to a int2 vector by assigning it to every component.

    Declaration
    public static implicit operator int2(int v)
    Parameters
    Type Name Description
    System.Int32 v
    Returns
    Type Description
    int2

    Increment(int2)

    Returns the result of a componentwise increment operation on an int2 vector.

    Declaration
    public static int2 operator ++(int2 val)
    Parameters
    Type Name Description
    int2 val
    Returns
    Type Description
    int2

    Inequality(Int32, int2)

    Returns the result of a componentwise not equal operation on an int value and an int2 vector.

    Declaration
    public static bool2 operator !=(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    Inequality(int2, Int32)

    Returns the result of a componentwise not equal operation on an int2 vector and an int value.

    Declaration
    public static bool2 operator !=(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    bool2

    Inequality(int2, int2)

    Returns the result of a componentwise not equal operation on two int2 vectors.

    Declaration
    public static bool2 operator !=(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    LeftShift(int2, Int32)

    Returns the result of a componentwise left shift operation on an int2 vector by a number of bits specified by a single int.

    Declaration
    public static int2 operator <<(int2 x, int n)
    Parameters
    Type Name Description
    int2 x
    System.Int32 n
    Returns
    Type Description
    int2

    LessThan(Int32, int2)

    Returns the result of a componentwise less than operation on an int value and an int2 vector.

    Declaration
    public static bool2 operator <(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    LessThan(int2, Int32)

    Returns the result of a componentwise less than operation on an int2 vector and an int value.

    Declaration
    public static bool2 operator <(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    bool2

    LessThan(int2, int2)

    Returns the result of a componentwise less than operation on two int2 vectors.

    Declaration
    public static bool2 operator <(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    LessThanOrEqual(Int32, int2)

    Returns the result of a componentwise less or equal operation on an int value and an int2 vector.

    Declaration
    public static bool2 operator <=(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    LessThanOrEqual(int2, Int32)

    Returns the result of a componentwise less or equal operation on an int2 vector and an int value.

    Declaration
    public static bool2 operator <=(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    bool2

    LessThanOrEqual(int2, int2)

    Returns the result of a componentwise less or equal operation on two int2 vectors.

    Declaration
    public static bool2 operator <=(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    bool2

    Modulus(Int32, int2)

    Returns the result of a componentwise modulus operation on an int value and an int2 vector.

    Declaration
    public static int2 operator %(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    int2

    Modulus(int2, Int32)

    Returns the result of a componentwise modulus operation on an int2 vector and an int value.

    Declaration
    public static int2 operator %(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    int2

    Modulus(int2, int2)

    Returns the result of a componentwise modulus operation on two int2 vectors.

    Declaration
    public static int2 operator %(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    int2

    Multiply(Int32, int2)

    Returns the result of a componentwise multiplication operation on an int value and an int2 vector.

    Declaration
    public static int2 operator *(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    int2

    Multiply(int2, Int32)

    Returns the result of a componentwise multiplication operation on an int2 vector and an int value.

    Declaration
    public static int2 operator *(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    int2

    Multiply(int2, int2)

    Returns the result of a componentwise multiplication operation on two int2 vectors.

    Declaration
    public static int2 operator *(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    int2

    OnesComplement(int2)

    Returns the result of a componentwise bitwise not operation on an int2 vector.

    Declaration
    public static int2 operator ~(int2 val)
    Parameters
    Type Name Description
    int2 val
    Returns
    Type Description
    int2

    RightShift(int2, Int32)

    Returns the result of a componentwise right shift operation on an int2 vector by a number of bits specified by a single int.

    Declaration
    public static int2 operator >>(int2 x, int n)
    Parameters
    Type Name Description
    int2 x
    System.Int32 n
    Returns
    Type Description
    int2

    Subtraction(Int32, int2)

    Returns the result of a componentwise subtraction operation on an int value and an int2 vector.

    Declaration
    public static int2 operator -(int lhs, int2 rhs)
    Parameters
    Type Name Description
    System.Int32 lhs
    int2 rhs
    Returns
    Type Description
    int2

    Subtraction(int2, Int32)

    Returns the result of a componentwise subtraction operation on an int2 vector and an int value.

    Declaration
    public static int2 operator -(int2 lhs, int rhs)
    Parameters
    Type Name Description
    int2 lhs
    System.Int32 rhs
    Returns
    Type Description
    int2

    Subtraction(int2, int2)

    Returns the result of a componentwise subtraction operation on two int2 vectors.

    Declaration
    public static int2 operator -(int2 lhs, int2 rhs)
    Parameters
    Type Name Description
    int2 lhs
    int2 rhs
    Returns
    Type Description
    int2

    UnaryNegation(int2)

    Returns the result of a componentwise unary minus operation on an int2 vector.

    Declaration
    public static int2 operator -(int2 val)
    Parameters
    Type Name Description
    int2 val
    Returns
    Type Description
    int2

    UnaryPlus(int2)

    Returns the result of a componentwise unary plus operation on an int2 vector.

    Declaration
    public static int2 operator +(int2 val)
    Parameters
    Type Name Description
    int2 val
    Returns
    Type Description
    int2
    Back to top Copyright © 2019 Unity Technologies
    Generated by DocFX