View Source Exray.Core.Window (Exray v0.6.0)

Open, manage and handle the window that contains the cool stuff you create.

Summary

Functions

clear_window_state(flags)

Clear window configuration state flags

close_window()

Close window and unload OpenGL context

disable_event_waiting()

Disable waiting for events on EndDrawing(), automatic events polling

enable_event_waiting()

Enable waiting for events on EndDrawing(), no automatic event polling

get_clipboard_text()

Get clipboard text content

get_current_monitor()

Get current connected monitor

get_monitor_count()

Get number of connected monitors

get_monitor_height(monitor)

Get specified monitor height (current video mode used by monitor)

get_monitor_name(monitor)

Get the human-readable, UTF-8 encoded name of the specified monitor

get_monitor_physical_height(monitor)

Get specified monitor physical height in millimetres

get_monitor_physical_width(monitor)

Get specified monitor physical width in millimetres

get_monitor_position(monitor)

Get specified monitor position

get_monitor_refresh_rate(monitor)

Get specified monitor refresh rate

get_monitor_width(monitor)

Get specified monitor width (current video mode used by monitor)

get_render_height()

Get current render height (it considers HiDPI)

get_render_width()

Get current render width (it considers HiDPI)

get_screen_height()

Get current screen height

get_screen_width()

Get current screen width

get_window_handle()

Get native window handle

get_window_position()

Get window position XY on monitor

get_window_scale_dpi()

Get window scale DPI factor

init_window(width, height, title)

Initialize window and OpenGL context

maximize_window()

Set window state: maximized, if resizable (only PLATFORM_DESKTOP)

minimize_window()

Set window state: minimized, if resizable (only PLATFORM_DESKTOP)

restore_window()

Set window state: not minimized/maximized (only PLATFORM_DESKTOP)

set_clipboard_text(text)

Set clipboard text content

set_window_focused()

Set window focused (only PLATFORM_DESKTOP)

set_window_icon(image)

Set icon for window (single image, RGBA 32bit, only PLATFORM_DESKTOP)

set_window_icons(images)

Set icon for window (multiple images, RGBA 32bit, only PLATFORM_DESKTOP)

set_window_max_size(width, height)

Set window maximum dimensions (for FLAG_WINDOW_RESIZABLE)

set_window_min_size(width, height)

Set window minimum dimensions (for FLAG_WINDOW_RESIZABLE)

set_window_monitor(monitor)

Set monitor for the current window

set_window_opacity(opacity)

Set window opacity [0.0f..1.0f] (only PLATFORM_DESKTOP)

set_window_position(x, y)

Set window position on screen (only PLATFORM_DESKTOP)

set_window_size(width, height)

Set window dimensions

set_window_state(flags)

Set window configuration state using flags (only PLATFORM_DESKTOP)

set_window_title(title)

Set title for window (only PLATFORM_DESKTOP and PLATFORM_WEB)

toggle_borderless_windowed()

Toggle window state: borderless windowed (only PLATFORM_DESKTOP)

toggle_fullscreen()

Toggle window state: fullscreen/windowed (only PLATFORM_DESKTOP)

window_is_focused?()

Check if window is currently focused (only PLATFORM_DESKTOP)

window_is_fullscreen?()

Check if window is currently fullscreen

window_is_hidden?()

Check if window is currently hidden (only PLATFORM_DESKTOP)

window_is_maximized?()

Check if window is currently maximized (only PLATFORM_DESKTOP)

window_is_minimized?()

Check if window is currently minimized (only PLATFORM_DESKTOP)

window_is_ready?()

Check if window has been initialized successfully

window_is_resized?()

Check if window has been resized last frame

window_is_state?(flag)

Check if one specific window flag is enabled

window_should_close?()

Check if application should close (KEY_ESCAPE pressed or windows close icon clicked)

Functions

Link to this function

clear_window_state(flags)

View Source 
@spec clear_window_state(flags :: non_neg_integer()) :: :ok

Clear window configuration state flags

Link to this function

close_window()

View Source 
@spec close_window() :: :ok

