diff --git a/protocol/wayland.xml b/protocol/wayland.xml index 5a6a189..5a3aaf4 100644 --- a/protocol/wayland.xml +++ b/protocol/wayland.xml @@ -2780,7 +2780,7 @@ - + An output describes part of the compositor geometry. The compositor works in the 'compositor coordinate system' and an @@ -3020,6 +3020,37 @@ + + + + + + Many compositors assign numerical indices to their outputs. The index + gives a reliable way to refer to "the first" and "the second" output + without relying on static names. + + On a system where outputs are often hot-plugged into different ports, it + may not be convenient to refer to outputs by name. Many compositors use + the port to determine the output name, which means that a second output + will likely have a different name depending on which port it was plugged + in. + + Additionally, the compositor can change the index of an output, for + example when the user requests to change the order of outputs. + + The exact assignment of indices to outputs is up to the compositor. The + indices are not guaranteed to start at 0 or to be consecutive, but they + must be unique. + + The index event is sent after binding the output object and whenever the + index changes. The index is optional, and may not be sent at all. + + The index event will be followed by a done event. If the index of + multiple outputs has changed, an index event for all of those outputs is + sent before any done event for one of those outputs. + + +