summaryrefslogtreecommitdiffstats
path: root/data/dbus-interfaces/net.hadess.SwitcherooControl.xml
blob: e52bc1a0d25543299d94e3187c56b234680d7876 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">

<node>

  <!--
      net.hadess.SwitcherooControl:
      @short_description: D-Bus proxy to access dual-GPU controls.

      After checking the availability of two switchable GPUs in the machine,
      check the value of net.hadess.SwitcherooControl.HasDualGpu to see
      if running applications on the discrete GPU should be offered.

      The object path will be "/net/hadess/SwitcherooControl".
  -->
  <interface name="net.hadess.SwitcherooControl">
    <!--
        HasDualGpu:

        Whether two switchable GPUs are present on the system. This property
        has been obsoleted in favour of the "NumGPUs" property.
    -->
    <property name="HasDualGpu" type="b" access="read"/>

    <!--
        NumGPUs:

        The number of GPUs available on the system. Note that while having no
        GPUs is unlikely, consumers of this API should probably not throw errors
        if that were the case.
    -->
    <property name="NumGPUs" type="u" access="read"/>

    <!--
        GPUs:

        An array of key-pair values representing each GPU. The key named "Name" (s)
        will contain a user-facing name for the GPU, the "Environment" (as) key will
        contain an array of even number of strings, each being an environment
        variable to set to use the GPU, followed by its value, the "Default" (b) key
        will tag the default (usually integrated) GPU.
    -->
    <property name="GPUs" type="aa{sv}" access="read"/>

  </interface>
</node>