#include <video.hpp>

Classes
struct	error

class	quit
	Type that can be thrown as an exception to quit to desktop. More...

class	video_event_handler
	Helper class to manage SDL events. More...

Public Types
enum	FAKE_TYPES { NO_FAKE, FAKE, FAKE_TEST }

Public Member Functions
	CVideo (const CVideo &)=delete

CVideo &	operator= (const CVideo &)=delete

	CVideo (FAKE_TYPES type=NO_FAKE)

	~CVideo ()

void	make_fake ()

void	make_test_fake (const unsigned width=1024, const unsigned height=768)
	Creates a fake frame buffer for the unit tests. More...

bool	faked () const

bool	non_interactive () const

void	init_window ()
	Initializes a new SDL window instance, taking into account any preiously saved states. More...

sdl::window *	get_window ()
	Returns a pointer to the underlying SDL window. More...

bool	has_window ()

void	set_fullscreen (bool ison)

void	toggle_fullscreen ()

bool	is_fullscreen () const

bool	supports_vsync () const

bool	set_resolution (const unsigned width, const unsigned height)

bool	set_resolution (const point &resolution)
	Set the window resolution. More...

point	current_resolution ()

std::vector< point >	get_available_resolutions (const bool include_current=false)
	Returns the list of available screen resolutions. More...

SDL_Rect	screen_area (bool as_pixels=true) const
	Returns the current window renderer area, either in pixels or screen coordinates. More...

int	get_width (bool as_pixels=true) const
	Returns the window renderer width in pixels or screen coordinates. More...

int	get_height (bool as_pixels=true) const
	Returns the window renderer height in pixels or in screen coordinates. More...

std::pair< float, float >	get_dpi () const
	The current game screen dpi. More...

std::pair< float, float >	get_dpi_scale_factor () const
	The current scale factor on High-DPI screens. More...

bool	window_has_flags (uint32_t flags) const
	Tests whether the given flags are currently set on the SDL window. More...

void	set_window_title (const std::string &title)
	Sets the title of the main window. More...

void	set_window_icon (surface &icon)
	Sets the icon of the main window. More...

int	current_refresh_rate () const

void	blit_surface (int x, int y, surface surf, SDL_Rect srcrect=nullptr, SDL_Rect clip_rect=nullptr)
	Draws a surface directly onto the screen framebuffer. More...

void	flip ()
	Renders the screen. More...

void	update_framebuffer ()
	Updates and ensures the framebuffer surface is valid. More...

void	clear_screen ()
	Clear the screen contents. More...

surface &	getSurface ()
	Returns a reference to the framebuffer. More...

void	lock_updates (bool value)
	Stop the screen being redrawn. More...

bool	update_locked () const
	Whether the screen has been 'locked' or not. More...

void	lock_flips (bool)

int	set_help_string (const std::string &str)
	Displays a help string with the given text. More...

void	clear_help_string (int handle)
	Removes the help string with the given handle. More...

void	clear_all_help_strings ()
	Removes all help strings. More...

Static Public Member Functions
static bool	setup_completed ()

static CVideo &	get_singleton ()

static std::string	current_driver ()

static std::vector< std::string >	enumerate_drivers ()

static void	delay (unsigned int milliseconds)
	Waits a given number of milliseconds before returning. More...

Private Types
enum	MODE_EVENT { TO_RES, TO_FULLSCREEN, TO_WINDOWED, TO_MAXIMIZED_WINDOW }

Private Member Functions
void	set_window_mode (const MODE_EVENT mode, const point &size)
	Sets the window's mode - ie, changing it to fullscreen, maximizing, etc. More...

void	initSDL ()
	Initializes the SDL video subsystem. More...

Private Attributes
std::unique_ptr< sdl::window >	window
	The SDL window object. More...

bool	fake_screen_

video_event_handler	event_handler_

int	help_string_
	Curent ID of the help string. More...

int	updated_locked_

int	flip_locked_

int	refresh_rate_

Static Private Attributes
static CVideo *	singleton_ = nullptr

Detailed Description

