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/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/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, int AntialiasingLevel)
 Construct a new renderwindow.
CSFML_API sfRenderWindowsfRenderWindow_CreateFromHandle (sfWindowHandle Handle, int AntialiasingLevel)
 Construct a renderwindow from an existing control.
CSFML_API void sfRenderWindow_Destroy (sfRenderWindow *RenderWindow)
 Destroy an existing renderwindow.
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 unsigned int sfRenderWindow_GetDepthBits (sfRenderWindow *RenderWindow)
 Get the depth buffer bits of a window.
CSFML_API unsigned int sfRenderWindow_GetStencilBits (sfRenderWindow *RenderWindow)
 Get the stencil buffer bits 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_Show (sfRenderWindow *RenderWindow, sfBool State)
 Show or hide a window.
CSFML_API sfBool sfRenderWindow_SetCurrent (sfRenderWindow *RenderWindow)
 Set 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_DrawString (sfRenderWindow *RenderWindow, sfString *String)
CSFML_API sfImagesfRenderWindow_Capture (sfRenderWindow *RenderWindow)
 Save the content of a renderwindow to an image.
CSFML_API void sfRenderWindow_SetBackgroundColor (sfRenderWindow *RenderWindow, sfColor Color)
 Change the background color of a renderwindow.
CSFML_API void sfRenderWindow_SetView (sfRenderWindow *RenderWindow, const sfView *View)
 Change the current active view of a renderwindow.
CSFML_API sfFloatRectsfRenderWindow_GetViewRect (sfRenderWindow *RenderWindow)
 Get the current view rectangle of a renderwindow.
CSFML_API void sfRenderWindow_OptimizeForNonOpenGL (sfRenderWindow *RenderWindow, sfBool Optimize)
 Tell SFML to optimize its calls to the graphics driver, in case the user is not doing custom OpenGL calls.

Typedef Documentation

typedef struct sfRenderWindow sfRenderWindow

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

Definition at line 49 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 sfRenderWindow* sfRenderWindow_Create ( sfVideoMode  Mode,
const char *  Title,
unsigned long  Style,
int  AntialiasingLevel 
)

Construct a new renderwindow.

Parameters:
Mode : Video mode to use
Title : Title of the window
Style : Window style
AntialiasingLevel : Level of antialiasing

CSFML_API sfRenderWindow* sfRenderWindow_CreateFromHandle ( sfWindowHandle  Handle,
int  AntialiasingLevel 
)

Construct a renderwindow from an existing control.

Parameters:
Handle : Platform-specific handle of the control
AntialiasingLevel : Level of antialiasing

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 : Object to draw

CSFML_API void sfRenderWindow_DrawSprite ( sfRenderWindow RenderWindow,
sfSprite Sprite 
)

CSFML_API void sfRenderWindow_DrawString ( sfRenderWindow RenderWindow,
sfString String 
)

CSFML_API unsigned int sfRenderWindow_GetDepthBits ( sfRenderWindow RenderWindow  ) 

Get the depth buffer bits of a window.

Parameters:
RenderWindow : Renderwindow object
Returns:
Depth bits (can be 0 if there is no depth buffer)

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 unsigned int sfRenderWindow_GetStencilBits ( sfRenderWindow RenderWindow  ) 

Get the stencil buffer bits of a window.

Parameters:
RenderWindow : Renderwindow object
Returns:
Stencil bits (can be 0 if there is no stencil buffer)

CSFML_API sfFloatRect* sfRenderWindow_GetViewRect ( sfRenderWindow RenderWindow  ) 

Get the current view rectangle of a renderwindow.

Parameters:
RenderWindow : Renderwindow to read
Returns:
Current view rectangle, in global coordinates

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 void sfRenderWindow_OptimizeForNonOpenGL ( sfRenderWindow RenderWindow,
sfBool  Optimize 
)

Tell SFML to optimize its calls to the graphics driver, in case the user is not doing custom OpenGL calls.

Parameters:
RenderWindow : Renderwindow to optimize
Optimize : sfTrue to enable internal states optimizations, sfFalse to go back to safe mode

CSFML_API void sfRenderWindow_SetBackgroundColor ( sfRenderWindow RenderWindow,
sfColor  Color 
)

Change the background color of a renderwindow.

Parameters:
RenderWindow : Renderwindow to modify
Color : New background color

CSFML_API sfBool sfRenderWindow_SetCurrent ( sfRenderWindow RenderWindow  ) 

Set a window as the current target for rendering.

Parameters:
RenderWindow : Renderwindow object
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_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_SetView ( sfRenderWindow RenderWindow,
const sfView View 
)

Change the current active view of a renderwindow.

Parameters:
RenderWindow : Renderwindow to modify
NewView : Pointer to the new view (pass NULL to set the default 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