Module piston_window::prelude

Exports all of the types exposed by this module, except for graphics.

The graphics module contains a module and function called image, which is very likely to conflict with the image crate.

Using the name “prelude” also suppresses the wildcard import warning from clippy.

Modules

• controller
  Back-end agnostic controller events.
• event_id
  Event identifiers.
• event_loop
  A Piston event loop for games and interactive applications
• generic_event
  Trait for generic events
• input
  A flexible structure for user interactions to be used in window frameworks and widgets libraries.
• keyboard
  Back-end agnostic keyboard keys.
• mouse
  Back-end agnostic mouse buttons.
• window
  Window storage and interfacing traits.

Structs

• AfterRenderArgs
  After render arguments.
• Api
  Stores graphics API version.
• ButtonArgs
  Button arguments.
• CloseArgs
  Close arguments.
• ControllerAxisArgs
  Components of a controller axis move event. Not guaranteed consistent across backends.
• ControllerButton
  Components of a controller button event. Not guaranteed consistent across backends.
• ControllerHat
  Components of a controller hat move event (d-Pad).
• EventSettings
  Stores event loop settings.
• Events
  An event loop iterator
• IdleArgs
  Idle arguments, such as expected idle time in seconds.
• NoWindow
  A window without user interface, often used in server event loops.
• PistonWindow
  Contains everything required for controlling window, graphics, event loop.
• Position
  Structure to store the window position.
• RenderArgs
  Render arguments.
• ResizeArgs
  Resize arguments.
• Size
  Structure to store the window size.
• Texture
  Represents a texture.
• TextureContext
  Context required to create and update textures.
• TextureSettings
  Texture creation parameters.
• TouchArgs
  Touch arguments
• UnsupportedGraphicsApiError
  An error for when a graphics API is unsupported.
• UpdateArgs
  Update arguments, such as delta time in seconds.
• WindowSettings
  Settings structure for window behavior.

Enums

• Button
  Models different kinds of buttons.
• ButtonState
  Stores button state.
• Event
  Models all events.
• FileDrag
  Models dragging and dropping files.
• Filter
  Sampling filter
• Flip
  Flip settings.
• HatState
  Stores controller hat state.
• Input
  Models input events.
• Key
  Represent a keyboard key. Keycodes follows SDL http://wiki.libsdl.org/SDLKeycodeLookup
• Loop
  Models loop events.
• Motion
  Models different kinds of motion.
• MouseButton
  Represent a mouse button.
• OpenGL
• Touch
  Stores the touch state.

Constants

• DEFAULT_MAX_FPS
  The default maximum frames per second.
• DEFAULT_UPS
  The default updates per second.
• DEFAULT_UPS_RESET
  The default delayed updates reset.

Traits

• AdvancedWindow
  Trait representing a window with the most features that are still generic.
• AfterRenderEvent
  After rendering and buffers are swapped.
• BuildFromWindowSettings
  Constructs a window from a WindowSettings object.
• ButtonEvent
  Changed button state.
• CloseEvent
  Window is closing.
• ControllerAxisEvent
  The position of a controller axis changed.
• CursorEvent
  When window gets or loses cursor.
• EventLoop
  Methods implemented for changing event loop settings.
• FocusEvent
  When window gets or loses focus.
• GenericEvent
  Implemented by all events.
• IdleEvent
  When background tasks should be performed.
• MouseCursorEvent
  The position of the mouse cursor.
• MouseRelativeEvent
  The relative movement of mouse cursor.
• MouseScrollEvent
  The scroll of the mouse wheel.
• OpenGLWindow
  Trait for OpenGL specific operations on a window.
• PressEvent
  The press of a button.
• ReleaseEvent
  The release of a button.
• RenderEvent
  When the next frame should be rendered.
• ResizeEvent
  When the window is resized.
• TextEvent
  When receiving text from user, such as typing a character.
• TouchEvent
  When a touch is started, moved, ended or cancelled.
• UpdateEvent
  When the application state should be updated.
• Window
  Trait representing the minimum requirements for defining a window.

Type Aliases

• G2d
  2D graphics.
• G2dTexture
  Texture type compatible with G2d.
• G2dTextureContext
  Texture context.
• GfxDevice
  Actual device used by Gfx backend.
• GfxEncoder
  Actual gfx::Stream implementation carried by the window.
• GfxFactory
  Actual factory used by Gfx backend.
• Glyphs
  Glyph cache.
• ProcAddress
  The type of an OpenGL function address.
• TimeStamp
  The type of time stamp.