Definition at line 32 of file video.hpp.

Member Enumeration Documentation

◆ FAKE_TYPES

enum CVideo::FAKE_TYPES

Enumerator
NO_FAKE
FAKE
FAKE_TEST

Definition at line 38 of file video.hpp.

◆ MODE_EVENT

enum CVideo::MODE_EVENT

private

Enumerator
TO_RES
TO_FULLSCREEN
TO_WINDOWED
TO_MAXIMIZED_WINDOW

Definition at line 91 of file video.hpp.

Constructor & Destructor Documentation

◆ CVideo() [1/2]

CVideo::CVideo ( const CVideo & )

delete

◆ CVideo() [2/2]

CVideo::CVideo ( FAKE_TYPES type = NO_FAKE )

Definition at line 91 of file video.cpp.

References FAKE, FAKE_TEST, initSDL(), make_fake(), make_test_fake(), NO_FAKE, and singleton_.

◆ ~CVideo()

CVideo::~CVideo ( )

Definition at line 126 of file video.cpp.

References LOG_DP, and singleton_.

Member Function Documentation

◆ blit_surface()

void CVideo::blit_surface	(	int	x,
		int	y,
		surface	surf,
		SDL_Rect *	srcrect = `nullptr`,
		SDL_Rect *	clip_rect = `nullptr`
	)

Draws a surface directly onto the screen framebuffer.

Parameters

x	The x coordinate at which to draw.
y	The y coordinate at which to draw.
surf	The surface to draw.
srcrect	The area of the surface to draw. This defaults to nullptr, which implies the entire thing.
clip_rect	The clippin rect. If not null, the surface will only be drawn within the bounds of the given rectangle.

Definition at line 163 of file video.cpp.

References getSurface(), and sdl_blit().

Referenced by gui::dialog_frame::draw_border(), gui::scrollbar::draw_contents(), gui::tristate_button::draw_contents(), gui::button::draw_contents(), draw_panel(), gui::menu::imgsel_style::draw_row(), gui::menu::draw_row(), gui::menu::imgsel_style::draw_row_bg(), and display::refresh_report().

◆ clear_all_help_strings()

void CVideo::clear_all_help_strings ( )

Removes all help strings.

Definition at line 544 of file video.cpp.

References clear_help_string(), and help_string_.

◆ clear_help_string()

void CVideo::clear_help_string ( int handle )

Removes the help string with the given handle.

Definition at line 536 of file video.cpp.

References help_string_, and font::remove_floating_label().

Referenced by editor::location_palette::adjust_size(), clear_all_help_strings(), editor::location_palette::hide(), editor::editor_palette< overlay >::hide(), gui::widget::process_help_string(), gui::menu::process_help_string(), and editor::location_palette::select_item().

◆ clear_screen()

void CVideo::clear_screen ( )

Clear the screen contents.

Definition at line 351 of file video.cpp.

References window.

Referenced by editor::editor_display::editor_display(), and game_display::game_display().

◆ current_driver()

std::string CVideo::current_driver ( )

static

Definition at line 365 of file video.cpp.

◆ current_refresh_rate()

int CVideo::current_refresh_rate ( ) const

inline

Definition at line 167 of file video.hpp.

References blit_surface().

Referenced by display::draw_wrap().

◆ current_resolution()

point CVideo::current_resolution ( )

Definition at line 489 of file video.cpp.

References window.

Referenced by get_available_resolutions(), set_resolution(), and gui2::dialogs::preferences_dialog::set_resolution_list().

◆ delay()

void CVideo::delay ( unsigned int milliseconds )

static

Waits a given number of milliseconds before returning.

Definition at line 307 of file video.cpp.

References game_config::no_delay.

Referenced by game_lua_kernel::intf_delay(), controller_base::play_slice(), help::show_with_toplevel(), unit_animator::wait_for_end(), and unit_animator::wait_until().

◆ enumerate_drivers()

std::vector< std::string > CVideo::enumerate_drivers ( )

static

Definition at line 371 of file video.cpp.

References n.

