class SFML::Time

Represents a time value. Stored internally as microseconds (int64), same as sfTime in CSFML. Immutable and Comparable, so two Times can be == / < / > / sorted.

SFML::Time.seconds(1.5) #=> 1_500_000 µs SFML::Time.milliseconds(500) SFML::Time.microseconds(42) SFML::Time.zero

t1 + t2 # sum of two Times t.as_seconds # Float seconds

Attributes

microseconds [R]

The microseconds.

Public Class Methods

microseconds (value)

Source

# File lib/sfml/system/time.rb, line 24
def self.microseconds(value) = new(Integer(value))
# The zero Time.
def self.zero                = new(0)

def initialize(microseconds)
  @microseconds = Integer(microseconds)
  freeze
end

# As Float seconds.
def as_seconds      = @microseconds / 1_000_000.0
# As Integer milliseconds (truncated).
def as_milliseconds = @microseconds / 1_000
# As Integer microseconds — the raw stored value.
def as_microseconds = @microseconds

# Sum of two Times — returns a fresh Time.
def +(other) = Time.new(@microseconds + other.microseconds)
# Difference between two Times.
def -(other) = Time.new(@microseconds - other.microseconds)
# Negate (useful when computing a "ago" offset).
def -@       = Time.new(-@microseconds)

