RenderWindow.h File Reference

#include <SFML/Config.h>
#include <SFML/Graphics/Color.h>
#include <SFML/Graphics/Image.h>
#include <SFML/Graphics/PostFX.h>
#include <SFML/Graphics/Rect.h>
#include <SFML/Graphics/Shape.h>
#include <SFML/Graphics/Sprite.h>
#include <SFML/Graphics/String.h>
#include <SFML/Graphics/View.h>
#include <SFML/Window/Event.h>
#include <SFML/Window/Input.h>
#include <SFML/Window/VideoMode.h>
#include <SFML/Window/Window.h>
#include <SFML/Window/WindowHandle.h>

Go to the source code of this file.


Typedefs

typedef sfRenderWindow sfRenderWindow
 sfRenderWindow is a simple wrapper for sfWindow that allows easy 2D rendering

Functions

CSFML_API sfRenderWindowsfRenderWindow_Create (sfVideoMode Mode, const char *Title, unsigned long Style, sfWindowSettings Params)
 Construct a new renderwindow.
CSFML_API sfRenderWindowsfRenderWindow_CreateFromHandle (sfWindowHandle Handle, sfWindowSettings Params)
 Construct a renderwindow from an existing control.
CSFML_API void sfRenderWindow_Destroy (sfRenderWindow *RenderWindow)
 Destroy an existing renderwindow.