◆ faked()

bool CVideo::faked ( ) const

inline

Definition at line 66 of file video.hpp.

Referenced by display_chat_manager::add_chat_message(), display::display(), game_lua_kernel::impl_run_animation(), show_tooltip(), display::turbo_speed(), and gui2::window::window().

◆ flip()

void CVideo::flip ( )

Renders the screen.

Should normally not be called directly!

Definition at line 314 of file video.cpp.

References fake_screen_, flip_locked_, and window.

Referenced by gui2::event::sdl_event_handler::draw(), display::flip(), and help::show_with_toplevel().

◆ get_available_resolutions()

std::vector< point > CVideo::get_available_resolutions ( const bool include_current = false )

Returns the list of available screen resolutions.

Definition at line 427 of file video.cpp.

References current_resolution(), get_dpi_scale_factor(), i, preferences::min_window_height, preferences::min_window_width, sort(), window, point::x, and point::y.

Referenced by gui2::dialogs::preferences_dialog::set_resolution_list().

◆ get_dpi()

std::pair< float, float > CVideo::get_dpi ( ) const

The current game screen dpi.

Definition at line 393 of file video.cpp.

References desktop::apple::get_scale_factor(), sdl_get_version(), and window.

Referenced by get_dpi_scale_factor().

◆ get_dpi_scale_factor()

std::pair< float, float > CVideo::get_dpi_scale_factor ( ) const

The current scale factor on High-DPI screens.

Definition at line 417 of file video.cpp.

References get_dpi().

Referenced by get_available_resolutions(), screen_area(), and gui2::settings::update_screen_size_variables().

◆ get_height()

int CVideo::get_height ( bool as_pixels = true ) const

Returns the window renderer height in pixels or in screen coordinates.

Definition at line 302 of file video.cpp.

References screen_area().

Referenced by controller_base::handle_scroll(), gui::menu::max_items_onscreen(), events::raise_resize_event(), and set_help_string().

◆ get_singleton()

static CVideo& CVideo::get_singleton ( )

inlinestatic

Definition at line 49 of file video.hpp.

Referenced by gui2::canvas::blit(), gui2::dialogs::loading_screen::display(), do_replay(), gui2::event::sdl_event_handler::draw(), sdl::draw_rectangle(), gui::dialog_frame::draw_title(), hotkey::command_executor::execute_command_wrap(), sdl::fill_rectangle(), game_events::wml_event_pump::flush_messages(), gui2::dialogs::preferences_dialog::fullscreen_toggle_callback(), windows_tray_notification::get_window_handle(), gui2::event::sdl_event_handler::handle_event(), gui2::dialogs::preferences_dialog::handle_res_select(), controller_base::handle_scroll(), game_lua_kernel::impl_run_animation(), savegame::loadgame::load_game_ingame(), gui2::dialogs::make_screenshot(), help::unit_topic_generator::operator()(), events::peek_for_resize(), controller_base::play_slice(), campaign_controller::playsingle_scenario(), gui2::dialogs::preferences_dialog::post_build(), events::pump(), events::raise_resize_event(), desktop::notifications::send(), gui2::dialogs::preferences_dialog::set_resolution_list(), editor::context_manager::set_window_title(), gui2::dialogs::modeless_dialog::show(), gui2::dialogs::modal_dialog::show(), gui2::dialogs::mp_lobby::show_preferences_button_callback(), show_tooltip(), help::show_with_toplevel(), preferences::theme(), preferences::turbo(), gui2::settings::update_screen_size_variables(), gui2::window::window(), and editor::context_manager::~context_manager().

◆ get_width()

int CVideo::get_width ( bool as_pixels = true ) const

Returns the window renderer width in pixels or screen coordinates.

Definition at line 297 of file video.cpp.

References screen_area().

Referenced by controller_base::handle_scroll(), help::unit_topic_generator::operator()(), events::raise_resize_event(), and set_help_string().

◆ get_window()

sdl::window * CVideo::get_window ( )

Returns a pointer to the underlying SDL window.

