Loading...
Searching...
No Matches
RenderWindow.h
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef SFML_RENDERWINDOW_H
26#define SFML_RENDERWINDOW_H
27
29// Headers
32#include <SFML/Graphics/Color.h>
33#include <SFML/Graphics/Rect.h>
34#include <SFML/Graphics/Types.h>
38#include <SFML/Window/Event.h>
41#include <SFML/Window/Window.h>
42#include <SFML/System/Vector2.h>
43#include <stddef.h>
44
45
56
67
76
84
92
100
110
121
132
142
153
163
173
182
190CSFML_GRAPHICS_API void sfRenderWindow_setTitle(sfRenderWindow* renderWindow, const char* title);
191
200
210CSFML_GRAPHICS_API void sfRenderWindow_setIcon(sfRenderWindow* renderWindow, unsigned int width, unsigned int height, const sfUint8* pixels);
211
220
229
238
253
272
283
292
301
312
326
338
346
356
365
374
384
394
405
435
461
471CSFML_GRAPHICS_API void sfRenderWindow_drawText(sfRenderWindow* renderWindow, const sfText* object, const sfRenderStates* states);
472CSFML_GRAPHICS_API void sfRenderWindow_drawShape(sfRenderWindow* renderWindow, const sfShape* object, const sfRenderStates* states);
478
490 const sfVertexBuffer* object, size_t firstVertex,
491 size_t vertexCount, const sfRenderStates* states);
492
504 const sfVertex* vertices, size_t vertexCount,
505 sfPrimitiveType type, const sfRenderStates* states);
506
529
540
554
581
594
606
620
633
634
635#endif // SFML_RENDERWINDOW_H
unsigned int sfUint32
Definition Config.h:176
int sfBool
Definition Config.h:153
unsigned char sfUint8
Definition Config.h:168
#define CSFML_DEPRECATED
Definition Config.h:146
#define CSFML_GRAPHICS_API
struct sfRenderWindow sfRenderWindow
struct sfCircleShape sfCircleShape
struct sfImage sfImage
struct sfVertexBuffer sfVertexBuffer
struct sfShape sfShape
struct sfVertexArray sfVertexArray
struct sfSprite sfSprite
struct sfRectangleShape sfRectangleShape
struct sfText sfText
struct sfConvexShape sfConvexShape
struct sfView sfView
sfPrimitiveType
Types of primitives that a sf::VertexArray can render.
sfBool sfRenderWindow_pollEvent(sfRenderWindow *renderWindow, sfEvent *event)
Get the event on top of event queue of a render window, if any, and pop it.
void sfRenderWindow_resetGLStates(sfRenderWindow *renderWindow)
Reset the internal OpenGL states so that the target is ready for drawing.
sfContextSettings sfRenderWindow_getSettings(const sfRenderWindow *renderWindow)
Get the creation settings of a render window.
sfBool sfRenderWindow_isSrgb(const sfRenderWindow *renderWindow)
Tell if the render window will use sRGB encoding when drawing on it.
void sfRenderWindow_setVerticalSyncEnabled(sfRenderWindow *renderWindow, sfBool enabled)
Enable / disable vertical synchronization on a render window.
sfBool sfRenderWindow_setActive(sfRenderWindow *renderWindow, sfBool active)
Activate or deactivate a render window as the current target for rendering.
const sfView * sfRenderWindow_getDefaultView(const sfRenderWindow *renderWindow)
Get the default view of a render window.
void sfRenderWindow_setFramerateLimit(sfRenderWindow *renderWindow, unsigned int limit)
Limit the framerate to a maximum fixed frequency for a render window.
void sfRenderWindow_setVisible(sfRenderWindow *renderWindow, sfBool visible)
Show or hide a render window.
void sfRenderWindow_drawVertexBuffer(sfRenderWindow *renderWindow, const sfVertexBuffer *object, const sfRenderStates *states)
void sfRenderWindow_setMouseCursorVisible(sfRenderWindow *renderWindow, sfBool show)
Show or hide the mouse cursor on a render window.
void sfRenderWindow_setSize(sfRenderWindow *renderWindow, sfVector2u size)
Change the size of the rendering region of a render window.
sfImage * sfRenderWindow_capture(const sfRenderWindow *renderWindow)
Copy the current contents of the window to an image.
void sfRenderWindow_setJoystickThreshold(sfRenderWindow *renderWindow, float threshold)
Change the joystick threshold, ie.
void sfRenderWindow_display(sfRenderWindow *renderWindow)
Display a render window on screen.
sfBool sfRenderWindow_waitEvent(sfRenderWindow *renderWindow, sfEvent *event)
Wait for an event and return it.
sfIntRect sfRenderWindow_getViewport(const sfRenderWindow *renderWindow, const sfView *view)
Get the viewport of a view applied to this target.
const sfView * sfRenderWindow_getView(const sfRenderWindow *renderWindow)
Get the current active view of a render window.
sfVector2i sfTouch_getPositionRenderWindow(unsigned int finger, const sfRenderWindow *relativeTo)
Get the current position of a touch in window coordinates.
sfVector2i sfMouse_getPositionRenderWindow(const sfRenderWindow *relativeTo)
Get the current position of the mouse relative to a render-window.
void sfRenderWindow_clear(sfRenderWindow *renderWindow, sfColor color)
Clear a render window with the given color.
sfWindowHandle sfRenderWindow_getSystemHandle(const sfRenderWindow *renderWindow)
Retrieve the OS-specific handle of a render window.
void sfRenderWindow_setMouseCursor(sfRenderWindow *window, const sfCursor *cursor)
Set the displayed cursor to a native system cursor.
void sfRenderWindow_drawVertexArray(sfRenderWindow *renderWindow, const sfVertexArray *object, const sfRenderStates *states)
void sfRenderWindow_pushGLStates(sfRenderWindow *renderWindow)
Save the current OpenGL render states and matrices.
void sfRenderWindow_drawShape(sfRenderWindow *renderWindow, const sfShape *object, const sfRenderStates *states)
sfVector2i sfRenderWindow_mapCoordsToPixel(const sfRenderWindow *renderWindow, sfVector2f point, const sfView *view)
Convert a point from world coordinates to window coordinates.
void sfRenderWindow_setKeyRepeatEnabled(sfRenderWindow *renderWindow, sfBool enabled)
Enable or disable automatic key-repeat for keydown events.
sfRenderWindow * sfRenderWindow_createFromHandle(sfWindowHandle handle, const sfContextSettings *settings)
Construct a render window from an existing control.
void sfRenderWindow_drawSprite(sfRenderWindow *renderWindow, const sfSprite *object, const sfRenderStates *states)
Draw a drawable object to the render-target.
void sfRenderWindow_drawCircleShape(sfRenderWindow *renderWindow, const sfCircleShape *object, const sfRenderStates *states)
void sfRenderWindow_setUnicodeTitle(sfRenderWindow *renderWindow, const sfUint32 *title)
Change the title of a render window (with a UTF-32 string)
sfBool sfRenderWindow_isOpen(const sfRenderWindow *renderWindow)
Tell whether or not a render window is opened.
void sfRenderWindow_setView(sfRenderWindow *renderWindow, const sfView *view)
Change the current active view of a render window.
void sfRenderWindow_setTitle(sfRenderWindow *renderWindow, const char *title)
Change the title of a render window.
void sfRenderWindow_requestFocus(sfRenderWindow *renderWindow)
Request the current render window to be made the active foreground window.
void sfRenderWindow_drawConvexShape(sfRenderWindow *renderWindow, const sfConvexShape *object, const sfRenderStates *states)
void sfMouse_setPositionRenderWindow(sfVector2i position, const sfRenderWindow *relativeTo)
Set the current position of the mouse relative to a render window.
void sfRenderWindow_drawText(sfRenderWindow *renderWindow, const sfText *object, const sfRenderStates *states)
void sfRenderWindow_setPosition(sfRenderWindow *renderWindow, sfVector2i position)
Change the position of a render window on screen.
sfBool sfRenderWindow_hasFocus(const sfRenderWindow *renderWindow)
Check whether the render window has the input focus.
void sfRenderWindow_drawPrimitives(sfRenderWindow *renderWindow, const sfVertex *vertices, size_t vertexCount, sfPrimitiveType type, const sfRenderStates *states)
Draw primitives defined by an array of vertices to a render window.
void sfRenderWindow_close(sfRenderWindow *renderWindow)
Close a render window (but doesn't destroy the internal data)
void sfRenderWindow_drawVertexBufferRange(sfRenderWindow *renderWindow, const sfVertexBuffer *object, size_t firstVertex, size_t vertexCount, const sfRenderStates *states)
Draw primitives defined by a vertex buffer.
sfVector2f sfRenderWindow_mapPixelToCoords(const sfRenderWindow *renderWindow, sfVector2i point, const sfView *view)
Convert a point from window coordinates to world coordinates.
void sfRenderWindow_drawRectangleShape(sfRenderWindow *renderWindow, const sfRectangleShape *object, const sfRenderStates *states)
void sfRenderWindow_popGLStates(sfRenderWindow *renderWindow)
Restore the previously saved OpenGL render states and matrices.
sfRenderWindow * sfRenderWindow_createUnicode(sfVideoMode mode, const sfUint32 *title, sfUint32 style, const sfContextSettings *settings)
Construct a new render window (with a UTF-32 title)
void sfRenderWindow_setMouseCursorGrabbed(sfRenderWindow *renderWindow, sfBool grabbed)
Grab or release the mouse cursor.
sfRenderWindow * sfRenderWindow_create(sfVideoMode mode, const char *title, sfUint32 style, const sfContextSettings *settings)
Construct a new render window.
sfVector2i sfRenderWindow_getPosition(const sfRenderWindow *renderWindow)
Get the position of a render window.
void sfRenderWindow_setIcon(sfRenderWindow *renderWindow, unsigned int width, unsigned int height, const sfUint8 *pixels)
Change a render window's icon.
void sfRenderWindow_destroy(sfRenderWindow *renderWindow)
Destroy an existing render window.
sfVector2u sfRenderWindow_getSize(const sfRenderWindow *renderWindow)
Get the size of the rendering region of a render window.
sfBool sfRenderWindow_createVulkanSurface(sfRenderWindow *renderWindow, const VkInstance *instance, VkSurfaceKHR *surface, const VkAllocationCallbacks *allocator)
Create a Vulkan rendering surface.
struct VkInstance_T * VkInstance
Definition Vulkan.h:32
struct VkAllocationCallbacks VkAllocationCallbacks
Definition Vulkan.h:44
sfUint64 VkSurfaceKHR
Definition Vulkan.h:40
struct sfCursor sfCursor
Utility class for manpulating RGBA colors.
Definition Color.h:39
Structure defining the window's creation settings.
Define the states used for drawing to a RenderTarget.
2-component vector of floats
Definition Vector2.h:61
2-component vector of integers
Definition Vector2.h:39
2-component vector of unsigned integers
Definition Vector2.h:50
Define a point with color and texture coordinates.
Definition Vertex.h:40
sfVideoMode defines a video mode (width, height, bpp, frequency) and provides functions for getting m...
Definition VideoMode.h:42
sfEvent defines a system event and its parameters
Definition Event.h:222