class `SF::Window`
inherits `SF::WindowBase` #

Window that serves as a target for OpenGL rendering

SF::Window is the main class of the Window module. It defines an OS window that is able to receive an OpenGL rendering.

A SF::Window can create its own new window, or be embedded into an already existing control using the create(handle) function. This can be useful for embedding an OpenGL rendering area into a view which is part of a bigger GUI with existing windows, controls, etc. It can also serve as embedding an OpenGL rendering area into a window created by another (probably richer) GUI library like Qt or wx_widgets.

The SF::Window class provides a simple interface for manipulating the window: move, resize, show/hide, control mouse cursor, etc. It also provides event handling through its poll_event() and wait_event() functions.

Note that OpenGL experts can pass their own parameters (antialiasing level, bits for the depth and stencil buffers, etc.) to the OpenGL context attached to the window, with the SF::ContextSettings structure which is passed as an optional argument when creating the window.

On dual-graphics systems consisting of a low-power integrated GPU and a powerful discrete GPU, the driver picks which GPU will run an SFML application. In order to inform the driver that an SFML application can benefit from being run on the more powerful discrete GPU, #SFML_DEFINE_DISCRETE_GPU_PREFERENCE can be placed in a source file that is compiled and linked into the final application. The macro should be placed outside of any scopes in the global namespace.

Usage example:

# Declare and create a new window
window = SF::Window.new(SF::VideoMode.new(800, 600), "SFML window")

# Limit the framerate to 60 frames per second (this step is optional)
window.framerate_limit = 60

# The main loop - ends as soon as the window is closed
while window.open?
  # Event processing
  while (event = window.poll_event)
    # Request for closing the window
    if event.is_a?(SF::Event::Closed)
      window.close
    end
  end

  # Activate the window for OpenGL rendering
  window.active = true

  # OpenGL drawing commands go here...

  # End the current frame and display its contents on screen
  window.display
end

Included modules

SF::GlResource

Direct known subclasses

SF::RenderWindow

Constructors#

`.new(mode : VideoMode, title : String, style : Style = Style::Default, settings : ContextSettings = ContextSettings.new())`#

Construct a new window

This constructor creates the window with the size and pixel depth defined in mode. An optional style can be passed to customize the look and behavior of the window (borders, title bar, resizable, closable, ...). If style contains Style::Fullscreen, then mode must be a valid video mode.

The fourth parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc.

mode - Video mode to use (defines the width, height and depth of the rendering area of the window)
title - Title of the window
style - Window style, a bitwise OR combination of SF::Style enumerators
settings - Additional settings for the underlying OpenGL context

class SF::Window inherits SF::WindowBase #

Included modules

Direct known subclasses

Constructors#

.new(mode : VideoMode, title : String, style : Style = Style::Default, settings : ContextSettings = ContextSettings.new())#

.new(handle : WindowHandle, settings : ContextSettings = ContextSettings.new())#

.new#

.new(*args, **kwargs) : self#

Methods#

#active=(active : Bool = true) : Bool#

#close#

#create(mode : VideoMode, title : String, style : Style, settings : ContextSettings)#

#create(mode : VideoMode, title : String, style : Style = Style::Default)#

#create(handle : WindowHandle, settings : ContextSettings)#

#create(handle : WindowHandle)#

#display#

#finalize#

#framerate_limit=(limit : Int)#

#settings : ContextSettings#

#vertical_sync_enabled=(enabled : Bool)#

class `SF::Window`
inherits `SF::WindowBase` #

`.new(mode : VideoMode, title : String, style : Style = Style::Default, settings : ContextSettings = ContextSettings.new())`#

`.new(handle : WindowHandle, settings : ContextSettings = ContextSettings.new())`#

`.new`#

`.new(*args, **kwargs) : self`#

`#active=(active : Bool = true) : Bool`#

`#close`#

`#create(mode : VideoMode, title : String, style : Style, settings : ContextSettings)`#

`#create(mode : VideoMode, title : String, style : Style = Style::Default)`#

`#create(handle : WindowHandle, settings : ContextSettings)`#

`#create(handle : WindowHandle)`#

`#display`#

`#finalize`#

`#framerate_limit=(limit : Int)`#

`#settings : ContextSettings`#

`#vertical_sync_enabled=(enabled : Bool)`#