Definition at line 360 of file video.cpp.

References window.

Referenced by sdl::draw_rectangle(), sdl::fill_rectangle(), and windows_tray_notification::get_window_handle().

◆ getSurface()

surface & CVideo::getSurface ( )

Returns a reference to the framebuffer.

Definition at line 484 of file video.cpp.

Referenced by blit_surface(), display::display(), gui2::window::draw(), display::draw_all_panels(), gui::dialog_frame::draw_background(), gui::textbox::draw_contents(), help::help_text_area::draw_contents(), display::draw_image_for_report(), display::draw_minimap(), display::draw_minimap_units(), display::flip(), gui2::dialogs::make_screenshot(), font::pango_draw_text(), display::refresh_report(), surface_restorer::restore(), display::screenshot(), display::scroll(), gui2::window::show(), gui2::window::undraw(), and surface_restorer::update().

◆ has_window()

bool CVideo::has_window ( )

inline

Definition at line 81 of file video.hpp.

References sound::current_driver(), and sound::enumerate_drivers().

◆ init_window()

void CVideo::init_window ( )

Initializes a new SDL window instance, taking into account any preiously saved states.

Definition at line 198 of file video.cpp.

References event_handler_, preferences::fullscreen(), h, events::sdl_handler::join_global(), LOG_DP, preferences::maximized(), preferences::min_window_height, preferences::min_window_width, refresh_rate_, preferences::resolution(), supports_vsync(), update_framebuffer(), preferences::vsync(), w, window, point::x, and point::y.

◆ initSDL()

void CVideo::initSDL ( )

private

Initializes the SDL video subsystem.

Definition at line 116 of file video.cpp.

References ERR_DP, and error().

Referenced by CVideo().

◆ is_fullscreen()

bool CVideo::is_fullscreen ( ) const

Definition at line 494 of file video.cpp.

References window.

Referenced by set_fullscreen().

◆ lock_flips()

void CVideo::lock_flips ( bool lock )

Definition at line 606 of file video.cpp.

References flip_locked_.

◆ lock_updates()

void CVideo::lock_updates ( bool value )

Stop the screen being redrawn.

Anything that happens while the updates are locked will be hidden from the user's view.

Note that this function is re-entrant, meaning that if lock_updates(true) is called twice, lock_updates(false) must be called twice to unlock updates.

Definition at line 325 of file video.cpp.

References updated_locked_.

Referenced by display::display().

◆ make_fake()

void CVideo::make_fake ( )

Definition at line 172 of file video.cpp.

References fake_screen_, and refresh_rate_.

Referenced by CVideo().

◆ make_test_fake()

void CVideo::make_test_fake	(	const unsigned	width = `1024`,
		const unsigned	height = `768`
	)

Creates a fake frame buffer for the unit tests.

Parameters

width	The width of the buffer.
height	The height of the buffer.

Definition at line 180 of file video.cpp.

References refresh_rate_.

Referenced by CVideo(), and test_utils::get_fake_display().

◆ non_interactive()

bool CVideo::non_interactive ( ) const

Definition at line 135 of file video.cpp.

References window.

Referenced by display::display().

◆ operator=()

CVideo& CVideo::operator= ( const CVideo & )

delete

◆ screen_area()

SDL_Rect CVideo::screen_area ( bool as_pixels = true ) const

Returns the current window renderer area, either in pixels or screen coordinates.

Parameters

as_pixels Whether to return the area in pixels (default true) or DPI-independent (DIP) screen coordinates.

Definition at line 277 of file video.cpp.

References get_dpi_scale_factor(), utf8::size(), and window.

Referenced by gui2::window::draw(), gui::textbox::draw_contents(), draw_label(), draw_panel(), gui::menu::draw_row(), gui::dialog_frame::draw_title(), get_height(), gui::menu::get_item_rect_internal(), get_width(), gui::scrollarea::handle_event(), gui2::event::sdl_event_handler::handle_event(), gui::dialog_frame::layout(), display::layout_buttons(), events::pump(), display::redraw_everything(), display::refresh_report(), display::set_theme(), gui2::dialogs::mp_lobby::show_preferences_button_callback(), show_tooltip(), help::show_with_toplevel(), and gui2::settings::update_screen_size_variables().