# Compare two Times — implements `Comparable`, so `<`, `<=`, `>=`,
# `>`, `clamp`, and `Array#sort` all work.
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap { |t

Build a Time directly from microseconds.

milliseconds (value)

Source

# File lib/sfml/system/time.rb, line 22
def self.milliseconds(value) = new(Integer(value) * 1_000)
# Build a Time directly from microseconds.
def self.microseconds(value) = new(Integer(value))
# The zero Time.
def self.zero                = new(0)

def initialize(microseconds)
  @microseconds = Integer(microseconds)
  freeze
end

# As Float seconds.
def as_seconds      = @microseconds / 1_000_000.0
# As Integer milliseconds (truncated).
def as_milliseconds = @microseconds / 1_000
# As Integer microseconds — the raw stored value.
def as_microseconds = @microseconds

# Sum of two Times — returns a fresh Time.
def +(other) = Time.new(@microseconds + other.microseconds)
# Difference between two Times.
def -(other) = Time.new(@microseconds - other.microseconds)
# Negate (useful when computing a "ago" offset).
def -@       = Time.new(-@microseconds)

# Compare two Times — implements `Comparable`, so `<`, `<=`, `>=`,
# `>`, `clamp`, and `Array#sort` all work.
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap {

Build a Time from an Integer of milliseconds.

new (microseconds)

Source

# File lib/sfml/system/time.rb, line 28
def initialize(microseconds)
  @microseconds = Integer(microseconds)
  freeze
end

seconds (value)

Source

# File lib/sfml/system/time.rb, line 20
def self.seconds(value)      = new((value * 1_000_000).to_i)
# Build a Time from an Integer of milliseconds.
def self.milliseconds(value) = new(Integer(value) * 1_000)
# Build a Time directly from microseconds.
def self.microseconds(value) = new(Integer(value))
# The zero Time.
def self.zero                = new(0)

def initialize(microseconds)
  @microseconds = Integer(microseconds)
  freeze
end

# As Float seconds.
def as_seconds      = @microseconds / 1_000_000.0
# As Integer milliseconds (truncated).
def as_milliseconds = @microseconds / 1_000
# As Integer microseconds — the raw stored value.
def as_microseconds = @microseconds

# Sum of two Times — returns a fresh Time.
def +(other) = Time.new(@microseconds + other.microseconds)
# Difference between two Times.
def -(other) = Time.new(@microseconds - other.microseconds)
# Negate (useful when computing a "ago" offset).
def -@       = Time.new(-@microseconds)

# Compare two Times — implements `Comparable`, so `<`, `<=`, `>=`,
# `>`, `clamp`, and `Array#sort` all work.
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap

Build a Time from a Float of seconds.

zero (= new(0))

Source

# File lib/sfml/system/time.rb, line 26
def self.zero                = new(0)

def initialize(microseconds)
  @microseconds = Integer(microseconds)
  freeze
end

# As Float seconds.
def as_seconds      = @microseconds / 1_000_000.0
# As Integer milliseconds (truncated).
def as_milliseconds = @microseconds / 1_000
# As Integer microseconds — the raw stored value.
def as_microseconds = @microseconds

# Sum of two Times — returns a fresh Time.
def +(other) = Time.new(@microseconds + other.microseconds)
# Difference between two Times.
def -(other) = Time.new(@microseconds - other.microseconds)
# Negate (useful when computing a "ago" offset).
def -@       = Time.new(-@microseconds)

# Compare two Times — implements `Comparable`, so `<`, `<=`, `>=`,
# `>`, `clamp`, and `Array#sort` all work.
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap { |t|

The zero Time.

Public Instance Methods

+ (other)

Source

# File lib/sfml/system/time.rb, line 41
def +(other) = Time.new(@microseconds + other.microseconds)
# Difference between two Times.
def -(other) = Time.new(@microseconds - other.microseconds)
# Negate (useful when computing a "ago" offset).
def -@       = Time.new(-@microseconds)

# Compare two Times — implements `Comparable`, so `<`, `<=`, `>=`,
# `>`, `clamp`, and `Array#sort` all work.
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap { |t| t[:microseconds] = @microseconds

Sum of two Times — returns a fresh Time.

- (other)

Source

# File lib/sfml/system/time.rb, line 43
def -(other) = Time.new(@microseconds - other.microseconds)
# Negate (useful when computing a "ago" offset).
def -@       = Time.new(-@microseconds)

# Compare two Times — implements `Comparable`, so `<`, `<=`, `>=`,
# `>`, `clamp`, and `Array#sort` all work.
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap { |t| t[:microseconds] = @microseconds }

Difference between two Times.

-@ (= Time.new(-@microseconds))

Source

# File lib/sfml/system/time.rb, line 45
def -@       = Time.new(-@microseconds)

# Compare two Times — implements `Comparable`, so `<`, `<=`, `>=`,
# `>`, `clamp`, and `Array#sort` all work.
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap { |t| t[:microseconds] = @microseconds }

Negate (useful when computing a “ago” offset).

<=> (other)

Source

# File lib/sfml/system/time.rb, line 49
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap { |t| t[:microseconds] = @microseconds }
end

Compare two Times — implements Comparable, so <, <=, >=, >, clamp, and Array#sort all work.

as_microseconds (= @microseconds)

Source

# File lib/sfml/system/time.rb, line 38
def as_microseconds = @microseconds

# Sum of two Times — returns a fresh Time.
def +(other) = Time.new(@microseconds + other.microseconds)
# Difference between two Times.
def -(other) = Time.new(@microseconds - other.microseconds)
# Negate (useful when computing a "ago" offset).
def -@       = Time.new(-@microseconds)

# Compare two Times — implements `Comparable`, so `<`, `<=`, `>=`,
# `>`, `clamp`, and `Array#sort` all work.
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap { |t| t[:microseconds] =

as_milliseconds (= @microseconds / 1_000)

Source

# File lib/sfml/system/time.rb, line 36
def as_milliseconds = @microseconds / 1_000
# As Integer microseconds — the raw stored value.
def as_microseconds = @microseconds

# Sum of two Times — returns a fresh Time.
def +(other) = Time.new(@microseconds + other.microseconds)
# Difference between two Times.
def -(other) = Time.new(@microseconds - other.microseconds)
# Negate (useful when computing a "ago" offset).
def -@       = Time.new(-@microseconds)

# Compare two Times — implements `Comparable`, so `<`, `<=`, `>=`,
# `>`, `clamp`, and `Array#sort` all work.
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap { |t| t[:microseconds]

as_seconds (= @microseconds / 1_000_000.0)

Source

# File lib/sfml/system/time.rb, line 34
def as_seconds      = @microseconds / 1_000_000.0
# As Integer milliseconds (truncated).
def as_milliseconds = @microseconds / 1_000
# As Integer microseconds — the raw stored value.
def as_microseconds = @microseconds

# Sum of two Times — returns a fresh Time.
def +(other) = Time.new(@microseconds + other.microseconds)
# Difference between two Times.
def -(other) = Time.new(@microseconds - other.microseconds)
# Negate (useful when computing a "ago" offset).
def -@       = Time.new(-@microseconds)

# Compare two Times — implements `Comparable`, so `<`, `<=`, `>=`,
# `>`, `clamp`, and `Array#sort` all work.
def <=>(other) = @microseconds <=> other.microseconds

# Hash key support — Times can be Hash keys / Set members.
def hash = @microseconds.hash
# Value equality.
def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
alias == eql?

# String representation for debugging.
def to_s = "#<SFML::Time #{as_seconds}s>"
alias inspect to_s

# Returns the self.
def self.from_native(struct) # :nodoc:
  new(struct[:microseconds])
end

# Returns the to native.
def to_native # :nodoc:
  C::System::Time.new.tap { |t| t[

As Float seconds.

eql? (other)

Source

# File lib/sfml/system/time.rb, line 54
    def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
    alias == eql?

    # String representation for debugging.
    def to_s = "#<SFML::Time #{as_seconds}s>"
    alias inspect to_s

    # Returns the self.
    def self.from_native(struct) # :nodoc:
      new(struct[:microseconds])
    end

    # Returns the to native.
    def to_native # :nodoc:
      C::System::Time.new.tap { |t| t[:microseconds] = @microseconds }
    end
  end
end

hash (= @microseconds.hash)

Source

# File lib/sfml/system/time.rb, line 52
  def hash = @microseconds.hash
  # Value equality.
  def eql?(other) = other.is_a?(Time) && @microseconds == other.microseconds
  alias == eql?

  # String representation for debugging.
  def to_s = "#<SFML::Time #{as_seconds}s>"
  alias inspect to_s

  # Returns the self.
  def self.from_native(struct) # :nodoc:
    new(struct[:microseconds])
  end

  # Returns the to native.
  def to_native # :nodoc:
    C::System::Time.new.tap { |t| t[:microseconds] = @microseconds }
  end
end

Hash key support — Times can be Hash keys / Set members.

to_s (= "

Source

# File lib/sfml/system/time.rb, line 58
  def to_s = "#<SFML::Time #{as_seconds}s>"
  alias inspect to_s

  # Returns the self.
  def self.from_native(struct) # :nodoc:
    new(struct[:microseconds])
  end

  # Returns the to native.
  def to_native # :nodoc:
    C::System::Time.new.tap { |t| t[:microseconds] = @microseconds }
  end
end

String representation for debugging.