Close window and unload OpenGL context

Link to this function

disable_event_waiting()

View Source 
@spec disable_event_waiting() :: :ok

Disable waiting for events on EndDrawing(), automatic events polling

Link to this function

enable_event_waiting()

View Source 
@spec enable_event_waiting() :: :ok

Enable waiting for events on EndDrawing(), no automatic event polling

Link to this function

get_clipboard_text()

View Source 
@spec get_clipboard_text() :: clipboard_text :: binary()

Get clipboard text content

Link to this function

get_current_monitor()

View Source 
@spec get_current_monitor() :: current_monitor :: integer()

Get current connected monitor

Link to this function

get_monitor_count()

View Source 
@spec get_monitor_count() :: monitor_count :: integer()

Get number of connected monitors

Link to this function

get_monitor_height(monitor)

View Source 
@spec get_monitor_height(monitor :: integer()) :: monitor_height :: integer()

Get specified monitor height (current video mode used by monitor)

Link to this function

get_monitor_name(monitor)

View Source 
@spec get_monitor_name(monitor :: integer()) :: monitor_name :: binary()

Get the human-readable, UTF-8 encoded name of the specified monitor

Link to this function

get_monitor_physical_height(monitor)

View Source 
@spec get_monitor_physical_height(monitor :: integer()) ::
  monitor_physical_height :: integer()

Get specified monitor physical height in millimetres

Link to this function

get_monitor_physical_width(monitor)

View Source 
@spec get_monitor_physical_width(monitor :: integer()) ::
  monitor_physical_width :: integer()

Get specified monitor physical width in millimetres

Link to this function

get_monitor_position(monitor)

View Source 
@spec get_monitor_position(monitor :: integer()) ::
  monitor_position :: Exray.Structs.Vector2.t()

Get specified monitor position

Link to this function

get_monitor_refresh_rate(monitor)

View Source 
@spec get_monitor_refresh_rate(monitor :: integer()) ::
  monitor_refresh_rate :: integer()

Get specified monitor refresh rate

Link to this function

get_monitor_width(monitor)

View Source 
@spec get_monitor_width(monitor :: integer()) :: monitor_width :: integer()

Get specified monitor width (current video mode used by monitor)

Link to this function

get_render_height()

View Source 
@spec get_render_height() :: render_height :: integer()

Get current render height (it considers HiDPI)

Link to this function

get_render_width()

View Source 
@spec get_render_width() :: render_width :: integer()

Get current render width (it considers HiDPI)

Link to this function

get_screen_height()

View Source 
@spec get_screen_height() :: screen_height :: integer()

Get current screen height

Link to this function

get_screen_width()

View Source 
@spec get_screen_width() :: screen_width :: integer()

Get current screen width

Link to this function

get_window_handle()

View Source 
@spec get_window_handle() :: window_handle :: term()

Get native window handle

Link to this function

get_window_position()

View Source 
@spec get_window_position() :: window_position :: Exray.Structs.Vector2.t()

Get window position XY on monitor

Link to this function

get_window_scale_dpi()

View Source 
@spec get_window_scale_dpi() :: window_scale_dpi :: Exray.Structs.Vector2.t()

Get window scale DPI factor

Link to this function

init_window(width, height, title)

View Source 
@spec init_window(width :: integer(), height :: integer(), title :: binary()) :: :ok

Initialize window and OpenGL context

Link to this function

maximize_window()

View Source 
@spec maximize_window() :: :ok

Set window state: maximized, if resizable (only PLATFORM_DESKTOP)

Link to this function

minimize_window()

View Source 
@spec minimize_window() :: :ok

Set window state: minimized, if resizable (only PLATFORM_DESKTOP)

Link to this function

restore_window()

View Source 
@spec restore_window() :: :ok

Set window state: not minimized/maximized (only PLATFORM_DESKTOP)

Link to this function

set_clipboard_text(text)

View Source 
@spec set_clipboard_text(text :: binary()) :: :ok

Set clipboard text content

Link to this function

set_window_focused()

