Struct PrimitiveValue

A union holding a primitive value.

Namespace: UnityEngine.InputSystem.Utilities
Syntax
public struct PrimitiveValue : IEquatable<PrimitiveValue>, IConvertible
Remarks

This structure is used for storing things such as default values for controls (see defaultState). It can store one value of any primitive, non-reference C# type (bool, char, int, float, etc).

Constructors

PrimitiveValue(Boolean)

Declaration
public PrimitiveValue(bool value)
Parameters
Type Name Description
System.Boolean value

PrimitiveValue(Byte)

Declaration
public PrimitiveValue(byte value)
Parameters
Type Name Description
System.Byte value

PrimitiveValue(Char)

Declaration
public PrimitiveValue(char value)
Parameters
Type Name Description
System.Char value

PrimitiveValue(Double)

Declaration
public PrimitiveValue(double value)
Parameters
Type Name Description
System.Double value

PrimitiveValue(Int16)

Declaration
public PrimitiveValue(short value)
Parameters
Type Name Description
System.Int16 value

PrimitiveValue(Int32)

Declaration
public PrimitiveValue(int value)
Parameters
Type Name Description
System.Int32 value

PrimitiveValue(Int64)

Declaration
public PrimitiveValue(long value)
Parameters
Type Name Description
System.Int64 value

PrimitiveValue(SByte)

Declaration
public PrimitiveValue(sbyte value)
Parameters
Type Name Description
System.SByte value

PrimitiveValue(Single)

Declaration
public PrimitiveValue(float value)
Parameters
Type Name Description
System.Single value

PrimitiveValue(UInt16)

Declaration
public PrimitiveValue(ushort value)
Parameters
Type Name Description
System.UInt16 value

PrimitiveValue(UInt32)

Declaration
public PrimitiveValue(uint value)
Parameters
Type Name Description
System.UInt32 value

PrimitiveValue(UInt64)

Declaration
public PrimitiveValue(ulong value)
Parameters
Type Name Description
System.UInt64 value

Properties

isEmpty

If true, the struct does not contain a primitive value (i.e. has type System.TypeCode.Empty).

Declaration
public bool isEmpty { get; }
Property Value
Type Description
System.Boolean

type

Type of value stored in the struct. System.TypeCode.Empty if the struct does not hold a value (i.e. has been default-initialized).

Declaration
public TypeCode type { get; }
Property Value
Type Description
System.TypeCode

Methods

ConvertTo(TypeCode)

Declaration
public PrimitiveValue ConvertTo(TypeCode type)
Parameters
Type Name Description
System.TypeCode type
Returns
Type Description
PrimitiveValue

Equals(Object)

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

Equals(PrimitiveValue)

Declaration
public bool Equals(PrimitiveValue other)
Parameters
Type Name Description
PrimitiveValue other
Returns
Type Description
System.Boolean

From<TValue>(TValue)

Declaration
public static PrimitiveValue From<TValue>(TValue value)
    where TValue : struct
Parameters
Type Name Description
TValue value
Returns
Type Description
PrimitiveValue
Type Parameters
Name Description
TValue

FromBoolean(Boolean)

Declaration
public static PrimitiveValue FromBoolean(bool value)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
PrimitiveValue

FromByte(Byte)

Declaration
public static PrimitiveValue FromByte(byte value)
Parameters
Type Name Description
System.Byte value
Returns
Type Description
PrimitiveValue

FromChar(Char)

Declaration
public static PrimitiveValue FromChar(char value)
Parameters
Type Name Description
System.Char value
Returns
Type Description
PrimitiveValue

FromDouble(Double)

Declaration
public static PrimitiveValue FromDouble(double value)
Parameters
Type Name Description
System.Double value
Returns
Type Description
PrimitiveValue

FromInt16(Int16)

Declaration
public static PrimitiveValue FromInt16(short value)
Parameters
Type Name Description
System.Int16 value
Returns
Type Description
PrimitiveValue

FromInt32(Int32)

Declaration
public static PrimitiveValue FromInt32(int value)
Parameters
Type Name Description
System.Int32 value
Returns
Type Description
PrimitiveValue

FromInt64(Int64)

Declaration
public static PrimitiveValue FromInt64(long value)
Parameters
Type Name Description
System.Int64 value
Returns
Type Description
PrimitiveValue

FromObject(Object)

