org.jsfml.graphics

Class RenderWindow

java.lang.Object

org.jsfml.internal.SFMLNativeObject

org.jsfml.window.Window

org.jsfml.graphics.RenderWindow

All Implemented Interfaces:

RenderTarget, WindowStyle

public class RenderWindow
extends Window
implements RenderTarget

Provides a window that can serve as a target for 2D drawing.

Field Summary

Fields inherited from interface org.jsfml.window.WindowStyle

CLOSE, DEFAULT, FULLSCREEN, NONE, RESIZE, TITLEBAR

Constructor Summary

Constructors

Constructor and Description
RenderWindow() Constructs a new render window without actually creating (opening) it.
RenderWindow(VideoMode mode, String title) Constructs a new render window and creates it with default style and context settings.
RenderWindow(VideoMode mode, String title, int style) Constructs a new render window and creates it with default context settings.
RenderWindow(VideoMode mode, String title, int style, ContextSettings settings) Constructs a new render window and creates it with the specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
Image	capture() Copies the current contents of the window to an image.
void	clear() Clears the target with black.
void	clear(Color color) Clears the render target and fills it with a constant color.
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	draw(Drawable drawable) Draws a drawable object to the render target using the default render states.
void	draw(Drawable drawable, RenderStates renderStates) Draws a drawable object to the render target using the given render states.
void	draw(Vertex[] vertices, PrimitiveType type) Draws a primitive of the given type using the given vertices and the default render states.
void	draw(Vertex[] vertices, PrimitiveType type, RenderStates states) Draws a primitive of the given type using the given vertices and the given render states.
ConstView	getDefaultView() Gets the target's default view.
ConstView	getView() Gets the target's current view.
IntRect	getViewport(ConstView view) Computes the viewport of the given view applied to this render target.
Vector2i	mapCoordsToPixel(Vector2f point) Converts a point from world coordinates to target coordinates using the target's current view.
Vector2i	mapCoordsToPixel(Vector2f point, ConstView view) Converts a point from world coordinates to target coordinates for a certain view.
Vector2f	mapPixelToCoords(Vector2i point) Converts a point from target coordinates to world coordinates using the target's current view.
Vector2f	mapPixelToCoords(Vector2i point, ConstView view) Converts a point from target coordinates to world coordinates for a certain view.
protected long	nativeCreate() Deprecated.
protected void	nativeDelete() Deprecated.
protected void	nativeSetExPtr() Deprecated.
void	popGLStates() Pops the last OpenGL states and matrices from the top of the stack.
void	pushGLStates() Pushes the current OpenGL states and matrices to the stack.
void	resetGLStates() Resets the internal OpenGL states so that the target is ready for drawing.
void	setView(ConstView view) Sets the target's view.

Methods inherited from class org.jsfml.window.Window

close, create, create, display, getPosition, getSettings, getSize, isLegalWindowThread, isOpen, pollEvent, pollEvents, setActive, setActive, setFramerateLimit, setIcon, setJoystickTreshold, setKeyRepeatEnabled, setMouseCursorVisible, setPosition, setSize, setTitle, setVerticalSyncEnabled, setVisible, waitEvent

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

Methods inherited from interface org.jsfml.graphics.RenderTarget

getSize

Constructor Detail

RenderWindow

public RenderWindow()

Constructs a new render window without actually creating (opening) it.

See Also:

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

RenderWindow

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

Constructs a new render window and creates it with the specified parameters.

Parameters:

mode - the video mode to use for rendering.

title - the window title.

style - the window style.

settings - the settings for the OpenGL context.

See Also:

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

RenderWindow

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

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

Parameters:

mode - the video mode to use for rendering.

title - the window title.

style - the window style.

See Also:

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

RenderWindow

public RenderWindow(VideoMode mode,
            String title)

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

Parameters:

mode - The video mode to use for rendering.

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.

Overrides:

nativeCreate in class Window

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.

Overrides:

nativeSetExPtr in class Window

nativeDelete

@Deprecated
protected void nativeDelete()

Deprecated.

Description copied from class: SFMLNativeObject

Deletes the underlying SFML object.

Overrides:

nativeDelete in class Window

create

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

Description copied from class: Window

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

Overrides:

create in class Window

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

capture

public Image capture()

Copies the current contents of the window to an image.

This is a slow operation and should be used to take screenshots, not to re-use resulting image as a texture. For that, use Texture.update(org.jsfml.window.Window) or a RenderTexture instead.

