pxcloud/spice
5
0
Fork 0
mirror of https://gitlab.uni-freiburg.de/opensourcevdi/spice synced 2026-01-02 22:52:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

QXL interface: improve the spice_qxl_set_device_info documentation

Browse Source 
Instead of one unsupported example, present two real world examples.

Signed-off-by: Lukáš Hrázký <lhrazky@redhat.com>
Acked-by: Jonathon Jongsma <jjongsma@redhat.com>
This commit is contained in:
Lukáš Hrázký 2019-01-28 11:14:02 +01:00 committed by Frediano Ziglio
parent e3a2f9bb01
commit eceab252be
1 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
server/spice-qxl.h
View File

@ -122,7 +122,7 @@ void spice_qxl_gl_draw_async(QXLInstance *instance,
* @instance the QXL instance to set the path to
* @device_address the path of the device this QXL instance belongs to
* @device_display_id_start the starting device display ID of this interface,
* i.e. the one monitor ID 0 maps to
* i.e. the device display ID of monitor ID 0
* @device_display_id_count the total number of device display IDs on this
* interface
*
@ -145,16 +145,28 @@ void spice_qxl_gl_draw_async(QXLInstance *instance,
*
* The device_display_id_{start,count} denotes the sequence of device display
* IDs that map to the zero-based sequence of monitor IDs provided by monitors
* config on this interface. For example with device_display_id_start = 2 and
* device_display_id_count = 3 you get the following mapping:
* monitor_id -> device_display_id
* 0 -> 2
* 1 -> 3
* 2 -> 4
* config on this interface.
*
* Note this example is unsupported in practice. The only supported cases are
* either a single device display ID (count = 1) or multiple device display IDs
* in a sequence starting from 0.
* Example 1:
* A QXL graphics device with 3 heads (monitors).
*
* device_display_id_start = 0
* device_display_id_count = 3
*
* Results in the following mapping of monitor_id -> device_display_id:
* 0 -> 0
* 1 -> 1
* 2 -> 2
*
* Example 2:
* A virtio graphics device, multiple monitors, a QXL interface for each
* monitor. On the QXL interface for the third monitor:
*
* device_display_id_start = 2
* device_display_id_count = 1
*
* Results in the following mapping of monitor_id -> device_display_id:
* 0 -> 2
*/
void spice_qxl_set_device_info(QXLInstance *instance,
const char *device_address,