Declaration
public static PrimitiveValue FromObject(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
PrimitiveValue

FromSByte(SByte)

Declaration
public static PrimitiveValue FromSByte(sbyte value)
Parameters
Type Name Description
System.SByte value
Returns
Type Description
PrimitiveValue

FromSingle(Single)

Declaration
public static PrimitiveValue FromSingle(float value)
Parameters
Type Name Description
System.Single value
Returns
Type Description
PrimitiveValue

FromString(String)

Declaration
public static PrimitiveValue FromString(string value)
Parameters
Type Name Description
System.String value
Returns
Type Description
PrimitiveValue

FromUInt16(UInt16)

Declaration
public static PrimitiveValue FromUInt16(ushort value)
Parameters
Type Name Description
System.UInt16 value
Returns
Type Description
PrimitiveValue

FromUInt32(UInt32)

Declaration
public static PrimitiveValue FromUInt32(uint value)
Parameters
Type Name Description
System.UInt32 value
Returns
Type Description
PrimitiveValue

FromUInt64(UInt64)

Declaration
public static PrimitiveValue FromUInt64(ulong value)
Parameters
Type Name Description
System.UInt64 value
Returns
Type Description
PrimitiveValue

GetHashCode()

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

GetTypeCode()

Declaration
public TypeCode GetTypeCode()
Returns
Type Description
System.TypeCode

ToBoolean(IFormatProvider)

Declaration
public bool ToBoolean(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.Boolean

ToByte(IFormatProvider)

Declaration
public byte ToByte(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.Byte

ToChar(IFormatProvider)

Declaration
public char ToChar(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.Char

ToDateTime(IFormatProvider)

Declaration
public DateTime ToDateTime(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.DateTime

ToDecimal(IFormatProvider)

Declaration
public decimal ToDecimal(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.Decimal

ToDouble(IFormatProvider)

Declaration
public double ToDouble(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.Double

ToInt16(IFormatProvider)

Declaration
public short ToInt16(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.Int16

ToInt32(IFormatProvider)

Declaration
public int ToInt32(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.Int32

ToInt64(IFormatProvider)

Declaration
public long ToInt64(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.Int64

ToObject()

Declaration
public object ToObject()
Returns
Type Description
System.Object

ToSByte(IFormatProvider)

Declaration
public sbyte ToSByte(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.SByte

ToSingle(IFormatProvider)

Declaration
public float ToSingle(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.Single

ToString()

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

ToString(IFormatProvider)

Declaration
public string ToString(IFormatProvider provider)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.String

ToType(Type, IFormatProvider)

Declaration
public object ToType(Type conversionType, IFormatProvider provider)
Parameters
Type Name Description
System.Type conversionType
System.IFormatProvider provider
Returns
Type Description
System.Object

ToUInt16(IFormatProvider)

Declaration
public ushort ToUInt16(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.UInt16

ToUInt32(IFormatProvider)

Declaration
public uint ToUInt32(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.UInt32

ToUInt64(IFormatProvider)

Declaration
public ulong ToUInt64(IFormatProvider provider = null)
Parameters
Type Name Description
System.IFormatProvider provider
Returns
Type Description
System.UInt64

Operators

Equality(PrimitiveValue, PrimitiveValue)

Declaration
public static bool operator ==(PrimitiveValue left, PrimitiveValue right)
Parameters
Type Name Description
PrimitiveValue left
PrimitiveValue right
Returns
Type Description
System.Boolean

Implicit(Boolean to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(bool value)
Parameters
Type Name Description
System.Boolean value
Returns
Type Description
PrimitiveValue

Implicit(Byte to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(byte value)
Parameters
Type Name Description
System.Byte value
Returns
Type Description
PrimitiveValue

Implicit(Char to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(char value)
Parameters
Type Name Description
System.Char value
Returns
Type Description
PrimitiveValue

Implicit(Double to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(double value)
Parameters
Type Name Description
System.Double value
Returns
Type Description
PrimitiveValue

Implicit(Int16 to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(short value)
Parameters
Type Name Description
System.Int16 value
Returns
Type Description
PrimitiveValue

Implicit(Int32 to PrimitiveValue)

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

Implicit(Int64 to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(long value)
Parameters
Type Name Description
System.Int64 value
Returns
Type Description
PrimitiveValue

Implicit(SByte to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(sbyte value)
Parameters
Type Name Description
System.SByte value
Returns
Type Description
PrimitiveValue

Implicit(Single to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(float value)
Parameters
Type Name Description
System.Single value
Returns
Type Description
PrimitiveValue

Implicit(UInt16 to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(ushort value)
Parameters
Type Name Description
System.UInt16 value
Returns
Type Description
PrimitiveValue

Implicit(UInt32 to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(uint value)
Parameters
Type Name Description
System.UInt32 value
Returns
Type Description
PrimitiveValue

Implicit(UInt64 to PrimitiveValue)

Declaration
public static implicit operator PrimitiveValue(ulong value)
Parameters
Type Name Description
System.UInt64 value
Returns
Type Description
PrimitiveValue

Inequality(PrimitiveValue, PrimitiveValue)

Declaration
public static bool operator !=(PrimitiveValue left, PrimitiveValue right)
Parameters
Type Name Description
PrimitiveValue left
PrimitiveValue right
Returns
Type Description
System.Boolean