API reference
API reference
Select your platform
No SDKs available
No versions available

XrDuration Struct

Extends IEquatable< XrDuration >, IComparable< XrDuration >
Represents a time duration.
This is used by many OpenXR functions that require the caller to specify a time duration. An XrDuration has nanosecond precision.

Constructors

XrDuration ( value )
Constructs an XrDuration from a TimeSpan.
Signature
XrDuration(TimeSpan value)
Parameters
value: TimeSpan  The TimeSpan to convert to a XrDuration.

Fields

_value : readonly long
Signature
readonly long _value

Static Fields

Infinity : readonly XrDuration
An infinite time duration.
Signature
readonly XrDuration Infinity
Zero : readonly XrDuration
No time duration.
Signature
readonly XrDuration Zero

Properties

Nanoseconds : long
[Get]
The raw value of the XrDuration, represented as a number of nanoseconds.
Signature
long Nanoseconds

Methods

CompareTo ( obj )
Compares an object with this XrDuration instance.
Signature
int CompareTo(object obj)
Parameters
obj: object
Returns
int  Returns a positive value if obj is an XrDuration, TimeSpan, or null and is less than this instance, otherwise returns a negative number.
Throws
ArgumentException  Thrown if obj is not an XrDuration, a TimeSpan, or null.
CompareTo ( other )
Signature
int CompareTo(XrDuration other)
Parameters
other: XrDuration
Returns
int
Equals ( other )
Tests two XrDuration instances for equality.
Signature
bool Equals(XrDuration other)
Parameters
other: XrDuration  The XrDuration to compare with this one.
Returns
bool  Returns true if both other is equal to this one, otherwise false.
Equals ( obj )
Tests an object for equality with this XrDuration.
Signature
override bool Equals(object obj)
Parameters
obj: object  The object to test.
Returns
override bool  Returns true if obj is an XrDuration or TimeSpan, and its value is equal to this XrDuration.
GetHashCode ()
Computes a hash code of this XrDuration.
Signature
override int GetHashCode()
Returns
override int  Returns a hash code of this XrDuration.
ToSeconds ()
Converts this XrDuration to seconds.
Signature
double ToSeconds()
Returns
double  Returns the number of seconds represented by this XrDuration.
ToTimeSpan ()
Converts this XrDuration to a TimeSpan.
A TimeSpan does not have the same level of precision as an XrDuration. A TimeSpan represents time as a number of "ticks" where each tick is 100 nanoseconds. However, a XrDuration has nanosecond precision, so converting from an XrDuration to a TimeSpan may lose precision.
Signature
TimeSpan ToTimeSpan()
Returns
TimeSpan  Returns this XrDuration as a TimeSpan.

Static Methods

FromNanoseconds ( nanoseconds )
Constructs a new XrDuration from a number of nanoseconds.
Signature
static XrDuration FromNanoseconds(long nanoseconds)
Parameters
nanoseconds: long  The number of nanoseconds the XrDuration should represent.
Returns
XrDuration
FromSeconds ( seconds )
Converts seconds to a XrDuration.
Signature
static XrDuration FromSeconds(double seconds)
Parameters
seconds: double  The number of seconds to convert to an XrDuration
Returns
XrDuration  Returns a XrDuration that represents seconds .
operator TimeSpan ( value )
Signature
static operator TimeSpan(XrDuration value)
Parameters
value: XrDuration
operator XrDuration ( value )
Signature
static operator XrDuration(TimeSpan value)
Parameters
value: TimeSpan
operator!= ( left , right )
Signature
static bool operator!=(XrDuration left, XrDuration right)
Parameters
Returns
bool
operator* ( left , right )
Signature
static XrDuration operator*(XrDuration left, long right)
Parameters
right: long
Returns
XrDuration
operator+ ( left , right )
Signature
static XrDuration operator+(XrDuration left, XrDuration right)
Parameters
Returns
XrDuration
operator- ( left , right )
Signature
static XrDuration operator-(XrDuration left, XrDuration right)
Parameters
Returns
XrDuration
operator/ ( left , right )
Signature
static XrDuration operator/(XrDuration left, long right)
Parameters
right: long
Returns
XrDuration
operator< ( left , right )
Signature
static bool operator<(XrDuration left, XrDuration right)
Parameters
Returns
bool
operator<= ( left , right )
Signature
static bool operator<=(XrDuration left, XrDuration right)
Parameters
Returns
bool
operator== ( left , right )
Signature
static bool operator==(XrDuration left, XrDuration right)
Parameters
Returns
bool
operator> ( left , right )
Signature
static bool operator>(XrDuration left, XrDuration right)
Parameters
Returns
bool
operator>= ( left , right )
Signature
static bool operator>=(XrDuration left, XrDuration right)
Parameters
Returns
bool