org.jsfml.window

Class Window

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.window.Window

All Implemented Interfaces:

WindowStyle

Direct Known Subclasses:

RenderWindow

public class Window
extends SFMLNativeObject
implements WindowStyle

A basic window that provides an OpenGL context.

This class implements the WindowStyle interface for quick access to the constants provided by it.

Field Summary

Fields inherited from interface org.jsfml.window.WindowStyle

CLOSE, DEFAULT, FULLSCREEN, NONE, RESIZE, TITLEBAR

Constructor Summary

Constructors

Modifier	Constructor and Description
	Window() Constructs a new window without actually creating it (making it visible).
protected	Window(long ptr) Deprecated. Use of this method may cause undefined behaviour and is not supported.
	Window(VideoMode mode, String title) Constructs a new window and creates it with the specified settings and default context settings and window style.
	Window(VideoMode mode, String title, int style) Constructs a new window and creates it with the specified settings and default context settings..
	Window(VideoMode mode, String title, int style, ContextSettings settings) Constructs a new window and creates it with the specified settings.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the window and destroys all attached resources, including the OpenGL context provided by it.
void	create(VideoMode mode, String title) Creates and opens a window or re-creates it if it was already opened.
void	create(VideoMode mode, String title, int style) Creates and opens a window or re-creates it if it was already opened.
void	create(VideoMode mode, String title, int style, ContextSettings settings) Creates and opens a window or re-creates it if it was already opened.
void	display() Flushes the OpenGL pixel buffer to the screen.
Vector2i	getPosition() Gets the absolute position of the window's top left corner on the screen.
ContextSettings	getSettings() Retrieves the context settings for the window's OpenGL context.
Vector2i	getSize() Gets the size of the window.
static boolean	isLegalWindowThread() Checks whether the current native thread is eligibile for creating a window.
boolean	isOpen() Checks if the window has been created and is opened.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
Event	pollEvent() Pops the event on top of the event stack, if any, and returns it.
Iterable<Event>	pollEvents() Returns an Iterable that consecutively calls pollEvent() and can be used to process all pending events.
void	setActive() Activates the window as the current OpenGL rendering target.
void	setActive(boolean active) Activates or deactivates the window as the current OpenGL rendering target.
void	setFramerateLimit(int flimit) Sets the maximum frame rate in frames per second.
void	setIcon(Image icon) Sets the icon of the window.
void	setJoystickTreshold(float treshold) Sets the joystick treshold.
void	setKeyRepeatEnabled(boolean enable) Determines whether automatic key repeat is enabled.
void	setMouseCursorVisible(boolean show) Determines whether the mouse cursor, if moved over the window, is visible or not.
void	setPosition(Vector2i position) Sets the absolute position of the window's top left corner on the screen.
void	setSize(Vector2i size) Sets the size of the window.
void	setTitle(String title) Sets the window's title.
void	setVerticalSyncEnabled(boolean enable) Enables or disables vertical synchronization (VSync).
void	setVisible(boolean show) Shows or hides the window.
Event	waitEvent() Pops the event on top of the event stack and returns it, or, if there is none, waits until an event occurs and then returns it.

Methods inherited from class org.jsfml.internal.SFMLNativeObject

finalize

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Window

public Window()

Constructs a new window without actually creating it (making it visible).

See Also:

create(org.jsfml.window.VideoMode, String, int, org.jsfml.window.ContextSettings)

Window

@Deprecated
protected Window(long ptr)

Deprecated. Use of this method may cause undefined behaviour and is not supported.

Constructs a new window within the specified parent window.

Parameters:

ptr - the window handle of the parent window.

Window

public Window(VideoMode mode,
      String title,
      int style,
      ContextSettings settings)

Constructs a new window and creates it with the specified settings.

Parameters:

mode - the window's video mode.

title - the window title.

style - the window style.

settings - the settings for the OpenGL context.

See Also:

create(VideoMode, String, int, ContextSettings)

Window

public Window(VideoMode mode,
      String title,
      int style)

Constructs a new window and creates it with the specified settings and default context settings..

Parameters:

mode - the window's video mode.

title - the window title.

style - the window style.

Window

public Window(VideoMode mode,
      String title)

Constructs a new window and creates it with the specified settings and default context settings and window style.

Parameters:

mode - the window's video mode.

title - the window title.

Method Detail

nativeCreate

@Deprecated
protected long nativeCreate()

Deprecated.

Description copied from class: SFMLNativeObject

Creates a new native SFML object of the represented SFML class in the JVM memory heap.

Specified by:

nativeCreate in class SFMLNativeObject

Returns:

the pointer to the newly created native SFML object.

nativeSetExPtr

@Deprecated
protected void nativeSetExPtr()

Deprecated.

Description copied from class: SFMLNativeObject

This method is expected to fill the extra pointers array, if any.

It is called after the object has been created or wrapped around an already existing pointer.

Specified by:

nativeSetExPtr in class SFMLNativeObject

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Specified by:

nativeDelete in class SFMLNativeObject

isLegalWindowThread

public static boolean isLegalWindowThread()

Checks whether the current native thread is eligibile for creating a window.

This will always be the case on Windows or Linux, but on Mac OS X, it will check whether the JVM was started in the main thread using the -XstartOnFirstThread command line parameter.

Returns:

true if the current native thread may create a window, false otherwise.

create

public void create(VideoMode mode,
          String title,
          int style,
          ContextSettings settings)

Creates and opens a window or re-creates it if it was already opened.

Parameters:

mode - the video mode that determines the window's size. This must be a valid video mode in case WindowStyle.FULLSCREEN is set.

title - the window title.

