CSFML - C binding of the Simple and Fast Multimedia Library

CSFML 3.0.0
Loading...
Searching...
No Matches
VideoMode.h
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2026 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#pragma once
26
28// Headers
30#include <CSFML/Window/Export.h>
31
32#include <CSFML/System/Vector2.h>
33
34#include <stddef.h>
35
36
43 typedef struct
44{
45 sfVector2u size;
46 unsigned int bitsPerPixel;
47} sfVideoMode;
48
49
56 CSFML_WINDOW_API sfVideoMode sfVideoMode_getDesktopMode(void);
57
74 CSFML_WINDOW_API const sfVideoMode* sfVideoMode_getFullscreenModes(size_t* count);
75
88 CSFML_WINDOW_API bool sfVideoMode_isValid(sfVideoMode mode);
Vector2.h
sfVideoMode_getFullscreenModes
const sfVideoMode * sfVideoMode_getFullscreenModes(size_t *count)
Retrieve all the video modes supported in fullscreen mode.
sfVideoMode_getDesktopMode
sfVideoMode sfVideoMode_getDesktopMode(void)
Get the current desktop video mode.
sfVideoMode_isValid
bool sfVideoMode_isValid(sfVideoMode mode)
Tell whether or not a video mode is valid.
Export.h
CSFML_WINDOW_API
#define CSFML_WINDOW_API
Definition Window/Export.h:42
sfVector2u
2-component vector of unsigned integers
Definition Vector2.h:49
sfVideoMode
sfVideoMode defines a video mode (width, height, bpp, frequency) and provides functions for getting m...
Definition VideoMode.h:44
sfVideoMode::size
sfVector2u size
Video mode size, in pixels.
Definition VideoMode.h:45
sfVideoMode::bitsPerPixel
unsigned int bitsPerPixel
Video mode pixel depth, in bits per pixels.
Definition VideoMode.h:46