aboutsummaryrefslogtreecommitdiffstats
path: root/src/sdl_video.erl
blob: abf60d33be56490e9f2d3f7721c80a08911cc686 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
%% Copyright (c) 2018, Loïc Hoguin <[email protected]>
%%
%% Permission to use, copy, modify, and/or distribute this software for any
%% purpose with or without fee is hereby granted, provided that the above
%% copyright notice and this permission notice appear in all copies.
%%
%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

-module(sdl_video).

-export([disable_screensaver/0]).
-export([enable_screensaver/0]).
-export([get_closest_display_mode/2]).
-export([get_current_display_mode/1]).
-export([get_current_driver/0]).
-export([get_desktop_display_mode/1]).
-export([get_display_bounds/1]).
-export([get_display_dpi/1]).
-export([get_display_mode/2]).
-export([get_display_name/1]).
-export([get_display_usable_bounds/1]).
-export([get_driver/1]).
-export([get_num_display_modes/1]).
-export([get_num_displays/0]).
-export([get_num_drivers/0]).
-export([is_screensaver_enabled/0]).
-export([start/1]).
-export([stop/0]).

-type display_mode() :: #{
	format => sdl_pixels:pixel_format(),
	w => integer(),
	h => integer(),
	refresh_rate => integer()
}.
-export_type([display_mode/0]).

-spec disable_screensaver() -> ok.
disable_screensaver() ->
	esdl2:disable_screensaver().

-spec enable_screensaver() -> ok.
enable_screensaver() ->
	esdl2:enable_screensaver().

-spec get_closest_display_mode(integer(), display_mode()) -> display_mode() | undefined.
get_closest_display_mode(DisplayIndex, Mode) ->
	esdl2:get_closest_display_mode(DisplayIndex, Mode),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_current_display_mode(integer()) -> display_mode() | undefined.
get_current_display_mode(DisplayIndex) ->
	esdl2:get_current_display_mode(DisplayIndex),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_current_driver() -> binary() | undefined.
get_current_driver() ->
	esdl2:get_current_video_driver(),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_desktop_display_mode(integer()) -> display_mode() | undefined.
get_desktop_display_mode(DisplayIndex) ->
	esdl2:get_desktop_display_mode(DisplayIndex),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_display_bounds(integer()) -> sdl_rect:rect() | undefined.
get_display_bounds(Index) ->
	esdl2:get_display_bounds(Index),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_display_dpi(integer())
	-> #{diagonal := float(), horizontal := float(), vertical := float()}
	| undefined.
get_display_dpi(Index) ->
	esdl2:get_display_dpi(Index),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_display_mode(integer(), integer()) -> display_mode() | undefined.
get_display_mode(DisplayIndex, Index) ->
	esdl2:get_display_mode(DisplayIndex, Index),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_display_name(integer()) -> binary() | undefined.
get_display_name(Index) ->
	esdl2:get_display_name(Index),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_display_usable_bounds(integer()) -> sdl_rect:rect() | undefined.
get_display_usable_bounds(Index) ->
	esdl2:get_display_usable_bounds(Index),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_driver(integer()) -> binary() | undefined.
get_driver(Index) ->
	esdl2:get_video_driver(Index).

-spec get_num_display_modes(integer()) -> integer().
get_num_display_modes(DisplayIndex) ->
	esdl2:get_num_display_modes(DisplayIndex),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_num_displays() -> integer().
get_num_displays() ->
	esdl2:get_num_video_displays(),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec get_num_drivers() -> integer().
get_num_drivers() ->
	esdl2:get_num_video_drivers().

-spec is_screensaver_enabled() -> boolean().
is_screensaver_enabled() ->
	esdl2:is_screensaver_enabled(),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec start(binary()) -> ok | sdl:error().
start(DriverName) ->
	esdl2:video_init(DriverName),
	receive {'_nif_thread_ret_', Ret} -> Ret end.

-spec stop() -> ok.
stop() ->
	esdl2:video_quit().