Window/Window.h

Go to the documentation of this file.

 
//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef SFML_WINDOW_H
#define SFML_WINDOW_H
 
// Headers
#include <SFML/Window/Export.h>
#include <SFML/Window/Event.h>
#include <SFML/Window/VideoMode.h>
#include <SFML/Window/WindowBase.h>
#include <SFML/Window/WindowHandle.h>
#include <SFML/Window/Types.h>
#include <SFML/System/Vector2.h>
 
 
typedef enum
{
    sfContextDefault = 0,      
    sfContextCore    = 1 << 0, 
    sfContextDebug   = 1 << 2  
} sfContextAttribute;
 
 
typedef struct
{
    unsigned int depthBits;         
    unsigned int stencilBits;       
    unsigned int antialiasingLevel; 
    unsigned int majorVersion;      
    unsigned int minorVersion;      
    sfUint32     attributeFlags;    
    sfBool       sRgbCapable;       
} sfContextSettings;
 
 
CSFML_WINDOW_API sfWindow* sfWindow_create(sfVideoMode mode, const char* title, sfUint32 style, const sfContextSettings* settings);
 
CSFML_WINDOW_API sfWindow* sfWindow_createUnicode(sfVideoMode mode, const sfUint32* title, sfUint32 style, const sfContextSettings* settings);
 
CSFML_WINDOW_API sfWindow* sfWindow_createFromHandle(sfWindowHandle handle, const sfContextSettings* settings);
 
CSFML_WINDOW_API void sfWindow_destroy(sfWindow* window);
 
CSFML_WINDOW_API void sfWindow_close(sfWindow* window);
 
CSFML_WINDOW_API sfBool sfWindow_isOpen(const sfWindow* window);
 
CSFML_WINDOW_API sfContextSettings sfWindow_getSettings(const sfWindow* window);
 
CSFML_WINDOW_API sfBool sfWindow_pollEvent(sfWindow* window, sfEvent* event);
 
CSFML_WINDOW_API sfBool sfWindow_waitEvent(sfWindow* window, sfEvent* event);
 
CSFML_WINDOW_API sfVector2i sfWindow_getPosition(const sfWindow* window);
 
CSFML_WINDOW_API void sfWindow_setPosition(sfWindow* window, sfVector2i position);
 
CSFML_WINDOW_API sfVector2u sfWindow_getSize(const sfWindow* window);
 
CSFML_WINDOW_API void sfWindow_setSize(sfWindow* window, sfVector2u size);
 
CSFML_WINDOW_API void sfWindow_setTitle(sfWindow* window, const char* title);
 
CSFML_WINDOW_API void sfWindow_setUnicodeTitle(sfWindow* window, const sfUint32* title);
 
CSFML_WINDOW_API void sfWindow_setIcon(sfWindow* window, unsigned int width, unsigned int height, const sfUint8* pixels);
 
CSFML_WINDOW_API void sfWindow_setVisible(sfWindow* window, sfBool visible);
 
CSFML_WINDOW_API void sfWindow_setVerticalSyncEnabled(sfWindow* window, sfBool enabled);
 
CSFML_WINDOW_API void sfWindow_setMouseCursorVisible(sfWindow* window, sfBool visible);
 
CSFML_WINDOW_API void sfWindow_setMouseCursorGrabbed(sfWindow* window, sfBool grabbed);
 
CSFML_WINDOW_API void sfWindow_setMouseCursor(sfWindow* window, const sfCursor* cursor);
 
CSFML_WINDOW_API void sfWindow_setKeyRepeatEnabled(sfWindow* window, sfBool enabled);
 
CSFML_WINDOW_API void sfWindow_setFramerateLimit(sfWindow* window, unsigned int limit);
 
CSFML_WINDOW_API void sfWindow_setJoystickThreshold(sfWindow* window, float threshold);
 
CSFML_WINDOW_API sfBool sfWindow_setActive(sfWindow* window, sfBool active);
 
CSFML_WINDOW_API void sfWindow_requestFocus(sfWindow* window);
 
CSFML_WINDOW_API sfBool sfWindow_hasFocus(const sfWindow* window);
 
CSFML_WINDOW_API void sfWindow_display(sfWindow* window);
 
CSFML_WINDOW_API sfWindowHandle sfWindow_getSystemHandle(const sfWindow* window);
 
CSFML_WINDOW_API sfBool sfWindow_createVulkanSurface(sfWindow* window, const VkInstance* instance, VkSurfaceKHR* surface, const VkAllocationCallbacks* allocator);
 
 
#endif // SFML_WINDOW_H