diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2017-04-21 08:47:31 +1000 |
|---|---|---|
| committer | Peter Hutterer <peter.hutterer@who-t.net> | 2017-04-25 10:56:48 +1000 |
| commit | 7b9aa96d0230b9b1328c43e8421ddea3ffa310cb (patch) | |
| tree | c5ef3e03ce084c9e60be1250725d1c699462af1d /src | |
| parent | 555ee1a9898d4c19d138b9a5fe77138abfe47283 (diff) | |
Add doc to discourage use of libinput_device_get_output_name()
This is a leftover from when libinput was part of weston and we could
interpret properties correctly. Realistically, the only way this could work
with libinput as external library is if we define precisely what the
definition of an output is. Practically, it's a lot easier to just throw up
our hands and leave it all to the caller.
https://bugs.freedesktop.org/show_bug.cgi?id=100707
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Diffstat (limited to 'src')
| -rw-r--r-- | src/libinput.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/libinput.h b/src/libinput.h index aa30cfa..430fe18 100644 --- a/src/libinput.h +++ b/src/libinput.h @@ -3491,6 +3491,14 @@ libinput_device_get_id_vendor(struct libinput_device *device); * beyond the boundaries of this output. An absolute device has its input * coordinates mapped to the extents of this output. * + * @note <b>Use of this function is discouraged.</b> Its return value is not + * precisely defined and may not be understood by the caller or may be + * insufficient to map the device. Instead, the system configuration could + * set a udev property the caller understands and interprets correctly. The + * caller could then obtain device with libinput_device_get_udev_device() + * and query it for this property. For more complex cases, the caller + * must implement monitor-to-device association heuristics. + * * @return The name of the output this device is mapped to, or NULL if no * output is set */ |