mirror of
https://github.com/SFML/CSFML.git
synced 2026-10-27 13:36:12 +01:00
Improved API documentation (copied from SFML)
This commit is contained in:
1 parent
c84a787d0a
commit
d734c9df5c
50 files changed
+1606
-1478
No files matched your search
+22
-11
@@ -34,7 +34,8 @@
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Definition of all the event types
|
||||
/// \brief Definition of all the event types
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
typedef enum
|
||||
{
|
||||
@@ -60,7 +61,8 @@ typedef enum
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Keyboard event parameters
|
||||
/// \brief Keyboard event parameters
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
struct sfKeyEvent
|
||||
{
|
||||
@@ -73,7 +75,8 @@ struct sfKeyEvent
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Text event parameters
|
||||
/// \brief Text event parameters
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
struct sfTextEvent
|
||||
{
|
||||
@@ -82,7 +85,8 @@ struct sfTextEvent
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Mouse move event parameters
|
||||
/// \brief Mouse move event parameters
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
struct sfMouseMoveEvent
|
||||
{
|
||||
@@ -92,7 +96,8 @@ struct sfMouseMoveEvent
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Mouse buttons events parameters
|
||||
/// \brief Mouse buttons events parameters
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
struct sfMouseButtonEvent
|
||||
{
|
||||
@@ -103,7 +108,8 @@ struct sfMouseButtonEvent
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Mouse wheel events parameters
|
||||
/// \brief Mouse wheel events parameters
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
struct sfMouseWheelEvent
|
||||
{
|
||||
@@ -114,7 +120,8 @@ struct sfMouseWheelEvent
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Joystick axis move event parameters
|
||||
/// \brief Joystick axis move event parameters
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
struct sfJoystickMoveEvent
|
||||
{
|
||||
@@ -125,7 +132,8 @@ struct sfJoystickMoveEvent
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Joystick buttons events parameters
|
||||
/// \brief Joystick buttons events parameters
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
struct sfJoystickButtonEvent
|
||||
{
|
||||
@@ -135,7 +143,8 @@ struct sfJoystickButtonEvent
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Joystick connection/disconnection event parameters
|
||||
/// \brief Joystick connection/disconnection event parameters
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
struct sfJoystickConnectEvent
|
||||
{
|
||||
@@ -144,7 +153,8 @@ struct sfJoystickConnectEvent
|
||||
};
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Size events parameters
|
||||
/// \brief Size events parameters
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
struct sfSizeEvent
|
||||
{
|
||||
@@ -155,7 +165,8 @@ struct sfSizeEvent
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// sfEvent defines a system event and its parameters
|
||||
/// \brief sfEvent defines a system event and its parameters
|
||||
///
|
||||
////////////////////////////////////////////////////////////
|
||||
typedef union
|
||||
{
|
||||
|
||||
Reference in new issue
Block a user