CSFML_API void sfRenderWindow_Close (sfRenderWindow *RenderWindow)
 Close a renderwindow (but doesn't destroy the internal data).
CSFML_API sfBool sfRenderWindow_IsOpened (sfRenderWindow *RenderWindow)
 Tell whether or not a renderwindow is opened.
CSFML_API unsigned int sfRenderWindow_GetWidth (sfRenderWindow *RenderWindow)
 Get the width of the rendering region of a window.
CSFML_API unsigned int sfRenderWindow_GetHeight (sfRenderWindow *RenderWindow)
 Get the height of the rendering region of a window.
CSFML_API sfWindowSettings sfRenderWindow_GetSettings (sfRenderWindow *RenderWindow)
 Get the creation settings of a window.
CSFML_API sfBool sfRenderWindow_GetEvent (sfRenderWindow *RenderWindow, sfEvent *Event)
 Get the event on top of events stack of a window, if any, and pop it.
CSFML_API void sfRenderWindow_UseVerticalSync (sfRenderWindow *RenderWindow, sfBool Enabled)
 Enable / disable vertical synchronization on a window.
CSFML_API void sfRenderWindow_ShowMouseCursor (sfRenderWindow *RenderWindow, sfBool Show)
 Show or hide the mouse cursor on a window.
CSFML_API void sfRenderWindow_SetCursorPosition (sfRenderWindow *RenderWindow, unsigned int Left, unsigned int Top)
 Change the position of the mouse cursor on a window.
CSFML_API void sfRenderWindow_SetPosition (sfRenderWindow *RenderWindow, int Left, int Top)
 Change the position of a window on screen.
CSFML_API void sfRenderWindow_SetSize (sfRenderWindow *RenderWindow, unsigned int Width, unsigned int Height)
 Change the size of the rendering region of a window.
CSFML_API void sfRenderWindow_Show (sfRenderWindow *RenderWindow, sfBool State)
 Show or hide a window.
CSFML_API void sfRenderWindow_EnableKeyRepeat (sfRenderWindow *RenderWindow, sfBool Enabled)
 Enable or disable automatic key-repeat for keydown events.
CSFML_API void sfRenderWindow_SetIcon (sfRenderWindow *RenderWindow, unsigned int Width, unsigned int Height, sfUint8 *Pixels)
 Change the window's icon.
CSFML_API sfBool sfRenderWindow_SetActive (sfRenderWindow *RenderWindow, sfBool Active)
 Activate or deactivate a window as the current target for rendering.
CSFML_API void sfRenderWindow_Display (sfRenderWindow *RenderWindow)
 Display a window on screen.
CSFML_API sfInputsfRenderWindow_GetInput (sfRenderWindow *RenderWindow)
 Get the input manager of a window.
CSFML_API void sfRenderWindow_SetFramerateLimit (sfRenderWindow *RenderWindow, unsigned int Limit)
 Limit the framerate to a maximum fixed frequency for a window.
CSFML_API float sfRenderWindow_GetFrameTime (sfRenderWindow *RenderWindow)
 Get time elapsed since last frame of a window.
CSFML_API void sfRenderWindow_SetJoystickThreshold (sfRenderWindow *RenderWindow, float Threshold)
 Change the joystick threshold, ie.
CSFML_API void sfRenderWindow_DrawPostFX (sfRenderWindow *RenderWindow, sfPostFX *PostFX)
 Draw something on a renderwindow.
CSFML_API void sfRenderWindow_DrawSprite (sfRenderWindow *RenderWindow, sfSprite *Sprite)
CSFML_API void sfRenderWindow_DrawShape (sfRenderWindow *RenderWindow, sfShape *Shape)
CSFML_API void sfRenderWindow_DrawString (sfRenderWindow *RenderWindow, sfString *String)
CSFML_API sfImagesfRenderWindow_Capture (sfRenderWindow *RenderWindow)
 Save the content of a renderwindow to an image.
CSFML_API void sfRenderWindow_Clear (sfRenderWindow *RenderWindow, sfColor Color)
 Clear the screen with the given color.
CSFML_API void sfRenderWindow_SetView (sfRenderWindow *RenderWindow, sfView *View)
 Change the current active view of a renderwindow.
CSFML_API const sfViewsfRenderWindow_GetView (sfRenderWindow *RenderWindow)
 Get the current active view of a renderwindow.
CSFML_API sfViewsfRenderWindow_GetDefaultView (sfRenderWindow *RenderWindow)
 Get the default view of a renderwindow.
CSFML_API void sfRenderWindow_ConvertCoords (sfRenderWindow *RenderWindow, unsigned int WindowX, unsigned int WindowY, float *ViewX, float *ViewY, sfView *TargetView)
 Convert a point in window coordinates into view coordinates.
CSFML_API void sfRenderWindow_PreserveOpenGLStates (sfRenderWindow *RenderWindow, sfBool Preserve)
 Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

Typedef Documentation

typedef struct sfRenderWindow sfRenderWindow

sfRenderWindow is a simple wrapper for sfWindow that allows easy 2D rendering

Definition at line 51 of file RenderWindow.h.


Function Documentation

CSFML_API sfImage* sfRenderWindow_Capture ( sfRenderWindow RenderWindow  ) 

Save the content of a renderwindow to an image.

Parameters:
RenderWindow : Renderwindow to capture
Returns:
Image instance containing the contents of the screen

CSFML_API void sfRenderWindow_Clear ( sfRenderWindow RenderWindow,
sfColor  Color 
)

Clear the screen with the given color.

Parameters:
RenderWindow : Renderwindow to modify
Color : Fill color

CSFML_API void sfRenderWindow_Close ( sfRenderWindow RenderWindow  ) 

Close a renderwindow (but doesn't destroy the internal data).

Parameters:
RenderWindow : Renderwindow to close

CSFML_API void sfRenderWindow_ConvertCoords ( sfRenderWindow RenderWindow,
unsigned int  WindowX,
unsigned int  WindowY,
float *  ViewX,
float *  ViewY,
sfView TargetView 
)

Convert a point in window coordinates into view coordinates.

Parameters:
RenderWindow : Target Renderwindow
WindowX : X coordinate of the point to convert, relative to the window
WindowY : Y coordinate of the point to convert, relative to the window
ViewX : Pointer to fill with the X coordinate of the converted point
ViewY : Pointer to fill with the Y coordinate of the converted point
TargetView : Target view to convert the point to (pass NULL to use the current view)

CSFML_API sfRenderWindow* sfRenderWindow_Create ( sfVideoMode  Mode,
const char *  Title,
unsigned long  Style,
sfWindowSettings  Params 
)

Construct a new renderwindow.

Parameters:
Mode : Video mode to use
Title : Title of the window
Style : Window style
Params : Creation settings

CSFML_API sfRenderWindow* sfRenderWindow_CreateFromHandle ( sfWindowHandle  Handle,
sfWindowSettings  Params 
)

Construct a renderwindow from an existing control.

Parameters:
Handle : Platform-specific handle of the control
Params : Creation settings

CSFML_API void sfRenderWindow_Destroy ( sfRenderWindow RenderWindow  ) 

Destroy an existing renderwindow.

Parameters:
RenderWindow : Renderwindow to destroy

CSFML_API void sfRenderWindow_Display ( sfRenderWindow RenderWindow  ) 

Display a window on screen.

Parameters:
RenderWindow : Renderwindow object

CSFML_API void sfRenderWindow_DrawPostFX ( sfRenderWindow RenderWindow,
sfPostFX PostFX 
)

Draw something on a renderwindow.

Parameters:
RenderWindow : Renderwindow to draw in
PostFX / Sprite / String / shape : Object to draw

CSFML_API void sfRenderWindow_DrawShape ( sfRenderWindow RenderWindow,
sfShape Shape 
)

CSFML_API void sfRenderWindow_DrawSprite ( sfRenderWindow RenderWindow,
sfSprite Sprite 
)

CSFML_API void sfRenderWindow_DrawString ( sfRenderWindow RenderWindow,
sfString String 
)

CSFML_API void sfRenderWindow_EnableKeyRepeat ( sfRenderWindow RenderWindow,
sfBool  Enabled 
)

Enable or disable automatic key-repeat for keydown events.

Automatic key-repeat is enabled by default

Parameters:
RenderWindow : Renderwindow object
Enabled : sfTrue to enable, sfFalse to disable

CSFML_API sfView* sfRenderWindow_GetDefaultView ( sfRenderWindow RenderWindow  ) 

Get the default view of a renderwindow.

Parameters:
RenderWindow : Renderwindow
Returns:
Default view of the render window

CSFML_API sfBool sfRenderWindow_GetEvent ( sfRenderWindow RenderWindow,
sfEvent Event 
)

Get the event on top of events stack of a window, if any, and pop it.

Parameters:
RenderWindow : Renderwindow object
Event : Event to fill, if any
Returns:
sfTrue if an event was returned, sfFalse if events stack was empty

CSFML_API float sfRenderWindow_GetFrameTime ( sfRenderWindow RenderWindow  ) 

Get time elapsed since last frame of a window.

Parameters:
RenderWindow : Renderwindow object
Returns:
Time elapsed, in seconds

CSFML_API unsigned int sfRenderWindow_GetHeight ( sfRenderWindow RenderWindow  ) 

Get the height of the rendering region of a window.

Parameters:
RenderWindow : Renderwindow object
Returns:
Height in pixels

CSFML_API sfInput* sfRenderWindow_GetInput ( sfRenderWindow RenderWindow  ) 

Get the input manager of a window.

Parameters:
RenderWindow : Renderwindow object
Returns:
Reference to the input

CSFML_API sfWindowSettings sfRenderWindow_GetSettings ( sfRenderWindow RenderWindow  ) 

Get the creation settings of a window.

Parameters:
RenderWindow : Renderwindow object
Returns:
Settings used to create the window

CSFML_API const sfView* sfRenderWindow_GetView ( sfRenderWindow RenderWindow  ) 

Get the current active view of a renderwindow.

Parameters:
RenderWindow : Renderwindow
Returns:
Current active view

CSFML_API unsigned int sfRenderWindow_GetWidth ( sfRenderWindow RenderWindow  ) 

Get the width of the rendering region of a window.

Parameters:
RenderWindow : Renderwindow object
Returns:
Width in pixels

CSFML_API sfBool sfRenderWindow_IsOpened ( sfRenderWindow RenderWindow  ) 

Tell whether or not a renderwindow is opened.

Parameters:
RenderWindow : Renderwindow object

CSFML_API void sfRenderWindow_PreserveOpenGLStates ( sfRenderWindow RenderWindow,
sfBool  Preserve 
)

Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.

Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default

Parameters:
RenderWindow : Target Renderwindow
Preserve : True to preserve OpenGL states, false to let SFML optimize

CSFML_API sfBool sfRenderWindow_SetActive ( sfRenderWindow RenderWindow,
sfBool  Active 
)

Activate or deactivate a window as the current target for rendering.

Parameters:
RenderWindow : Renderwindow object
Active : sfTrue to activate, sfFalse to deactivate
Returns:
True if operation was successful, false otherwise

CSFML_API void sfRenderWindow_SetCursorPosition ( sfRenderWindow RenderWindow,
unsigned int  Left,
unsigned int  Top 
)

Change the position of the mouse cursor on a window.

Parameters:
RenderWindow : Renderwindow object
Left : Left coordinate of the cursor, relative to the window
Top : Top coordinate of the cursor, relative to the window

CSFML_API void sfRenderWindow_SetFramerateLimit ( sfRenderWindow RenderWindow,
unsigned int  Limit 
)

Limit the framerate to a maximum fixed frequency for a window.

Parameters:
RenderWindow : Renderwindow object
Limit : Framerate limit, in frames per seconds (use 0 to disable limit)

CSFML_API void sfRenderWindow_SetIcon ( sfRenderWindow RenderWindow,
unsigned int  Width,
unsigned int  Height,
sfUint8 *  Pixels 
)

Change the window's icon.

Parameters:
RenderWindow : Renderwindow object
Width : Icon's width, in pixels
Height : Icon's height, in pixels
Pixels : Pointer to the pixels in memory, format must be RGBA 32 bits

CSFML_API void sfRenderWindow_SetJoystickThreshold ( sfRenderWindow RenderWindow,
float  Threshold 
)

Change the joystick threshold, ie.

the value below which no move event will be generated

Parameters:
RenderWindow : Renderwindow object
Threshold : New threshold, in range [0, 100]

CSFML_API void sfRenderWindow_SetPosition ( sfRenderWindow RenderWindow,
int  Left,
int  Top 
)

Change the position of a window on screen.

Only works for top-level windows

Parameters:
RenderWindow : Renderwindow object
Left : Left position
Top : Top position

CSFML_API void sfRenderWindow_SetSize ( sfRenderWindow RenderWindow,
unsigned int  Width,
unsigned int  Height 
)

Change the size of the rendering region of a window.

Parameters:
RenderWindow : Renderwindow object
Width : New Width
Height : New Height

CSFML_API void sfRenderWindow_SetView ( sfRenderWindow RenderWindow,
sfView View 
)

Change the current active view of a renderwindow.

Parameters:
RenderWindow : Renderwindow to modify
NewView : Pointer to the new view

CSFML_API void sfRenderWindow_Show ( sfRenderWindow RenderWindow,
sfBool  State 
)

Show or hide a window.

Parameters:
RenderWindow : Renderwindow object
State : sfTrue to show, sfFalse to hide

CSFML_API void sfRenderWindow_ShowMouseCursor ( sfRenderWindow RenderWindow,
sfBool  Show 
)

Show or hide the mouse cursor on a window.

Parameters:
RenderWindow : RenderWindow object
Show : sfTrue to show, sfFalse to hide

CSFML_API void sfRenderWindow_UseVerticalSync ( sfRenderWindow RenderWindow,
sfBool  Enabled 
)

Enable / disable vertical synchronization on a window.

Parameters:
RenderWindow : Renderwindow object
Enabled : sfTrue to enable v-sync, sfFalse to deactivate