class SF::RenderWindow

• SF::RenderWindow
• SF::Window
• Reference
• Object

Overview

Window that can serve as a target for 2D drawing

SF::RenderWindow is the main class of the Graphics module. It defines an OS window that can be painted using the other classes of the graphics module.

SF::RenderWindow is derived from SF::Window, thus it inherits all its features: events, window management, OpenGL rendering, etc. See the documentation of SF::Window for a more complete description of all these features, as well as code examples.

On top of that, SF::RenderWindow adds more features related to 2D drawing with the graphics module (see its base module SF::RenderTarget for more details). Here is a typical rendering and event loop with a SF::RenderWindow:

# Declare and create a new render-window
window = SF::RenderWindow.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

  # Clear the whole window before rendering a new frame
  window.clear

  # Draw some graphical entities
  window.draw sprite
  window.draw circle
  window.draw text

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

Like SF::Window, SF::RenderWindow is still able to render direct OpenGL stuff. It is even possible to mix together OpenGL calls and regular SFML drawing commands.

# Create the render window
window = SF::RenderWindow.new(SF::VideoMode.new(800, 600), "SFML OpenGL")

# Create a sprite and a text to display
sprite = SF::Sprite.new
text = SF::Text.new
# [...]

# Perform OpenGL initializations
glMatrixMode(GL_PROJECTION)
# [...]

# Start the rendering loop
while window.open?
  # Process events
  # [...]

  # Draw a background sprite
  window.push_gl_states
  window.draw sprite
  window.pop_gl_states

  # Draw a 3D object using OpenGL
  glBegin(GL_QUADS)
  glVertex3f(...)
  # [...]
  glEnd

  # Draw text on top of the 3D object
  window.push_gl_states
  window.draw text
  window.pop_gl_states

  # Finally, display the rendered frame on screen
  window.display
end

See also: SF::Window, SF::RenderTarget, SF::RenderTexture, SF::View

Included Modules

• SF::RenderTarget

Defined in:

Constructors

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

  Construct a new window

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

  Construct the window from an existing control

• .new

  Default constructor

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

  Shorthand for render_window = RenderWindow.new; render_window.create(...); render_window

Instance Method Summary

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

  Activate or deactivate the window as the current target for OpenGL rendering

• #capture : Image

  Copy the current contents of the window to an image

• #finalize

  Destructor

• #size : Vector2u

  Get the size of the rendering region of the window

Constructor Detail

Instance Method Detail

texture = SF::Texture.new(window.size.x, window.size.y)
texture.update(window)
screenshot = texture.copy_to_image