Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit a59c969

Browse files
authored
Document the coordinate space of points in FlutterPointerEvent. (#13782)
1 parent dee42b4 commit a59c969

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

shell/platform/embedder/embedder.h

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,15 +404,21 @@ typedef struct {
404404
/// The size of this struct. Must be sizeof(FlutterPointerEvent).
405405
size_t struct_size;
406406
FlutterPointerPhase phase;
407-
/// @attention The timestamp must be specified in microseconds.
407+
/// The timestamp at which the pointer event was generated. The timestamp
408+
/// should be specified in microseconds and the clock should be the same as
409+
/// that used by `FlutterEngineGetCurrentTime`.
408410
size_t timestamp;
411+
/// The x coordinate of the pointer event in physical pixels.
409412
double x;
413+
/// The y coordinate of the pointer event in physical pixels.
410414
double y;
411415
/// An optional device identifier. If this is not specified, it is assumed
412416
/// that the embedder has no multi-touch capability.
413417
int32_t device;
414418
FlutterPointerSignalKind signal_kind;
419+
/// The x offset of the scroll in physical pixels.
415420
double scroll_delta_x;
421+
/// The y offset of the scroll in physical pixels.
416422
double scroll_delta_y;
417423
/// The type of the device generating this event.
418424
/// Backwards compatibility note: If this is not set, the device will be

0 commit comments

Comments
 (0)