◆ set_fullscreen()

void CVideo::set_fullscreen ( bool ison )

Definition at line 549 of file video.cpp.

References preferences::_set_fullscreen(), d, display::get_singleton(), is_fullscreen(), preferences::maximized(), preferences::resolution(), set_window_mode(), TO_FULLSCREEN, TO_MAXIMIZED_WINDOW, TO_WINDOWED, and window.

Referenced by gui2::dialogs::preferences_dialog::fullscreen_toggle_callback(), and toggle_fullscreen().

◆ set_help_string()

int CVideo::set_help_string ( const std::string & str )

Displays a help string with the given text.

A 'help string' is like a tooltip, but appears at the bottom of the screen so as to not be intrusive.

Parameters

str	The text to display.

Returns: The handle id of the new help string.

Definition at line 504 of file video.cpp.

References font::add_floating_label(), font::get_floating_label_rect(), get_height(), get_width(), help_string_, font::move_floating_label(), font::pango_line_width(), font::remove_floating_label(), font::floating_label::set_bg_color(), font::floating_label::set_border_size(), font::floating_label::set_font_size(), font::floating_label::set_position(), utf8::size(), and font::SIZE_LARGE.

Referenced by editor::location_palette::adjust_size(), editor::editor_palette< overlay >::hide(), gui::widget::process_help_string(), gui::menu::process_help_string(), and editor::location_palette::select_item().

◆ set_resolution() [1/2]

bool CVideo::set_resolution	(	const unsigned	width,
		const unsigned	height
	)

Definition at line 578 of file video.cpp.

Referenced by gui2::dialogs::preferences_dialog::handle_res_select().

◆ set_resolution() [2/2]

bool CVideo::set_resolution ( const point & resolution )

Set the window resolution.

Parameters

resolution The new width and height.

Returns: Whether the resolution was successfully changed.

Definition at line 583 of file video.cpp.

References preferences::_set_maximized(), preferences::_set_resolution(), current_resolution(), d, display::get_singleton(), events::raise_resize_event(), set_window_mode(), and TO_RES.

◆ set_window_icon()

void CVideo::set_window_icon ( surface & icon )

Sets the icon of the main window.

Parameters

icon	The new icon for the window.

Definition at line 345 of file video.cpp.

References window.

◆ set_window_mode()

void CVideo::set_window_mode	(	const MODE_EVENT	mode,
		const point &	size
	)

private

Sets the window's mode - ie, changing it to fullscreen, maximizing, etc.

Parameters

mode	The action to perform.
size	The new window size. Utilized if mode is TO_RES.

Definition at line 245 of file video.cpp.

References fake_screen_, TO_FULLSCREEN, TO_MAXIMIZED_WINDOW, TO_RES, TO_WINDOWED, update_framebuffer(), window, point::x, and point::y.

Referenced by set_fullscreen(), and set_resolution().

◆ set_window_title()

void CVideo::set_window_title ( const std::string & title )

Sets the title of the main window.

Parameters

title The new title for the window.

Definition at line 339 of file video.cpp.

References window.

Referenced by editor::context_manager::set_window_title(), and editor::context_manager::~context_manager().

◆ setup_completed()

static bool CVideo::setup_completed ( )

inlinestatic

Definition at line 44 of file video.hpp.

◆ supports_vsync()

bool CVideo::supports_vsync ( ) const

Definition at line 499 of file video.cpp.

References sdl_get_version().

Referenced by init_window().

◆ toggle_fullscreen()

void CVideo::toggle_fullscreen ( )

Definition at line 573 of file video.cpp.

References preferences::fullscreen(), and set_fullscreen().

Referenced by hotkey::command_executor::execute_command_wrap(), and gui2::window::window().

◆ update_framebuffer()

void CVideo::update_framebuffer ( )

Updates and ensures the framebuffer surface is valid.

