galaxy::input Namespace Reference

Functions
void	clipboard_set (const std::string &contents) noexcept
	Set clipboard contents.
std::string	clipboard_get () noexcept
	Get clipboard contents.
bool	clipboard_clear () noexcept
	Clear the clipboard contents.
bool	is_key_mod_down (const KeyMods modifier) noexcept
	See if a key mod is being held down.
bool	is_key_down (const Keys key) noexcept
	See if a key is being held down.
bool	is_mouse_down (const MouseButton btn) noexcept
	Check if a mouse button was pressed.
glm::vec2	get_cursor_pos () noexcept
	Get current cursor position.

Function Documentation

clipboard_set()

void galaxy::input::clipboard_set ( const std::string & contents )

noexcept

Set clipboard contents.

Parameters

contents

UTF-8 string.

Definition at line 16 of file Clipboard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

clipboard_get()

std::string galaxy::input::clipboard_get ( )

nodiscardnoexcept

Get clipboard contents.

Returns

UTF-8 string.

Definition at line 21 of file Clipboard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

clipboard_clear()

bool galaxy::input::clipboard_clear ( )

noexcept

Clear the clipboard contents.

Returns

True if successful.

Definition at line 34 of file Clipboard.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

is_key_mod_down()

bool galaxy::input::is_key_mod_down ( const KeyMods modifier )

nodiscardnoexcept

See if a key mod is being held down.

Parameters

modifier

Keymod to check.

Returns

True if keymod is currently down.

Definition at line 16 of file Input.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

is_key_down()

bool galaxy::input::is_key_down ( const Keys key )

nodiscardnoexcept

See if a key is being held down.

Parameters

key	Key to check.

Returns

True if key is currently down.

Definition at line 22 of file Input.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

is_mouse_down()

bool galaxy::input::is_mouse_down ( const MouseButton btn )

nodiscardnoexcept

Check if a mouse button was pressed.

Parameters

btn	Mouse button keycode.

Returns

True if button was pressed.

Definition at line 28 of file Input.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

get_cursor_pos()

glm::vec2 galaxy::input::get_cursor_pos ( )

nodiscardnoexcept

Get current cursor position.

Returns

Returns position as a vec2.

Definition at line 34 of file Input.cpp.

Here is the call graph for this function:

Here is the caller graph for this function: