class `SF::WindowBase`
inherits `Reference` #

Window that serves as a base for other windows

SF::WindowBase serves as the base class for all Windows.

A SF::WindowBase can create its own new window, or be embedded into an already existing control using the create(handle) function.

The SF::WindowBase 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.

Usage example:

// Declare and create a new window
sf::WindowBase window(sf::VideoMode(800, 600), "SFML window");

// The main loop - ends as soon as the window is closed
while (window.isOpen())
{
   // Event processing
   sf::Event event;
   while (window.pollEvent(event))
   {
       // Request for closing the window
       if (event.type == sf::Event::Closed)
           window.close();
   }

   // Do things with the window here...
}

Included modules

SF::NonCopyable

Direct known subclasses

SF::Window

Constructors#

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

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.

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

class SF::WindowBase inherits Reference #

Included modules

Direct known subclasses

Constructors#

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

.new(handle : WindowHandle)#

.new#

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

Methods#

#close#

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

#create(handle : WindowHandle)#

#create_vulkan_surface(instance : VkInstance, surface : VkSurfaceKHR, allocator : VkAllocationCallbacks | Nil = nil) : Bool#

#finalize#

#focus? : Bool#

#joystick_threshold=(threshold : Number)#

#key_repeat_enabled=(enabled : Bool)#

#mouse_cursor=(cursor : Cursor)#

#mouse_cursor_grabbed=(grabbed : Bool)#

#mouse_cursor_visible=(visible : Bool)#

#open? : Bool#

#poll_event : Event | ::Nil#

#position : Vector2i#

#position=(position : Vector2 | Tuple)#

#request_focus#

#set_icon(width : Int, height : Int, pixels : Pointer(UInt8))#

#size : Vector2u#

#size=(size : Vector2 | Tuple)#

#system_handle : WindowHandle#

#title=(title : String)#

#visible=(visible : Bool)#

#wait_event : Event | ::Nil#

class `SF::WindowBase`
inherits `Reference` #

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

`.new(handle : WindowHandle)`#

`.new`#

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

`#close`#

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

`#create(handle : WindowHandle)`#

`#create_vulkan_surface(instance : VkInstance, surface : VkSurfaceKHR, allocator : VkAllocationCallbacks | Nil = nil) : Bool`#

`#finalize`#

`#focus? : Bool`#

`#joystick_threshold=(threshold : Number)`#

`#key_repeat_enabled=(enabled : Bool)`#

`#mouse_cursor=(cursor : Cursor)`#

`#mouse_cursor_grabbed=(grabbed : Bool)`#

`#mouse_cursor_visible=(visible : Bool)`#

`#open? : Bool`#

`#poll_event : Event | ::Nil`#

`#position : Vector2i`#

`#position=(position : Vector2 | Tuple)`#

`#request_focus`#

`#set_icon(width : Int, height : Int, pixels : Pointer(UInt8))`#

`#size : Vector2u`#

`#size=(size : Vector2 | Tuple)`#

`#system_handle : WindowHandle`#

`#title=(title : String)`#

`#visible=(visible : Bool)`#

`#wait_event : Event | ::Nil`#