This needs to be invoked immediately after a resize event or the game will crash.

Definition at line 188 of file video.cpp.

References window.

Referenced by init_window(), events::peek_for_resize(), and set_window_mode().

◆ update_locked()

bool CVideo::update_locked ( ) const

Whether the screen has been 'locked' or not.

Definition at line 334 of file video.cpp.

References updated_locked_.

Referenced by display::draw(), game_lua_kernel::impl_run_animation(), display::redraw_everything(), display::scroll(), display::scroll_to_xy(), and display::update_display().

◆ window_has_flags()

bool CVideo::window_has_flags ( uint32_t flags ) const

Tests whether the given flags are currently set on the SDL window.

Parameters

flags The flags to test, OR'd together.

Definition at line 384 of file video.cpp.

References window.

Referenced by controller_base::handle_scroll(), and desktop::notifications::send().

Member Data Documentation

◆ event_handler_

video_event_handler CVideo::event_handler_

private

Definition at line 288 of file video.hpp.

Referenced by init_window().

◆ fake_screen_

bool CVideo::fake_screen_

private

Definition at line 270 of file video.hpp.

Referenced by flip(), make_fake(), and set_window_mode().

◆ flip_locked_

int CVideo::flip_locked_

private

Definition at line 294 of file video.hpp.

Referenced by flip(), and lock_flips().

◆ help_string_

int CVideo::help_string_

private

Curent ID of the help string.

Definition at line 291 of file video.hpp.

Referenced by clear_all_help_strings(), clear_help_string(), and set_help_string().

◆ refresh_rate_

int CVideo::refresh_rate_

private

Definition at line 295 of file video.hpp.

Referenced by init_window(), make_fake(), and make_test_fake().

◆ singleton_

CVideo * CVideo::singleton_ = nullptr

staticprivate

Definition at line 261 of file video.hpp.

Referenced by CVideo(), and ~CVideo().

◆ updated_locked_

int CVideo::updated_locked_

private

Definition at line 293 of file video.hpp.

Referenced by lock_updates(), and update_locked().

◆ window

std::unique_ptr<sdl::window> CVideo::window

private

The SDL window object.

Definition at line 264 of file video.hpp.

Referenced by clear_screen(), current_resolution(), flip(), get_available_resolutions(), get_dpi(), get_window(), init_window(), is_fullscreen(), non_interactive(), screen_area(), set_fullscreen(), set_window_icon(), set_window_mode(), set_window_title(), update_framebuffer(), and window_has_flags().

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ FAKE_TYPES

◆ MODE_EVENT

Constructor & Destructor Documentation

◆ CVideo() [1/2]

◆ CVideo() [2/2]

◆ ~CVideo()

Member Function Documentation

◆ blit_surface()

◆ clear_all_help_strings()

◆ clear_help_string()

◆ clear_screen()

◆ current_driver()

◆ current_refresh_rate()

◆ current_resolution()

◆ delay()

◆ enumerate_drivers()

◆ faked()

◆ flip()

◆ get_available_resolutions()

◆ get_dpi()

◆ get_dpi_scale_factor()

◆ get_height()

◆ get_singleton()

◆ get_width()

◆ get_window()

◆ getSurface()

◆ has_window()

◆ init_window()

◆ initSDL()

◆ is_fullscreen()

◆ lock_flips()

◆ lock_updates()

◆ make_fake()

◆ make_test_fake()

◆ non_interactive()

◆ operator=()

◆ screen_area()

◆ set_fullscreen()

◆ set_help_string()

◆ set_resolution() [1/2]

◆ set_resolution() [2/2]

◆ set_window_icon()

◆ set_window_mode()

◆ set_window_title()

◆ setup_completed()

◆ supports_vsync()

◆ toggle_fullscreen()

◆ update_framebuffer()

◆ update_locked()

◆ window_has_flags()

Member Data Documentation

◆ event_handler_

◆ fake_screen_

◆ flip_locked_

◆ help_string_

◆ refresh_rate_

◆ singleton_

◆ updated_locked_

◆ window