From 87d7cc2a493f6a5f57203969ee1550c1bae4f107 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Wed, 9 Apr 2014 22:14:01 +0200
Subject: Add typespecs to the sdl_window module

---
 src/sdl_window.erl | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/src/sdl_window.erl b/src/sdl_window.erl
index 9a8753f..0e21c32 100644
--- a/src/sdl_window.erl
+++ b/src/sdl_window.erl
@@ -43,18 +43,32 @@
 -export([set_title/2]).
 -export([show/1]).
 
+-opaque window() :: any().
+-export_type([window/0]).
+
+-type window_pos() :: centered | undefined | integer().
+-type window_flag() :: fullscreen | fullscreen_desktop | opengl | shown
+	| hidden | borderless | resizable | minimized | maximized
+	| input_grabbed | input_focus | mouse_focus | foreign | allow_high_dpi.
+
+-spec create(string(), window_pos(), window_pos(), integer(), integer(), [window_flag()])
+	-> {ok, window()} | sdl:error().
 create(Title, X, Y, W, H, Flags) ->
 	esdl2:create_window(Title, X, Y, W, H, Flags),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec create_window_and_renderer(integer(), integer(), [window_flag()])
+	-> {ok, window(), sdl_renderer:renderer()} | sdl:error().
 create_window_and_renderer(W, H, Flags) ->
 	esdl2:create_window_and_renderer(W, H, Flags),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec get_brightness(window()) -> float().
 get_brightness(Window) ->
 	esdl2:get_window_brightness(Window),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec get_display_index(window()) -> integer().
 get_display_index(Window) ->
 	esdl2:get_window_display_index(Window),
 	receive {'_nif_thread_ret_', Ret} ->
@@ -62,85 +76,110 @@ get_display_index(Window) ->
 		Index
 	end.
 
+-spec get_flags(window()) -> [window_flag()].
 get_flags(Window) ->
 	esdl2:get_window_flags(Window),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec get_id(window()) -> non_neg_integer().
 get_id(Window) ->
 	esdl2:get_window_id(Window),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec get_max_size(window()) -> {integer(), integer()}.
 get_max_size(Window) ->
 	esdl2:get_window_maximum_size(Window),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec get_min_size(window()) -> {integer(), integer()}.
 get_min_size(Window) ->
 	esdl2:get_window_minimum_size(Window),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec get_pos(window()) -> {integer(), integer()}.
 get_pos(Window) ->
 	esdl2:get_window_position(Window),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec get_size(window()) -> {integer(), integer()}.
 get_size(Window) ->
 	esdl2:get_window_size(Window),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec get_title(window()) -> string().
 get_title(Window) ->
 	esdl2:get_window_title(Window),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec grab_input(window(), boolean()) -> ok.
 grab_input(Window, Grab) ->
 	esdl2:set_window_grab(Window, Grab).
 
+-spec hide(window()) -> ok.
 hide(Window) ->
 	esdl2:hide_window(Window).
 
+-spec is_input_grabbed(window()) -> boolean().
 is_input_grabbed(Window) ->
 	esdl2:get_window_grab(Window),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec maximize(window()) -> ok.
 maximize(Window) ->
 	esdl2:maximize_window(Window).
 
+-spec minimize(window()) -> ok.
 minimize(Window) ->
 	esdl2:minimize_window(Window).
 
+-spec raise(window()) -> ok.
 raise(Window) ->
 	esdl2:raise_window(Window).
 
+-spec restore(window()) -> ok.
 restore(Window) ->
 	esdl2:restore_window(Window).
 
+-spec set_bordered(window(), boolean()) -> ok.
 set_bordered(Window, Bordered) ->
 	esdl2:set_window_bordered(Window, Bordered).
 
+-spec set_brightness(window(), float()) -> ok | sdl:error().
 set_brightness(Window, Brightness) ->
 	esdl2:set_window_brightness(Window, Brightness),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec set_fullscreen(window(), fullscreen | fullscreen_desktop | windowed)
+	-> ok | sdl:error().
 set_fullscreen(Window, Flag) ->
 	esdl2:set_window_fullscreen(Window, Flag),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec set_icon(window(), sdl_surface:surface()) -> ok.
 set_icon(Window, Surface) ->
 	esdl2:set_window_icon(Window, Surface),
 	receive {'_nif_thread_ret_', Ret} -> Ret end.
 
+-spec set_max_size(window(), integer(), integer()) -> ok.
 set_max_size(Window, W, H) ->
 	esdl2:set_window_maximum_size(Window, W, H).
 
+-spec set_min_size(window(), integer(), integer()) -> ok.
 set_min_size(Window, W, H) ->
 	esdl2:set_window_minimum_size(Window, W, H).
 
+-spec set_pos(window(), integer(), integer()) -> ok.
 set_pos(Window, X, Y) ->
 	esdl2:set_window_position(Window, X, Y).
 
+-spec set_size(window(), integer(), integer()) -> ok.
 set_size(Window, W, H) ->
 	esdl2:set_window_size(Window, W, H).
 
+-spec set_title(window(), string()) -> ok.
 set_title(Window, Title) ->
 	esdl2:set_window_title(Window, Title).
 
+-spec show(window()) -> ok.
 show(Window) ->
 	esdl2:show_window(Window).
-- 
cgit v1.2.3