Returns:

the image with the current contents of the window.

clear

public void clear(Color color)

Description copied from interface: RenderTarget

Clears the render target and fills it with a constant color.

Specified by:

clear in interface RenderTarget

Parameters:

color - the color to fill the target with.

clear

public void clear()

Clears the target with black.

setView

public void setView(ConstView view)

Description copied from interface: RenderTarget

Sets the target's view.

Specified by:

setView in interface RenderTarget

Parameters:

view - the target's new view.

getView

public ConstView getView()

Description copied from interface: RenderTarget

Gets the target's current view.

Specified by:

getView in interface RenderTarget

Returns:

the target's current view.

getDefaultView

public ConstView getDefaultView()

Description copied from interface: RenderTarget

Gets the target's default view.

Specified by:

getDefaultView in interface RenderTarget

Returns:

the target's default view.

getViewport

public IntRect getViewport(ConstView view)

Description copied from interface: RenderTarget

Computes the viewport of the given view applied to this render target.

Specified by:

getViewport in interface RenderTarget

Parameters:

view - the view.

Returns:

the viewport of the given view applied to this render target.

mapPixelToCoords

public final Vector2f mapPixelToCoords(Vector2i point)

Description copied from interface: RenderTarget

Converts a point from target coordinates to world coordinates using the target's current view.

Specified by:

mapPixelToCoords in interface RenderTarget

Parameters:

point - the point on the render target.

Returns:

the matching point in the world.

mapPixelToCoords

public Vector2f mapPixelToCoords(Vector2i point,
                        ConstView view)

Description copied from interface: RenderTarget

Converts a point from target coordinates to world coordinates for a certain view.

Specified by:

mapPixelToCoords in interface RenderTarget

Parameters:

point - the point on the render target.

view - the view to use for conversion.

Returns:

the matching point in the world.

mapCoordsToPixel

public final Vector2i mapCoordsToPixel(Vector2f point)

Description copied from interface: RenderTarget

Converts a point from world coordinates to target coordinates using the target's current view.

Specified by:

mapCoordsToPixel in interface RenderTarget

Parameters:

point - the point in the world.

Returns:

the matching point on the render target.

mapCoordsToPixel

public Vector2i mapCoordsToPixel(Vector2f point,
                        ConstView view)

Description copied from interface: RenderTarget

Converts a point from world coordinates to target coordinates for a certain view.

Specified by:

mapCoordsToPixel in interface RenderTarget

Parameters:

point - the point in the world.

view - the view to use for conversion.

Returns:

the matching point on the render target.

draw

public final void draw(Drawable drawable)

Description copied from interface: RenderTarget

Draws a drawable object to the render target using the default render states.

Specified by:

draw in interface RenderTarget

Parameters:

drawable - the object to draw.

draw

public void draw(Drawable drawable,
        RenderStates renderStates)

Description copied from interface: RenderTarget

Draws a drawable object to the render target using the given render states.

Specified by:

draw in interface RenderTarget

Parameters:

drawable - the object to draw.

renderStates - the render states to use for drawing.

draw

public final void draw(Vertex[] vertices,
        PrimitiveType type)

Description copied from interface: RenderTarget

Draws a primitive of the given type using the given vertices and the default render states.

Specified by:

draw in interface RenderTarget

Parameters:

vertices - the vertices to draw.

type - the type of OpenGL primitive to draw.

draw

public void draw(Vertex[] vertices,
        PrimitiveType type,
        RenderStates states)

Description copied from interface: RenderTarget

Draws a primitive of the given type using the given vertices and the given render states.

Specified by:

draw in interface RenderTarget

Parameters:

vertices - the vertices to draw.

type - the type of OpenGL primitive to draw.

states - the render states to use for drawing.

pushGLStates

public void pushGLStates()

Description copied from interface: RenderTarget

Pushes the current OpenGL states and matrices to the stack.

Specified by:

pushGLStates in interface RenderTarget

popGLStates

public void popGLStates()

Description copied from interface: RenderTarget

Pops the last OpenGL states and matrices from the top of the stack.

Specified by:

popGLStates in interface RenderTarget

resetGLStates

public void resetGLStates()

Description copied from interface: RenderTarget

Resets the internal OpenGL states so that the target is ready for drawing.

Specified by:

resetGLStates in interface RenderTarget