View Source 
@spec set_window_focused() :: :ok

Set window focused (only PLATFORM_DESKTOP)

Link to this function

set_window_icon(image)

View Source 
@spec set_window_icon(image :: Exray.Structs.Image.t()) :: :ok

Set icon for window (single image, RGBA 32bit, only PLATFORM_DESKTOP)

Link to this function

set_window_icons(images)

View Source 
@spec set_window_icons(images :: [Exray.Structs.Image.t()]) :: :ok

Set icon for window (multiple images, RGBA 32bit, only PLATFORM_DESKTOP)

Link to this function

set_window_max_size(width, height)

View Source 
@spec set_window_max_size(width :: integer(), height :: integer()) :: :ok

Set window maximum dimensions (for FLAG_WINDOW_RESIZABLE)

Link to this function

set_window_min_size(width, height)

View Source 
@spec set_window_min_size(width :: integer(), height :: integer()) :: :ok

Set window minimum dimensions (for FLAG_WINDOW_RESIZABLE)

Link to this function

set_window_monitor(monitor)

View Source 
@spec set_window_monitor(monitor :: integer()) :: :ok

Set monitor for the current window

Link to this function

set_window_opacity(opacity)

View Source 
@spec set_window_opacity(opacity :: float()) :: :ok

Set window opacity [0.0f..1.0f] (only PLATFORM_DESKTOP)

Link to this function

set_window_position(x, y)

View Source 
@spec set_window_position(x :: integer(), y :: integer()) :: :ok

Set window position on screen (only PLATFORM_DESKTOP)

Link to this function

set_window_size(width, height)

View Source 
@spec set_window_size(width :: integer(), height :: integer()) :: :ok

Set window dimensions

Link to this function

set_window_state(flags)

View Source 
@spec set_window_state(flags :: non_neg_integer()) :: :ok

Set window configuration state using flags (only PLATFORM_DESKTOP)

Link to this function

set_window_title(title)

View Source 
@spec set_window_title(title :: binary()) :: :ok

Set title for window (only PLATFORM_DESKTOP and PLATFORM_WEB)

Link to this function

toggle_borderless_windowed()

View Source 
@spec toggle_borderless_windowed() :: :ok

Toggle window state: borderless windowed (only PLATFORM_DESKTOP)

Link to this function

toggle_fullscreen()

View Source 
@spec toggle_fullscreen() :: :ok

Toggle window state: fullscreen/windowed (only PLATFORM_DESKTOP)

Link to this function

window_is_focused?()

View Source 
@spec window_is_focused?() :: window_is_focused :: boolean()

Check if window is currently focused (only PLATFORM_DESKTOP)

Link to this function

window_is_fullscreen?()

View Source 
@spec window_is_fullscreen?() :: window_is_fullscreen :: boolean()

Check if window is currently fullscreen

Link to this function

window_is_hidden?()

View Source 
@spec window_is_hidden?() :: window_is_hidden :: boolean()

Check if window is currently hidden (only PLATFORM_DESKTOP)

Link to this function

window_is_maximized?()

View Source 
@spec window_is_maximized?() :: window_is_maximized :: boolean()

Check if window is currently maximized (only PLATFORM_DESKTOP)

Link to this function

window_is_minimized?()

View Source 
@spec window_is_minimized?() :: window_is_minimized :: boolean()

Check if window is currently minimized (only PLATFORM_DESKTOP)

Link to this function

window_is_ready?()

View Source 
@spec window_is_ready?() :: window_is_ready :: boolean()

Check if window has been initialized successfully

Link to this function

window_is_resized?()

View Source 
@spec window_is_resized?() :: window_is_resized :: boolean()

Check if window has been resized last frame

Link to this function

window_is_state?(flag)

View Source 
@spec window_is_state?(flag :: non_neg_integer()) :: window_is_state :: boolean()

Check if one specific window flag is enabled

Link to this function

window_should_close?()

View Source 
@spec window_should_close?() :: window_should_close :: boolean()

Check if application should close (KEY_ESCAPE pressed or windows close icon clicked)