Changeset View
Changeset View
Standalone View
Standalone View
src/client/protocols/outputdevice.xml
| Show All 23 Lines | 3 | <copyright><![CDATA[ | |||
|---|---|---|---|---|---|
| 24 | SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | 24 | SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
| 25 | WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN | 25 | WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN | ||
| 26 | AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, | 26 | AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, | ||
| 27 | ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF | 27 | ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF | ||
| 28 | THIS SOFTWARE. | 28 | THIS SOFTWARE. | ||
| 29 | ]]></copyright> | 29 | ]]></copyright> | ||
| 30 | 30 | | |||
| 31 | 31 | | |||
| 32 | <interface name="org_kde_kwin_outputdevice" version="2"> | 32 | <interface name="org_kde_kwin_outputdevice" version="3"> | ||
| 33 | <description summary="output configuration representation"> | 33 | <description summary="output configuration representation"> | ||
| 34 | An outputdevice describes a display device available to the compositor. | 34 | An outputdevice describes a display device available to the compositor. | ||
| 35 | outputdevice is similar to wl_output, but focuses on output | 35 | outputdevice is similar to wl_output, but focuses on output | ||
| 36 | configuration management. | 36 | configuration management. | ||
| 37 | 37 | | |||
| 38 | A client can query all global outputdevice objects to enlist all | 38 | A client can query all global outputdevice objects to enlist all | ||
| 39 | available display devices, even those that may currently not be | 39 | available display devices, even those that may currently not be | ||
| 40 | represented by the compositor as a wl_output. | 40 | represented by the compositor as a wl_output. | ||
| ▲ Show 20 Lines • Show All 242 Lines • ▼ Show 20 Line(s) | |||||
| 283 | <event name="eisa_id" since="2"> | 283 | <event name="eisa_id" since="2"> | ||
| 284 | <description summary="EISA ID"> | 284 | <description summary="EISA ID"> | ||
| 285 | EISA ID of the monitor, sent on startup before the first done event. | 285 | EISA ID of the monitor, sent on startup before the first done event. | ||
| 286 | </description> | 286 | </description> | ||
| 287 | <arg name="eisaId" type="string" | 287 | <arg name="eisaId" type="string" | ||
| 288 | summary="textual representation of EISA identifier"/> | 288 | summary="textual representation of EISA identifier"/> | ||
| 289 | </event> | 289 | </event> | ||
| 290 | 290 | | |||
| 291 | <event name="clone" since="3"> | ||||
| 292 | <description summary="outputs are immutable clones of each other"> | ||||
| 293 | Because of hardware restrictions some outputs may be not | ||||
| 294 | configurable independently. Such outputs are called clones of each other. | ||||
| 295 | | ||||
| 296 | To identify such outputs a unique positive group id is sent with this event. | ||||
| 297 | In case the output does not have any clones anymore 0 must be sent. The group id | ||||
| 298 | might change at any time as the compositor pleases. One reason for | ||||
| 299 | such a change could be an output hot plug event. | ||||
| 300 | </description> | ||||
| 301 | <arg name="group" type="uint" | ||||
| 302 | summary="clone group id this output is associated with"/> | ||||
| 303 | </event> | ||||
| 304 | | ||||
| 305 | <enum name="trigger_reason" since="3"> | ||||
| 306 | <description summary="reason for an event delivery"> | ||||
| 307 | These flags describe the reason for a certain property change. | ||||
| 308 | </description> | ||||
| 309 | <entry name="none" value="0" | ||||
| 310 | summary="change reason concealed or unknown"/> | ||||
| 311 | <entry name="explicit" value="1" | ||||
| 312 | summary="change due to direct client request or on compositor discretion"/> | ||||
| 313 | <entry name="enablement" value="2" | ||||
| 314 | summary="change due to enablement change of involved devices"/> | ||||
| 315 | <entry name="dpms" value="4" | ||||
| 316 | summary="change due to dpms of involved devices"/> | ||||
| 317 | <entry name="hotplug" value="8" | ||||
| 318 | summary="change due to hotplug of involved devices"/> | ||||
kpiwowarski: It's not the same ;)
None = 0,
Explicit = 1 << 0,
Hotplug… | |||||
| 319 | </enum> | ||||
| 320 | | ||||
| 321 | <enum name="trigger_direction" since="3"> | ||||
| 322 | <description summary="reason for an event delivery"> | ||||
| 323 | These flags describe the direction of a certain property change. | ||||
| 324 | </description> | ||||
| 325 | <entry name="none" value="0" | ||||
| 326 | summary="change direction concealed or unknown"/> | ||||
| 327 | <entry name="up" value="1" | ||||
| 328 | summary="property switched into up state"/> | ||||
| 329 | <entry name="down" value="2" | ||||
| 330 | summary="property switched into up state"/> | ||||
kpiwowarski: > down
| |||||
| 331 | </enum> | ||||
| 332 | | ||||
| 333 | <event name="replicate" since="3"> | ||||
| 334 | <description summary="let this output replicate another output"> | ||||
| 335 | Indicates the state of this output being a replica of another | ||||
| 336 | output. | ||||
| 337 | | ||||
| 338 | The argument specifies the output this output is replicating. The | ||||
| 339 | former is called the replication source. The later is called a | ||||
| 340 | replica of the former. There can only ever be at most one | ||||
| 341 | replication source for a replicating output but multiple replicas | ||||
| 342 | for a replicated output. | ||||
| 343 | | ||||
| 344 | While being a replica it can be expected that its position and scale stay | ||||
| 345 | the same as before until changed through this interface. To get the current | ||||
| 346 | actual position the replication source position must be looked on. The current | ||||
| 347 | client scale can be received through the wl_output interface, the effective | ||||
| 348 | logical scale on the output is an opaque internal to the server. | ||||
| 349 | | ||||
| 350 | Changes to all output device properties can be issued while the output device is | ||||
| 351 | a replica but if a property change directly affects the picture depends on the | ||||
| 352 | compositor behavior. Likely only changes to mode, transform and color curves do | ||||
| 353 | have a direct effect, other properties will be applied when the output is not | ||||
| 354 | anymore a replica. | ||||
| 355 | | ||||
| 356 | The compositor is expected to use black bars or stretch the image on | ||||
| 357 | replicas to fit differing aspect ratios. | ||||
| 358 | | ||||
| 359 | Replication is active when the source argument is non-null. On the other side | ||||
| 360 | the source argument is set to a null string to indicate that the output is | ||||
| 361 | not anymore a replica. | ||||
| 362 | | ||||
| 363 | The event might also be sent by the compositor when the replication source is | ||||
| 364 | disappearing, for example through DPMS change or an hotplug event on the source. | ||||
| 365 | Compositors are urged to fill the argument trigger with this reason, so clients can | ||||
| 366 | react accordingly. The argument direction gives additional information about the reason, | ||||
| 367 | for example on a source removing DPMS change the down enum should be sent, analogous for | ||||
| 368 | enablement and hotplug changes. When the reason is enum explicit the direction down | ||||
| 369 | signals that a client request was responsible for the change while up means that the | ||||
| 370 | change was carried out on some compositor's internal logic. | ||||
| 371 | </description> | ||||
| 372 | <arg name="source_uuid" type="string" | ||||
| 373 | summary="the output uuid this output is a replica for" | ||||
| 374 | allow-null="true"/> | ||||
| 375 | <arg name="trigger" type="uint" enum="trigger_reason"/> | ||||
| 376 | <arg name="direction" type="uint" enum="trigger_direction"/> | ||||
| 377 | </event> | ||||
| 291 | </interface> | 378 | </interface> | ||
| 292 | 379 | | |||
| 293 | 380 | | |||
| 294 | 381 | | |||
| 295 | </protocol> | 382 | </protocol> | ||
It's not the same ;)