Class: SDL2::Event::Keyboard

Inherits:

SDL2::Event

• Object
• SDL2::Event
• SDL2::Event::Keyboard

Defined in:

ext/sdl2_ext/event.c,
lib/sdl2/event.rb,
ext/sdl2_ext/event.c

Overview

This class represents keyboard event.

You don't handle the instance of this class directly, but you handle the instances of two subclasses of this subclasses: KeyDown and KeyUp.

Direct Known Subclasses

KeyDown, KeyUp

Instance Attribute Summary

• #mod ⇒ Integer

  current key modifier.

• #pressed ⇒ Integer (also: #pressed?)

  key is pressed.

• #repeat ⇒ Integer (also: #repeat?)

  key repeat.

• #scancode ⇒ Integer

  physical key code.

• #sym ⇒ Integer

  virtual key code.

• #window_id ⇒ Integer

  the associate window id.

Attributes inherited from SDL2::Event

#timestamp, #type

Instance Method Summary

• #inspect ⇒ String

  Inspection string.

Methods inherited from SDL2::Event

enable=, enabled?, poll, #window

Instance Attribute Details

#mod ⇒ Integer

current key modifier

Returns:

• (Integer)

See Also:

• Key::Mod

#pressed ⇒ Integer Also known as: pressed?

key is pressed

Returns:

• (Integer)

#repeat ⇒ Integer Also known as: repeat?

key repeat

Returns:

• (Integer)

#scancode ⇒ Integer

physical key code

Returns:

• (Integer)

See Also:

• Key::Scan

#sym ⇒ Integer

virtual key code

Returns:

• (Integer)

See Also:

• Key

#window_id ⇒ Integer

the associate window id

Returns:

• (Integer)

Instance Method Details

#inspect ⇒ String

Returns inspection string.

Returns:

• (String) —

  inspection string

# File 'ext/sdl2_ext/event.c', line 359

def inspect
	"<#{self.class.inspect}: " \
		"timestamp=#{timestamp.inspect} " \
		"window_id=#{window_id.inspect} " \
		"repeat=#{repeat.inspect} " \
		"scancode=#{SDL2::Key::Scan.name_of(scancode).inspect} " \
		"sym=#{SDL2::Key.name_of(sym).inspect}>"
end