Class: SDC::Window

Inherits:

Object

• Object
• SDC::Window

Defined in:

engine_docs/automatic_doc_Window.rb,
engine_docs/automatic_doc_Window.rb

Overview

The basic window class everything gets drawn on

Instance Attribute Summary

• #height ⇒ Integer

  The height of the window.

• #vertical_sync_enabled ⇒ Boolean

  Uses VSync to display frames at a stable framerate (disabled by default).

• #visible ⇒ Boolean

  Sets the visibility of the window.

• #width ⇒ Integer

  The width of the window.

Instance Method Summary

• #clear ⇒ nil

  Clears all content on the window.

• #close ⇒ nil

  Closes the window.

• #draw(object, z, render_states = nil) ⇒ true

  Draws the given object to the window at the given z position.

• #draw_translated(object, z, offset, render_states = nil) ⇒ true

  Draws the given object to the window at the given z position with the given offset.

• #has_focus? ⇒ Boolean

  Returns true if the window is focussed.

• #imgui_defined? ⇒ Boolean

  Returns true if imgui is active.

• #initialize(title, width, height, fullscreen = false) ⇒ Window constructor

  Creates a window with the given properties.

• #is_open? ⇒ Boolean

  Returns true if the window is open.

• #poll_event ⇒ Event|nil

  Polls for an event in the event queue and returns nil otherwise.

• #render_and_display ⇒ nil

  Applies the render queue and displays the window.

• #set_imgui_scale(scale) ⇒ nil

  Sets the global imgui scale (default 1.0).

• #set_view(view) ⇒ nil

  Sets the current view of the window.

• #update_imgui ⇒ nil

  Updates imgui drawing routines.

• #use_view(view) {|nil| ... } ⇒ nil

  Sets the window view to the given value for the given block.

Constructor Details

#initialize(title, width, height, fullscreen = false) ⇒ Window

Creates a window with the given properties

Parameters:

• title (String)
• width (Integer)
• height (Integer)
• fullscreen (Boolean) (defaults to: false)

# File 'engine_docs/automatic_doc_Window.rb', line 9

Instance Attribute Details

#height ⇒ Integer

The height of the window

Returns:

• (Integer)

# File 'engine_docs/automatic_doc_Window.rb', line 22

#vertical_sync_enabled ⇒ Boolean

Uses VSync to display frames at a stable framerate (disabled by default)

Returns:

• (Boolean)

# File 'engine_docs/automatic_doc_Window.rb', line 52

#visible ⇒ Boolean

Sets the visibility of the window

Returns:

• (Boolean)

# File 'engine_docs/automatic_doc_Window.rb', line 77

#width ⇒ Integer

The width of the window

Returns:

• (Integer)

# File 'engine_docs/automatic_doc_Window.rb', line 18

Instance Method Details

#clear ⇒ nil

Clears all content on the window

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Window.rb', line 26

#close ⇒ nil

Closes the window

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Window.rb', line 61

#draw(object, z, render_states = nil) ⇒ true

Draws the given object to the window at the given z position

Parameters:

• object (Sprite|Text|DrawShape|MapLayer)
• z (Float)
• render_states (RenderStates|nil) (defaults to: nil)

Returns:

• (true)

# File 'engine_docs/automatic_doc_Window.rb', line 93

#draw_translated(object, z, offset, render_states = nil) ⇒ true

Draws the given object to the window at the given z position with the given offset

Parameters:

• object (Sprite|Text|DrawShape|MapLayer)
• z (Float)
• offset (Coordinates)
• render_states (RenderStates|nil) (defaults to: nil)

Returns:

• (true)

# File 'engine_docs/automatic_doc_Window.rb', line 101

#has_focus? ⇒ Boolean

Returns true if the window is focussed

Returns:

• (Boolean)

# File 'engine_docs/automatic_doc_Window.rb', line 72

#imgui_defined? ⇒ Boolean

Returns true if imgui is active

Returns:

• (Boolean)

# File 'engine_docs/automatic_doc_Window.rb', line 36

#is_open? ⇒ Boolean

Returns true if the window is open

Returns:

• (Boolean)

# File 'engine_docs/automatic_doc_Window.rb', line 56

#poll_event ⇒ Event|nil

Polls for an event in the event queue and returns nil otherwise

Returns:

• (Event|nil)

# File 'engine_docs/automatic_doc_Window.rb', line 88

#render_and_display ⇒ nil

Applies the render queue and displays the window

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Window.rb', line 31

#set_imgui_scale(scale) ⇒ nil

Sets the global imgui scale (default 1.0)

Parameters:

• scale (Float)

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Window.rb', line 46

#set_view(view) ⇒ nil

Sets the current view of the window

Parameters:

• view (View)

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Window.rb', line 66

#update_imgui ⇒ nil

Updates imgui drawing routines

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Window.rb', line 41

#use_view(view) {|nil| ... } ⇒ nil

Sets the window view to the given value for the given block

Parameters:

• view (View)

Yields:

• (nil)

Returns:

• (nil)

# File 'engine_docs/automatic_doc_Window.rb', line 81