Visual3D Game Engine API Documentation for XNA, C#, VB, and .NET

Time Interval value in terms of Milliseconds. Implicitly converts to/from Integer as assumed units of Milliseconds.

Namespace: Visual3D
Assembly: Visual3D (in Visual3D.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax


	C#			Visual Basic

[SerializableAttribute]
public struct TimeInterval : IEquatable<TimeInterval>, 
	IComparable<TimeInterval>, IComparable

<SerializableAttribute> _
Public Structure TimeInterval _
	Implements IEquatable(Of TimeInterval), IComparable(Of TimeInterval),  _
	IComparable

Members

All Members

Constructors Public method

Fields

Properties Public property

Methods

 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

	Member	Description
	TimeInterval(Int32)	Construct from milliseconds.
	TimeInterval(Int64)	Construct from milliseconds.
	Addition(TimeInterval, TimeInterval)
	CompareTo(Object)
	CompareTo(TimeInterval)
	Division(TimeInterval, Int32)
	Division(TimeInterval, TimeInterval)
	Equality(TimeInterval, TimeInterval)
	Equals(Object)	(Overrides ValueType..::..Equals(Object).)
	Equals(TimeInterval)
	FromFrameInterval(Int32)	Create Time from Frame Intervals of the specified Scheduler.
	FromFrameInterval(Int32, Scheduler)	Create Time from Frame Intervals of the specified Scheduler.
	FromHertz(Single)	Create Time from Hertz value.
	FromHertzRounded(Single)	Create Time from Hertz value.
	FromMilliseconds(Int32)	Create Time from Repetition cycle (in milliseconds).
	FromMilliseconds(Int64)	Create Time from Repetition cycle (in milliseconds). Clamps to int.Max/Min Value (and logs warning on overflow).
	FromMilliseconds(Single)	Create Time from Repetition cycle (in milliseconds).
	FromMillisecondsRounded(Int32)	Create Time from Repetition cycle (in milliseconds).
	FromMillisecondsRounded(Int32, Scheduler)	Create Time from Repetition cycle (in milliseconds) rounded to nearest FrameInterval.
	FromMinutes(Single)
	FromSeconds(Double)
	FromSeconds(Single)	Create Time from Repetition cycle (in seconds).
	FromSecondsRounded(Single)	Create Time from Repetition cycle (in seconds).
	FromTime(Time)	Create Time from Repetition cycle (in milliseconds). Clamps to int.Max/Min Value (and logs warning on overflow).
	GetHashCode()()()()	(Overrides ValueType..::..GetHashCode()()()().)
	GetRoundedMilliseconds()()()()	Returns Time Interval rounded to the nearest Scheduler Frame time interval.
	GetRoundedMilliseconds(TimeInterval)	Returns Time Interval rounded to the nearest Scheduler Frame time interval.
	GreaterThan(TimeInterval, TimeInterval)
	GreaterThanOrEqual(TimeInterval, TimeInterval)
	Hertz	Time Interval converted to equivalence in Hertz.
	ImplicitWideningImplicitImplicitImplicit(Int32 to TimeInterval)
	ImplicitWideningImplicitImplicitImplicit(Int64 to TimeInterval)
	ImplicitWideningImplicitImplicitImplicit(TimeSpan to TimeInterval)
	ImplicitWideningImplicitImplicitImplicit(Time to TimeInterval)
	ImplicitWideningImplicitImplicitImplicit(TimeInterval to TimeSpan)
	ImplicitWideningImplicitImplicitImplicit(TimeInterval to Int32)
	ImplicitWideningImplicitImplicitImplicit(TimeInterval to Time)
	Inequality(TimeInterval, TimeInterval)
	Infinite	Returns an Infinite time interval (i.e. never repeats).
	IsInfinite	Indicates that Time Interval is Infinite (will never repeat).
	IsPositive	Indicates if Time Interval is greater than Zero.
	IsZero	Indicates if Time Interval is Zero (infinite Hertz rate).
	LessThan(TimeInterval, TimeInterval)
	LessThanOrEqual(TimeInterval, TimeInterval)
	Milliseconds	Repetition time interval expressed in milliseconds. TMS TODO: float or microseconds, so can accurately maintain audio-video timing over long recording?
	Multiply(Int32, TimeInterval)
	Multiply(Single, TimeInterval)
	Multiply(TimeInterval, Int32)
	Multiply(TimeInterval, Single)
	OneSecond	Returns a time interval of 1 second (repeats once per second).
	RoundToInterval()()()()	Rounds this Time Interval to the nearest Scheduler Frame time interval.
	RoundToInterval(TimeInterval)	Rounds this Time Interval to the nearest Scheduler Frame time interval.
	Seconds	Time Interval converted to Seconds.
	Subtraction(TimeInterval, TimeInterval)
	ToFrameIntervals()()()()	Returns Number of Frame Intervals that closest approximates this Time Interval.
	ToFrameIntervals(TimeInterval)	Returns Number of Frame Intervals that closest approximates this Time Interval.
	ToString()()()()	(Overrides ValueType..::..ToString()()()().)
	VeryLong
	Zero	Returns a Zero time interval (i.e. infinite hertz rate).

Syntax

Members

See Also