style - the style of the window. This should be a combination (using OR of the style flags WindowStyle.TITLEBAR, WindowStyle.RESIZE, WindowStyle.CLOSE and WindowStyle.FULLSCREEN, or WindowStyle.NONE for no style. WindowStyle.DEFAULT provides a default combination of style flags.

settings - the context settings for the created OpenGL context.

See Also:

VideoMode.isValid(), WindowStyle, ContextSettings

create

public final void create(VideoMode mode,
          String title,
          int style)

Creates and opens a window or re-creates it if it was already opened. The default context settings will be used for the OpenGL context.

Parameters:

mode - the video mode that determines the window's size. This must be a valid video mode in case WindowStyle.FULLSCREEN is set.

title - the window title.

style - the style of the window. This should be a combination (using OR of the style flags WindowStyle.TITLEBAR, WindowStyle.RESIZE, WindowStyle.CLOSE and WindowStyle.FULLSCREEN, or WindowStyle.NONE for no style. WindowStyle.DEFAULT provides a default combination of style flags.

See Also:

VideoMode.isValid(), WindowStyle

create

public final void create(VideoMode mode,
          String title)

Creates and opens a window or re-creates it if it was already opened. The WindowStyle.DEFAULT window style will be applied and default context settings will be used for the OpenGL context.

Parameters:

mode - the video mode that determines the window's size.

title - the window title.

close

public void close()

Closes the window and destroys all attached resources, including the OpenGL context provided by it.

isOpen

public boolean isOpen()

Checks if the window has been created and is opened.

Note that the open state is not directly affected by the user clicking the window's close button, if available. In order to accomplish that, listen to an event of type Event.Type.CLOSED and use the close() method.

Returns:

true if the window has been created and is currently open.

getPosition

public Vector2i getPosition()

Gets the absolute position of the window's top left corner on the screen.

Returns:

the absolute position of the window's top left corner on the screen.

setPosition

public void setPosition(Vector2i position)

Sets the absolute position of the window's top left corner on the screen.

Parameters:

position - the new absolute position of the window's top left corner on the screen.

getSize

public Vector2i getSize()

Gets the size of the window.

Returns:

the size of the window.

setSize

public void setSize(Vector2i size)

Sets the size of the window.

Parameters:

size - the new size of the window.

getSettings

public ContextSettings getSettings()

Retrieves the context settings for the window's OpenGL context.

Returns:

the context settings for the window's OpenGL context.

pollEvent

public Event pollEvent()

Pops the event on top of the event stack, if any, and returns it.

This method needs to be called regularly in order to process pending events. If this is not done, the window will be unresponsive.

Returns:

the event currently on top of the event stack, or null if there is none.

See Also:

waitEvent()

waitEvent

public Event waitEvent()

Pops the event on top of the event stack and returns it, or, if there is none, waits until an event occurs and then returns it.

This method will block the program flow until an event is returned.

Returns:

the event currently on top of the event stack, or the next event that will occur.

See Also:

pollEvent()

pollEvents

public Iterable<Event> pollEvents()

Returns an Iterable that consecutively calls pollEvent() and can be used to process all pending events.

Returns:

an Iterable over all pending events.

See Also:

pollEvent()

setVerticalSyncEnabled

public void setVerticalSyncEnabled(boolean enable)

Enables or disables vertical synchronization (VSync).

Activating vertical synchronization will limit the number of frames displayed to the refresh rate of the monitor. This can avoid some visual artifacts, and limit the framerate to a good value (but not constant across different computers).

This should not be used in combination with setFramerateLimit(int), as these two will conflict with one another.

By default, vertical synchronization is disabled.

Parameters:

enable - true to enable vertical synchronization, false to disable.

setMouseCursorVisible

public void setMouseCursorVisible(boolean show)

Determines whether the mouse cursor, if moved over the window, is visible or not.

Parameters:

show - true to make the cursor visible, false to hide it.

setTitle

public void setTitle(String title)

Sets the window's title.

Parameters:

title - the window's new title.

setVisible

public void setVisible(boolean show)

Shows or hides the window.

Parameters:

show - true to show the window, false to hide it.

setKeyRepeatEnabled

public void setKeyRepeatEnabled(boolean enable)

Determines whether automatic key repeat is enabled.

If enabled, multiple key press events will be fired when a key stays pressed (much like in a text field).

Key repeat is enabled by default.

Parameters:

enable - true to enable, false to disabled.

setIcon

public void setIcon(Image icon)

Sets the icon of the window.

Parameters:

icon - the icon image.

setActive

public void setActive(boolean active)
               throws ContextActivationException

Activates or deactivates the window as the current OpenGL rendering target.

If a window gets activated, all other windows operating in the same thread will automatically be deactivated.

Parameters:

active - true to activate, false to deactivate.

Throws:

ContextActivationException - in case window activation fails.

setActive

public final void setActive()
                     throws ContextActivationException

Activates the window as the current OpenGL rendering target.

If a window gets activated, all other windows operating in the same thread will automatically be deactivated.

Throws:

ContextActivationException - in case window activation fails.

display

public void display()

Flushes the OpenGL pixel buffer to the screen.

This should be called every frame after everything has been drawn in order to make the changes visible in the window.

setFramerateLimit

public void setFramerateLimit(int flimit)

Sets the maximum frame rate in frames per second.

If a limit is set, the display() method will block for a short delay time after flushing the buffer in order to possibly maintain a constant frame rate.

This should not be used in combination with setVerticalSyncEnabled(boolean) } as these two will conflict with one another.

By default, there is no frame rate limit.

Parameters:

flimit - the maximum frame rate in frames per second, or 0 to disable the frame rate limit.

setJoystickTreshold

public void setJoystickTreshold(float treshold)

Sets the joystick treshold.

Joystick axis movements with a magnitude smaller than this treshold will not fire a joystick event.

The default joystick treshold is 0.1.

Parameters:

treshold - the joystick treshold, ranging between 0 and 100.

See Also:

JoystickMoveEvent