Skip to content

Commit d5766bc

Browse files
committed
include: More category documentation.
Reference Issue #11847.
1 parent b809da5 commit d5766bc

File tree

3 files changed

+25
-2
lines changed

3 files changed

+25
-2
lines changed

include/SDL3/SDL_time.h

+8
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@ freely, subject to the following restrictions:
2626
* # CategoryTime
2727
*
2828
* SDL realtime clock and date/time routines.
29+
*
30+
* There are two data types that are used in this category: SDL_Time, which
31+
* represents the nanoseconds since a specific moment (an "epoch"), and
32+
* SDL_DateTime, which breaks time down into human-understandable components:
33+
* years, months, days, hours, etc.
34+
*
35+
* Much of the functionality is involved in converting those two types to
36+
* other useful forms.
2937
*/
3038

3139
#include <SDL3/SDL_error.h>

include/SDL3/SDL_touch.h

+12-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,18 @@
2222
/**
2323
* # CategoryTouch
2424
*
25-
* SDL touch management.
25+
* SDL offers touch input, on platforms that support it. It can manage
26+
* multiple touch devices and track multiple fingers on those devices.
27+
*
28+
* Touches are mostly dealt with through the event system, in the
29+
* SDL_EVENT_FINGER_DOWN, SDL_EVENT_FINGER_MOTION, and SDL_EVENT_FINGER_UP
30+
* events, but there are also functions to query for hardware details, etc.
31+
*
32+
* The touch system, by default, will also send virtual mouse events; this can
33+
* be useful for making a some desktop apps work on a phone without
34+
* significant changes. For apps that care about mouse and touch input
35+
* separately, they should ignore mouse events that have a `which` field of
36+
* SDL_TOUCH_MOUSEID.
2637
*/
2738

2839
#ifndef SDL_touch_h_

include/SDL3/SDL_tray.h

+5-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@
2222
/**
2323
* # CategoryTray
2424
*
25-
* System tray menu support.
25+
* SDL offers a way to add items to the "system tray" (more correctly called
26+
* the "notification area" on Windows). On platforms that offer this concept,
27+
* an SDL app can add a tray icon, submenus, checkboxes, and clickable
28+
* entries, and register a callback that is fired when the user clicks on
29+
* these pieces.
2630
*/
2731

2832
#ifndef SDL_tray_h_

0 commit comments

Comments
 (0)