de.gurkenlabs.litiengine

Class GameWindow

java.lang.Object

de.gurkenlabs.litiengine.GameWindow

public final class GameWindow
extends java.lang.Object

The GameWindow class is a wrapper for the game's visual window in which the RenderComponent lives.
It provides the possibility to set a title, provide an icon, configure the cursor or get information about the resolution.

See Also:

RenderComponent, getResolution(), setTitle(String), cursor(), setIcon(java.awt.Image)

Method Summary

Modifier and Type	Method and Description
MouseCursor	cursor() Gets the visual representation of the mouse cursor on the GameWindow.
java.awt.geom.Point2D	getCenter()
int	getHeight()
java.awt.Container	getHostControl()
RenderComponent	getRenderComponent() Gets the AWT canvas that is used to render the game's content on.
java.awt.Dimension	getResolution()
float	getResolutionScale()
java.awt.Dimension	getSize()
int	getWidth()
java.awt.Point	getWindowLocation()
boolean	isFocusOwner()
void	onResolutionChanged(java.util.function.Consumer<java.awt.Dimension> resolutionConsumer)
void	setIcon(java.awt.Image image)
void	setIcons(java.util.List<? extends java.awt.Image> image)
void	setResolution(Resolution res)
void	setTitle(java.lang.String name)

Methods inherited from class java.lang.Object

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

Method Detail

isFocusOwner

public boolean isFocusOwner()

onResolutionChanged

public void onResolutionChanged(java.util.function.Consumer<java.awt.Dimension> resolutionConsumer)

setResolution

public void setResolution(Resolution res)

getResolutionScale

public float getResolutionScale()

getCenter

public java.awt.geom.Point2D getCenter()

getHostControl

public java.awt.Container getHostControl()

getSize

public java.awt.Dimension getSize()

getWidth

public int getWidth()

getHeight

public int getHeight()

getRenderComponent

public RenderComponent getRenderComponent()

Gets the AWT canvas that is used to render the game's content on.

Returns:

The AWT render component onto which the game contents are rendered.

cursor

public MouseCursor cursor()

Gets the visual representation of the mouse cursor on the GameWindow.

This can be used to provide a custom cursor image, define its visibility or specify a rendering offset from the actual position.

Returns:

The mouse cursor of the game.

getResolution

public java.awt.Dimension getResolution()

getWindowLocation

public java.awt.Point getWindowLocation()

setIcon

public void setIcon(java.awt.Image image)

setIcons

public void setIcons(java.util.List<? extends java.awt.Image> image)

setTitle

public void setTitle(java.lang.String name)