Format /

Public Member Functions

• Format (RendererRef renderer=RendererRef(), DisplayRef display=DisplayRef(), bool fullScreen=false, ivec2 size=ivec2(640, 480), ivec2 pos=ivec2())
• DisplayRef
  getDisplay () const

  Returns the Display the Window will be created on. Defaults to the primary display.

• void
  setDisplay (DisplayRef display)

  Sets the Display the Window will be created on. Defaults to the primary display.

• Format &
  display (DisplayRef displayRef)

  Sets the Display the Window will be created on. Defaults to the primary display.

• bool
  isFullScreen () const

  Returns whether the Window will be created full-screen. Default is false .

• const FullScreenOptions &
  getFullScreenOptions () const

  Returns the options associated with fullscreen at startup.

• void
  setFullScreen (bool fullScreen=true, const FullScreenOptions &options=FullScreenOptions())

  Sets whether the Window will be created full-screen with FullScreenOptions options . Default is false . If true, FullScreenOptions mode defaults to kiosk.

• Format &
  fullScreen (bool fs=true)

  Sets whether the Window will be created full-screen. Default is false .

• ivec2
  getSize () const

  Returns the size in points at which the Window will be created. Default is 640 x 480.

• void
  setSize (const ivec2 &size)

  Sets the size in points at which the Window will be created. Default is 640 x 480.

• void
  setSize (int32_t width, int32_t height)

  Sets the size in points at which the Window will be created. Default is 640 x 480.

• Format &
  size (const ivec2 &s)

  Sets the size in points at which the Window will be created. Default is 640 x 480.

• Format &
  size (int32_t width, int32_t height)

  Sets the size in points at which the Window will be created. Default is 640 x 480.

• ivec2
  getPos () const

  Returns the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display.

• void
  setPos (const ivec2 &pos)

  Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display.

• void
  setPos (int32_t x, int32_t y)

  Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display.

• Format &
  pos (const ivec2 &pos)

  Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display.

• Format &
  pos (int32_t x, int32_t y)

  Sets the position in points measured relative to the system's primary display's upper-left corner at which the Window will be created. Default is centered on the display.

• bool
  isPosSpecified () const

  Returns whether a non-default position has been requested for the Window .

• void
  setPosUnspecified ()

  Unspecifies a non-default position for the window, effectively requestion the default position.

• RendererRef
  getRenderer () const

  Returns the Renderer which will be instantiated for the Window . Defaults to an instance of the App's default renderer (specified in the app-instantiation macro).

• void
  setRenderer (const RendererRef &renderer)

  Sets the Renderer which will be instantiated for the Window .

• Format &
  renderer (RendererRef r)

  Sets the Renderer which will be instantiated for the Window .

• bool
  isResizable () const

  Returns whether the Window created will be resizable. Defaults to true .

• void
  setResizable (bool resizable=true)

  Sets whether the Window created will be resizable. Defaults to true .

• Format &
  resizable (bool res=true)

  Sets whether the Window created will be resizable. Defaults to true .

• bool
  isBorderless () const

  Returns whether the Window created will have no border. Defaults to false .

• void
  setBorderless (bool borderless=true)

  Sets whether the Window created will have no border. Defaults to false .

• Format &
  borderless (bool border=true)

  Sets whether the Window created will have no border. Defaults to false .

• bool
  isAlwaysOnTop () const

  Returns whether the Window created will always be above all other windows, including other applications' windows. Defaults to false .

• void
  setAlwaysOnTop (bool alwaysOnTop=true)

  Sets whether the Window created will always be above all other windows, including other applications' windows. Defaults to false .

• Format &
  alwaysOnTop (bool top=true)

  Sets whether the Window created will always be above all other windows, including other applications' windows. Defaults to false .

• void
  enableFullScreenButton (bool enabled=true)

  On Mac OS X enables the native full screen toggle button. Defaults to false .

• Format &
  fullScreenButton (bool enabled=true)

  On Mac OS X enables the native full screen toggle button. Defaults to false .

• bool
  isFullScreenButtonEnabled () const

  On Mac OS X returns whether the native full screen toggle button is displayed. Defaults to false .

• std::string
  getTitle () const

  Returns the title of the Window as a UTF-8 string.

• void
  setTitle (const std::string &title)

  Sets the title of the Window as a UTF-8 string.

• Format &
  title (const std::string &t)

  Sets the title of the Window as a UTF-8 string.

• bool
  isTitleSpecified () const

  Returns whether a non-default title has been requested for the Window .

• void
  setTitleUnspecified ()

  Unspecifies a non-default title for the window, effectively requestion the default title.