#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 sfRenderWindow * | sfRenderWindow_Create (sfVideoMode Mode, const char *Title, unsigned long Style, sfWindowSettings Params) |
Construct a new renderwindow. | |
CSFML_API sfRenderWindow * | sfRenderWindow_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_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 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 sfInput * | sfRenderWindow_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 sfImage * | sfRenderWindow_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, sfView *View) |
Change the current active view of a renderwindow. | |
CSFML_API const sfView * | sfRenderWindow_GetView (sfRenderWindow *RenderWindow) |
Get the current active view of a renderwindow. | |
CSFML_API sfView * | sfRenderWindow_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 struct sfRenderWindow sfRenderWindow |
sfRenderWindow is a simple wrapper for sfWindow that allows easy 2D rendering
Definition at line 51 of file RenderWindow.h.
CSFML_API sfImage* sfRenderWindow_Capture | ( | sfRenderWindow * | RenderWindow | ) |
Save the content of a renderwindow to an image.
RenderWindow | : Renderwindow to capture |
CSFML_API void sfRenderWindow_Close | ( | sfRenderWindow * | RenderWindow | ) |
Close a renderwindow (but doesn't destroy the internal data).
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.
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.
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.
Handle | : Platform-specific handle of the control | |
Params | : Creation settings |
CSFML_API void sfRenderWindow_Destroy | ( | sfRenderWindow * | RenderWindow | ) |
Destroy an existing renderwindow.
RenderWindow | : Renderwindow to destroy |
CSFML_API void sfRenderWindow_Display | ( | sfRenderWindow * | RenderWindow | ) |
Display a window on screen.
RenderWindow | : Renderwindow object |
CSFML_API void sfRenderWindow_DrawPostFX | ( | sfRenderWindow * | RenderWindow, | |
sfPostFX * | PostFX | |||
) |
Draw something on a renderwindow.
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
RenderWindow | : Renderwindow object | |
Enabled | : sfTrue to enable, sfFalse to disable |
CSFML_API sfView* sfRenderWindow_GetDefaultView | ( | sfRenderWindow * | RenderWindow | ) |
Get the default view of a renderwindow.
RenderWindow | : Renderwindow |
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.
RenderWindow | : Renderwindow object | |
Event | : Event to fill, if any |
CSFML_API float sfRenderWindow_GetFrameTime | ( | sfRenderWindow * | RenderWindow | ) |
Get time elapsed since last frame of a window.
RenderWindow | : Renderwindow object |
CSFML_API unsigned int sfRenderWindow_GetHeight | ( | sfRenderWindow * | RenderWindow | ) |
Get the height of the rendering region of a window.
RenderWindow | : Renderwindow object |
CSFML_API sfInput* sfRenderWindow_GetInput | ( | sfRenderWindow * | RenderWindow | ) |
Get the input manager of a window.
RenderWindow | : Renderwindow object |
CSFML_API sfWindowSettings sfRenderWindow_GetSettings | ( | sfRenderWindow * | RenderWindow | ) |
Get the creation settings of a window.
RenderWindow | : Renderwindow object |
CSFML_API const sfView* sfRenderWindow_GetView | ( | sfRenderWindow * | RenderWindow | ) |
Get the current active view of a renderwindow.
RenderWindow | : Renderwindow |
CSFML_API unsigned int sfRenderWindow_GetWidth | ( | sfRenderWindow * | RenderWindow | ) |
Get the width of the rendering region of a window.
RenderWindow | : Renderwindow object |
CSFML_API sfBool sfRenderWindow_IsOpened | ( | sfRenderWindow * | RenderWindow | ) |
Tell whether or not a renderwindow is opened.
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
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.
RenderWindow | : Renderwindow object | |
Active | : sfTrue to activate, sfFalse to deactivate |
CSFML_API void sfRenderWindow_SetBackgroundColor | ( | sfRenderWindow * | RenderWindow, | |
sfColor | Color | |||
) |
Change the background color of a renderwindow.
RenderWindow | : Renderwindow to modify | |
Color | : New background color |
CSFML_API void sfRenderWindow_SetCursorPosition | ( | sfRenderWindow * | RenderWindow, | |
unsigned int | Left, | |||
unsigned int | Top | |||
) |
Change the position of the mouse cursor on a window.
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.
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
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
RenderWindow | : Renderwindow object | |
Left | : Left position | |
Top | : Top position |
CSFML_API void sfRenderWindow_SetView | ( | sfRenderWindow * | RenderWindow, | |
sfView * | View | |||
) |
Change the current active view of a renderwindow.
RenderWindow | : Renderwindow to modify | |
NewView | : Pointer to the new view |
CSFML_API void sfRenderWindow_Show | ( | sfRenderWindow * | RenderWindow, | |
sfBool | State | |||
) |
Show or hide a window.
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.
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.
RenderWindow | : Renderwindow object | |
Enabled | : sfTrue to enable v-sync, sfFalse to deactivate |