detached 70078d0

feat(protocol): vendor xdg-output-unstable-v1

commit
70078d039950cdc93e18ffa2ac3a1482d40bd6e7
author
brice · · 2026-09-23 16:11 UTC
parent
e62a554
signature
GPG VerifiedCD88F9E564E0102646FB6077A1A07C7C7C3E349D · arch-gpg Verified for the committer email
4 files · +406 -0
Unified
UnifiedSplit
M protocol/gen.go +1 -0
@@ -4,3 +4,4 @@ package protocol
44 //go:generate go run ../cmd/wlgen -package wayland -out wayland/wayland.go ../protocols/wayland.xml
55 //go:generate go run ../cmd/wlgen -package xdgshell -out xdgshell/xdgshell.go -import wayland=github.com/bnema/purego-libwayland/protocol/wayland -import-xml wayland=../protocols/wayland.xml ../protocols/xdg-shell.xml
66 //go:generate go run ../cmd/wlgen -package wlrlayershell -out wlrlayershell/wlrlayershell.go -import wayland=github.com/bnema/purego-libwayland/protocol/wayland -import-xml wayland=../protocols/wayland.xml -import xdgshell=github.com/bnema/purego-libwayland/protocol/xdgshell -import-xml xdgshell=../protocols/xdg-shell.xml ../protocols/wlr-layer-shell-unstable-v1.xml
7+//go:generate go run ../cmd/wlgen -package xdgoutput -out xdgoutput/xdgoutput.go -import wayland=github.com/bnema/purego-libwayland/protocol/wayland -import-xml wayland=../protocols/wayland.xml ../protocols/xdg-output-unstable-v1.xml
@@ -4,3 +4,4 @@ package protocol
4 //go:generate go run ../cmd/wlgen -package wayland -out wayland/wayland.go ../protocols/wayland.xml4 //go:generate go run ../cmd/wlgen -package wayland -out wayland/wayland.go ../protocols/wayland.xml
5 //go:generate go run ../cmd/wlgen -package xdgshell -out xdgshell/xdgshell.go -import wayland=github.com/bnema/purego-libwayland/protocol/wayland -import-xml wayland=../protocols/wayland.xml ../protocols/xdg-shell.xml5 //go:generate go run ../cmd/wlgen -package xdgshell -out xdgshell/xdgshell.go -import wayland=github.com/bnema/purego-libwayland/protocol/wayland -import-xml wayland=../protocols/wayland.xml ../protocols/xdg-shell.xml
6 //go:generate go run ../cmd/wlgen -package wlrlayershell -out wlrlayershell/wlrlayershell.go -import wayland=github.com/bnema/purego-libwayland/protocol/wayland -import-xml wayland=../protocols/wayland.xml -import xdgshell=github.com/bnema/purego-libwayland/protocol/xdgshell -import-xml xdgshell=../protocols/xdg-shell.xml ../protocols/wlr-layer-shell-unstable-v1.xml6 //go:generate go run ../cmd/wlgen -package wlrlayershell -out wlrlayershell/wlrlayershell.go -import wayland=github.com/bnema/purego-libwayland/protocol/wayland -import-xml wayland=../protocols/wayland.xml -import xdgshell=github.com/bnema/purego-libwayland/protocol/xdgshell -import-xml xdgshell=../protocols/xdg-shell.xml ../protocols/wlr-layer-shell-unstable-v1.xml
7+//go:generate go run ../cmd/wlgen -package xdgoutput -out xdgoutput/xdgoutput.go -import wayland=github.com/bnema/purego-libwayland/protocol/wayland -import-xml wayland=../protocols/wayland.xml ../protocols/xdg-output-unstable-v1.xml
A protocol/xdgoutput/xdgoutput.go +171 -0
@@ -0,0 +1,171 @@
1+// Code generated by wlgen; DO NOT EDIT.
2+package xdgoutput
3+
4+import (
5+ "fmt"
6+ wayland "github.com/bnema/purego-libwayland/protocol/wayland"
7+ "github.com/bnema/purego-libwayland/server"
8+ "runtime"
9+)
10+
11+var ZxdgOutputManagerV1Interface *server.Interface
12+var ZxdgOutputV1Interface *server.Interface
13+
14+func init() {
15+ ZxdgOutputManagerV1Interface = &server.Interface{Name: "zxdg_output_manager_v1", Version: 3}
16+ ZxdgOutputV1Interface = &server.Interface{Name: "zxdg_output_v1", Version: 3}
17+ ZxdgOutputManagerV1Interface.Requests = []server.Message{
18+ {Name: "destroy", Signature: "", Types: []*server.Interface{}},
19+ {Name: "get_xdg_output", Signature: "no", Types: []*server.Interface{ZxdgOutputV1Interface, wayland.OutputInterface}},
20+ }
21+ ZxdgOutputManagerV1Interface.Events = []server.Message{}
22+ ZxdgOutputV1Interface.Requests = []server.Message{
23+ {Name: "destroy", Signature: "", Types: []*server.Interface{}},
24+ }
25+ ZxdgOutputV1Interface.Events = []server.Message{
26+ {Name: "logical_position", Signature: "ii", Types: []*server.Interface{nil, nil}},
27+ {Name: "logical_size", Signature: "ii", Types: []*server.Interface{nil, nil}},
28+ {Name: "done", Signature: "", Types: []*server.Interface{}},
29+ {Name: "name", Signature: "2s", Types: []*server.Interface{nil}},
30+ {Name: "description", Signature: "2s", Types: []*server.Interface{nil}},
31+ }
32+ if err := server.NewInterfaces(ZxdgOutputManagerV1Interface, ZxdgOutputV1Interface); err != nil {
33+ panic(err)
34+ }
35+}
36+
37+// ZxdgOutputManagerV1 manage xdg_output objects.
38+type ZxdgOutputManagerV1 struct{ *server.Resource }
39+
40+func WrapZxdgOutputManagerV1(r *server.Resource) *ZxdgOutputManagerV1 {
41+ if r == nil {
42+ return nil
43+ }
44+ return &ZxdgOutputManagerV1{r}
45+}
46+
47+const ZxdgOutputManagerV1RequestDestroy uint32 = 0
48+const ZxdgOutputManagerV1RequestGetXdgOutput uint32 = 1
49+
50+// ZxdgOutputManagerV1Handler handles zxdg_output_manager_v1 requests.
51+type ZxdgOutputManagerV1Handler interface {
52+ Destroy(self *ZxdgOutputManagerV1)
53+ GetXdgOutput(self *ZxdgOutputManagerV1, id uint32, output *wayland.Output)
54+}
55+
56+func NewZxdgOutputManagerV1(c server.Client, version int32, id uint32, h ZxdgOutputManagerV1Handler) (*ZxdgOutputManagerV1, error) {
57+ if h == nil {
58+ return nil, fmt.Errorf("purego-libwayland: nil handler for zxdg_output_manager_v1")
59+ }
60+ var self *ZxdgOutputManagerV1
61+ r, err := c.CreateResource(ZxdgOutputManagerV1Interface, version, id, func(_ *server.Resource, opcode uint32, args []server.Arg) {
62+ switch opcode {
63+ case 0:
64+ h.Destroy(self)
65+ self.Destroy()
66+ case 1:
67+ h.GetXdgOutput(self, args[0].NewID(), wayland.WrapOutput(args[1].Resource()))
68+ }
69+ })
70+ if err != nil {
71+ return nil, err
72+ }
73+ self = WrapZxdgOutputManagerV1(r)
74+ r.Data = self
75+ return self, nil
76+}
77+func NewZxdgOutputManagerV1Global(d *server.Display, version int32, bind server.BindFunc) error {
78+ return d.CreateGlobal(ZxdgOutputManagerV1Interface, version, bind)
79+}
80+
81+// ZxdgOutputV1 compositor logical output region.
82+type ZxdgOutputV1 struct{ *server.Resource }
83+
84+func WrapZxdgOutputV1(r *server.Resource) *ZxdgOutputV1 {
85+ if r == nil {
86+ return nil
87+ }
88+ return &ZxdgOutputV1{r}
89+}
90+
91+const ZxdgOutputV1RequestDestroy uint32 = 0
92+const ZxdgOutputV1EventLogicalPosition uint32 = 0
93+const ZxdgOutputV1EventLogicalSize uint32 = 1
94+const ZxdgOutputV1EventDone uint32 = 2
95+const ZxdgOutputV1EventName uint32 = 3
96+const ZxdgOutputV1EventDescription uint32 = 4
97+
98+// ZxdgOutputV1Handler handles zxdg_output_v1 requests.
99+type ZxdgOutputV1Handler interface {
100+ Destroy(self *ZxdgOutputV1)
101+}
102+
103+func NewZxdgOutputV1(c server.Client, version int32, id uint32, h ZxdgOutputV1Handler) (*ZxdgOutputV1, error) {
104+ if h == nil {
105+ return nil, fmt.Errorf("purego-libwayland: nil handler for zxdg_output_v1")
106+ }
107+ var self *ZxdgOutputV1
108+ r, err := c.CreateResource(ZxdgOutputV1Interface, version, id, func(_ *server.Resource, opcode uint32, args []server.Arg) {
109+ switch opcode {
110+ case 0:
111+ h.Destroy(self)
112+ self.Destroy()
113+ }
114+ })
115+ if err != nil {
116+ return nil, err
117+ }
118+ self = WrapZxdgOutputV1(r)
119+ r.Data = self
120+ return self, nil
121+}
122+
123+// SendLogicalPosition position of the output within the global compositor space.
124+func (self *ZxdgOutputV1) SendLogicalPosition(x int32, y int32) {
125+ self.PostEvent(ZxdgOutputV1EventLogicalPosition, server.Int(x), server.Int(y))
126+}
127+
128+// SendLogicalSize size of the output in the global compositor space.
129+func (self *ZxdgOutputV1) SendLogicalSize(width int32, height int32) {
130+ self.PostEvent(ZxdgOutputV1EventLogicalSize, server.Int(width), server.Int(height))
131+}
132+
133+// SendDone all information about the output have been sent.
134+func (self *ZxdgOutputV1) SendDone() {
135+ self.PostEvent(ZxdgOutputV1EventDone)
136+}
137+
138+// SendName name of this output (since version 2).
139+func (self *ZxdgOutputV1) SendName(name string) {
140+ var p runtime.Pinner
141+ defer p.Unpin()
142+ self.PostEvent(ZxdgOutputV1EventName, server.String(&p, name, false))
143+}
144+
145+// SendDescription human-readable description of this output (since version 2).
146+func (self *ZxdgOutputV1) SendDescription(description string) {
147+ var p runtime.Pinner
148+ defer p.Unpin()
149+ self.PostEvent(ZxdgOutputV1EventDescription, server.String(&p, description, false))
150+}
151+func NewZxdgOutputV1Global(d *server.Display, version int32, bind server.BindFunc) error {
152+ return d.CreateGlobal(ZxdgOutputV1Interface, version, bind)
153+}
154+func resourceOf(v interface{ GetResource() *server.Resource }) *server.Resource {
155+ if v == nil {
156+ return nil
157+ }
158+ return v.GetResource()
159+}
160+func (self *ZxdgOutputManagerV1) GetResource() *server.Resource {
161+ if self == nil {
162+ return nil
163+ }
164+ return self.Resource
165+}
166+func (self *ZxdgOutputV1) GetResource() *server.Resource {
167+ if self == nil {
168+ return nil
169+ }
170+ return self.Resource
171+}
@@ -0,0 +1,171 @@
1+// Code generated by wlgen; DO NOT EDIT.
2+package xdgoutput
3+
4+import (
5+ "fmt"
6+ wayland "github.com/bnema/purego-libwayland/protocol/wayland"
7+ "github.com/bnema/purego-libwayland/server"
8+ "runtime"
9+)
10+
11+var ZxdgOutputManagerV1Interface *server.Interface
12+var ZxdgOutputV1Interface *server.Interface
13+
14+func init() {
15+ ZxdgOutputManagerV1Interface = &server.Interface{Name: "zxdg_output_manager_v1", Version: 3}
16+ ZxdgOutputV1Interface = &server.Interface{Name: "zxdg_output_v1", Version: 3}
17+ ZxdgOutputManagerV1Interface.Requests = []server.Message{
18+ {Name: "destroy", Signature: "", Types: []*server.Interface{}},
19+ {Name: "get_xdg_output", Signature: "no", Types: []*server.Interface{ZxdgOutputV1Interface, wayland.OutputInterface}},
20+ }
21+ ZxdgOutputManagerV1Interface.Events = []server.Message{}
22+ ZxdgOutputV1Interface.Requests = []server.Message{
23+ {Name: "destroy", Signature: "", Types: []*server.Interface{}},
24+ }
25+ ZxdgOutputV1Interface.Events = []server.Message{
26+ {Name: "logical_position", Signature: "ii", Types: []*server.Interface{nil, nil}},
27+ {Name: "logical_size", Signature: "ii", Types: []*server.Interface{nil, nil}},
28+ {Name: "done", Signature: "", Types: []*server.Interface{}},
29+ {Name: "name", Signature: "2s", Types: []*server.Interface{nil}},
30+ {Name: "description", Signature: "2s", Types: []*server.Interface{nil}},
31+ }
32+ if err := server.NewInterfaces(ZxdgOutputManagerV1Interface, ZxdgOutputV1Interface); err != nil {
33+ panic(err)
34+ }
35+}
36+
37+// ZxdgOutputManagerV1 manage xdg_output objects.
38+type ZxdgOutputManagerV1 struct{ *server.Resource }
39+
40+func WrapZxdgOutputManagerV1(r *server.Resource) *ZxdgOutputManagerV1 {
41+ if r == nil {
42+ return nil
43+ }
44+ return &ZxdgOutputManagerV1{r}
45+}
46+
47+const ZxdgOutputManagerV1RequestDestroy uint32 = 0
48+const ZxdgOutputManagerV1RequestGetXdgOutput uint32 = 1
49+
50+// ZxdgOutputManagerV1Handler handles zxdg_output_manager_v1 requests.
51+type ZxdgOutputManagerV1Handler interface {
52+ Destroy(self *ZxdgOutputManagerV1)
53+ GetXdgOutput(self *ZxdgOutputManagerV1, id uint32, output *wayland.Output)
54+}
55+
56+func NewZxdgOutputManagerV1(c server.Client, version int32, id uint32, h ZxdgOutputManagerV1Handler) (*ZxdgOutputManagerV1, error) {
57+ if h == nil {
58+ return nil, fmt.Errorf("purego-libwayland: nil handler for zxdg_output_manager_v1")
59+ }
60+ var self *ZxdgOutputManagerV1
61+ r, err := c.CreateResource(ZxdgOutputManagerV1Interface, version, id, func(_ *server.Resource, opcode uint32, args []server.Arg) {
62+ switch opcode {
63+ case 0:
64+ h.Destroy(self)
65+ self.Destroy()
66+ case 1:
67+ h.GetXdgOutput(self, args[0].NewID(), wayland.WrapOutput(args[1].Resource()))
68+ }
69+ })
70+ if err != nil {
71+ return nil, err
72+ }
73+ self = WrapZxdgOutputManagerV1(r)
74+ r.Data = self
75+ return self, nil
76+}
77+func NewZxdgOutputManagerV1Global(d *server.Display, version int32, bind server.BindFunc) error {
78+ return d.CreateGlobal(ZxdgOutputManagerV1Interface, version, bind)
79+}
80+
81+// ZxdgOutputV1 compositor logical output region.
82+type ZxdgOutputV1 struct{ *server.Resource }
83+
84+func WrapZxdgOutputV1(r *server.Resource) *ZxdgOutputV1 {
85+ if r == nil {
86+ return nil
87+ }
88+ return &ZxdgOutputV1{r}
89+}
90+
91+const ZxdgOutputV1RequestDestroy uint32 = 0
92+const ZxdgOutputV1EventLogicalPosition uint32 = 0
93+const ZxdgOutputV1EventLogicalSize uint32 = 1
94+const ZxdgOutputV1EventDone uint32 = 2
95+const ZxdgOutputV1EventName uint32 = 3
96+const ZxdgOutputV1EventDescription uint32 = 4
97+
98+// ZxdgOutputV1Handler handles zxdg_output_v1 requests.
99+type ZxdgOutputV1Handler interface {
100+ Destroy(self *ZxdgOutputV1)
101+}
102+
103+func NewZxdgOutputV1(c server.Client, version int32, id uint32, h ZxdgOutputV1Handler) (*ZxdgOutputV1, error) {
104+ if h == nil {
105+ return nil, fmt.Errorf("purego-libwayland: nil handler for zxdg_output_v1")
106+ }
107+ var self *ZxdgOutputV1
108+ r, err := c.CreateResource(ZxdgOutputV1Interface, version, id, func(_ *server.Resource, opcode uint32, args []server.Arg) {
109+ switch opcode {
110+ case 0:
111+ h.Destroy(self)
112+ self.Destroy()
113+ }
114+ })
115+ if err != nil {
116+ return nil, err
117+ }
118+ self = WrapZxdgOutputV1(r)
119+ r.Data = self
120+ return self, nil
121+}
122+
123+// SendLogicalPosition position of the output within the global compositor space.
124+func (self *ZxdgOutputV1) SendLogicalPosition(x int32, y int32) {
125+ self.PostEvent(ZxdgOutputV1EventLogicalPosition, server.Int(x), server.Int(y))
126+}
127+
128+// SendLogicalSize size of the output in the global compositor space.
129+func (self *ZxdgOutputV1) SendLogicalSize(width int32, height int32) {
130+ self.PostEvent(ZxdgOutputV1EventLogicalSize, server.Int(width), server.Int(height))
131+}
132+
133+// SendDone all information about the output have been sent.
134+func (self *ZxdgOutputV1) SendDone() {
135+ self.PostEvent(ZxdgOutputV1EventDone)
136+}
137+
138+// SendName name of this output (since version 2).
139+func (self *ZxdgOutputV1) SendName(name string) {
140+ var p runtime.Pinner
141+ defer p.Unpin()
142+ self.PostEvent(ZxdgOutputV1EventName, server.String(&p, name, false))
143+}
144+
145+// SendDescription human-readable description of this output (since version 2).
146+func (self *ZxdgOutputV1) SendDescription(description string) {
147+ var p runtime.Pinner
148+ defer p.Unpin()
149+ self.PostEvent(ZxdgOutputV1EventDescription, server.String(&p, description, false))
150+}
151+func NewZxdgOutputV1Global(d *server.Display, version int32, bind server.BindFunc) error {
152+ return d.CreateGlobal(ZxdgOutputV1Interface, version, bind)
153+}
154+func resourceOf(v interface{ GetResource() *server.Resource }) *server.Resource {
155+ if v == nil {
156+ return nil
157+ }
158+ return v.GetResource()
159+}
160+func (self *ZxdgOutputManagerV1) GetResource() *server.Resource {
161+ if self == nil {
162+ return nil
163+ }
164+ return self.Resource
165+}
166+func (self *ZxdgOutputV1) GetResource() *server.Resource {
167+ if self == nil {
168+ return nil
169+ }
170+ return self.Resource
171+}
A protocol/xdgoutput/xdgoutput_test.go +12 -0
@@ -0,0 +1,12 @@
1+package xdgoutput
2+
3+import "testing"
4+
5+func TestOutputInterface(t *testing.T) {
6+ if ZxdgOutputManagerV1Interface == nil || ZxdgOutputV1Interface == nil {
7+ t.Fatal("xdg-output interfaces not initialized")
8+ }
9+ if got := ZxdgOutputManagerV1Interface.Requests[1].Types[0]; got != ZxdgOutputV1Interface {
10+ t.Fatalf("get_xdg_output new_id type = %v", got)
11+ }
12+}
@@ -0,0 +1,12 @@
1+package xdgoutput
2+
3+import "testing"
4+
5+func TestOutputInterface(t *testing.T) {
6+ if ZxdgOutputManagerV1Interface == nil || ZxdgOutputV1Interface == nil {
7+ t.Fatal("xdg-output interfaces not initialized")
8+ }
9+ if got := ZxdgOutputManagerV1Interface.Requests[1].Types[0]; got != ZxdgOutputV1Interface {
10+ t.Fatalf("get_xdg_output new_id type = %v", got)
11+ }
12+}
A protocols/xdg-output-unstable-v1.xml +222 -0
@@ -0,0 +1,222 @@
1+<?xml version="1.0" encoding="UTF-8"?>
2+<protocol name="xdg_output_unstable_v1">
3+
4+ <copyright>
5+ Copyright © 2017 Red Hat Inc.
6+
7+ Permission is hereby granted, free of charge, to any person obtaining a
8+ copy of this software and associated documentation files (the "Software"),
9+ to deal in the Software without restriction, including without limitation
10+ the rights to use, copy, modify, merge, publish, distribute, sublicense,
11+ and/or sell copies of the Software, and to permit persons to whom the
12+ Software is furnished to do so, subject to the following conditions:
13+
14+ The above copyright notice and this permission notice (including the next
15+ paragraph) shall be included in all copies or substantial portions of the
16+ Software.
17+
18+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21+ THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24+ DEALINGS IN THE SOFTWARE.
25+ </copyright>
26+
27+ <description summary="Protocol to describe output regions">
28+ This protocol aims at describing outputs in a way which is more in line
29+ with the concept of an output on desktop oriented systems.
30+
31+ Some information are more specific to the concept of an output for
32+ a desktop oriented system and may not make sense in other applications,
33+ such as IVI systems for example.
34+
35+ Typically, the global compositor space on a desktop system is made of
36+ a contiguous or overlapping set of rectangular regions.
37+
38+ The logical_position and logical_size events defined in this protocol
39+ might provide information identical to their counterparts already
40+ available from wl_output, in which case the information provided by this
41+ protocol should be preferred to their equivalent in wl_output. The goal is
42+ to move the desktop specific concepts (such as output location within the
43+ global compositor space, etc.) out of the core wl_output protocol.
44+
45+ Warning! The protocol described in this file is experimental and
46+ backward incompatible changes may be made. Backward compatible
47+ changes may be added together with the corresponding interface
48+ version bump.
49+ Backward incompatible changes are done by bumping the version
50+ number in the protocol and interface names and resetting the
51+ interface version. Once the protocol is to be declared stable,
52+ the 'z' prefix and the version number in the protocol and
53+ interface names are removed and the interface version number is
54+ reset.
55+ </description>
56+
57+ <interface name="zxdg_output_manager_v1" version="3">
58+ <description summary="manage xdg_output objects">
59+ A global factory interface for xdg_output objects.
60+ </description>
61+
62+ <request name="destroy" type="destructor">
63+ <description summary="destroy the xdg_output_manager object">
64+ Using this request a client can tell the server that it is not
65+ going to use the xdg_output_manager object anymore.
66+
67+ Any objects already created through this instance are not affected.
68+ </description>
69+ </request>
70+
71+ <request name="get_xdg_output">
72+ <description summary="create an xdg output from a wl_output">
73+ This creates a new xdg_output object for the given wl_output.
74+ </description>
75+ <arg name="id" type="new_id" interface="zxdg_output_v1"/>
76+ <arg name="output" type="object" interface="wl_output"/>
77+ </request>
78+ </interface>
79+
80+ <interface name="zxdg_output_v1" version="3">
81+ <description summary="compositor logical output region">
82+ An xdg_output describes part of the compositor geometry.
83+
84+ This typically corresponds to a monitor that displays part of the
85+ compositor space.
86+
87+ For objects version 3 onwards, after all xdg_output properties have been
88+ sent (when the object is created and when properties are updated), a
89+ wl_output.done event is sent. This allows changes to the output
90+ properties to be seen as atomic, even if they happen via multiple events.
91+ </description>
92+
93+ <request name="destroy" type="destructor">
94+ <description summary="destroy the xdg_output object">
95+ Using this request a client can tell the server that it is not
96+ going to use the xdg_output object anymore.
97+ </description>
98+ </request>
99+
100+ <event name="logical_position">
101+ <description summary="position of the output within the global compositor space">
102+ The position event describes the location of the wl_output within
103+ the global compositor space.
104+
105+ The logical_position event is sent after creating an xdg_output
106+ (see xdg_output_manager.get_xdg_output) and whenever the location
107+ of the output changes within the global compositor space.
108+ </description>
109+ <arg name="x" type="int"
110+ summary="x position within the global compositor space"/>
111+ <arg name="y" type="int"
112+ summary="y position within the global compositor space"/>
113+ </event>
114+
115+ <event name="logical_size">
116+ <description summary="size of the output in the global compositor space">
117+ The logical_size event describes the size of the output in the
118+ global compositor space.
119+
120+ Most regular Wayland clients should not pay attention to the
121+ logical size and would rather rely on xdg_shell interfaces.
122+
123+ Some clients such as Xwayland, however, need this to configure
124+ their surfaces in the global compositor space as the compositor
125+ may apply a different scale from what is advertised by the output
126+ scaling property (to achieve fractional scaling, for example).
127+
128+ For example, for a wl_output mode 3840×2160 and a scale factor 2:
129+
130+ - A compositor not scaling the monitor viewport in its compositing space
131+ will advertise a logical size of 3840×2160,
132+
133+ - A compositor scaling the monitor viewport with scale factor 2 will
134+ advertise a logical size of 1920×1080,
135+
136+ - A compositor scaling the monitor viewport using a fractional scale of
137+ 1.5 will advertise a logical size of 2560×1440.
138+
139+ For example, for a wl_output mode 1920×1080 and a 90 degree rotation,
140+ the compositor will advertise a logical size of 1080x1920.
141+
142+ The logical_size event is sent after creating an xdg_output
143+ (see xdg_output_manager.get_xdg_output) and whenever the logical
144+ size of the output changes, either as a result of a change in the
145+ applied scale or because of a change in the corresponding output
146+ mode(see wl_output.mode) or transform (see wl_output.transform).
147+ </description>
148+ <arg name="width" type="int"
149+ summary="width in global compositor space"/>
150+ <arg name="height" type="int"
151+ summary="height in global compositor space"/>
152+ </event>
153+
154+ <event name="done" deprecated-since="3">
155+ <description summary="all information about the output have been sent">
156+ This event is sent after all other properties of an xdg_output
157+ have been sent.
158+
159+ This allows changes to the xdg_output properties to be seen as
160+ atomic, even if they happen via multiple events.
161+
162+ For objects version 3 onwards, this event is deprecated. Compositors
163+ are not required to send it anymore and must send wl_output.done
164+ instead.
165+ </description>
166+ </event>
167+
168+ <!-- Version 2 additions -->
169+
170+ <event name="name" since="2">
171+ <description summary="name of this output">
172+ Many compositors will assign names to their outputs, show them to the
173+ user, allow them to be configured by name, etc. The client may wish to
174+ know this name as well to offer the user similar behaviors.
175+
176+ The naming convention is compositor defined, but limited to
177+ alphanumeric characters and dashes (-). Each name is unique among all
178+ wl_output globals, but if a wl_output global is destroyed the same name
179+ may be reused later. The names will also remain consistent across
180+ sessions with the same hardware and software configuration.
181+
182+ Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do
183+ not assume that the name is a reflection of an underlying DRM
184+ connector, X11 connection, etc.
185+
186+ The name event is sent after creating an xdg_output (see
187+ xdg_output_manager.get_xdg_output). This event is only sent once per
188+ xdg_output, and the name does not change over the lifetime of the
189+ wl_output global.
190+
191+ This event is deprecated, instead clients should use wl_output.name.
192+ Compositors must still support this event.
193+ </description>
194+ <arg name="name" type="string" summary="output name"/>
195+ </event>
196+
197+ <event name="description" since="2">
198+ <description summary="human-readable description of this output">
199+ Many compositors can produce human-readable descriptions of their
200+ outputs. The client may wish to know this description as well, to
201+ communicate the user for various purposes.
202+
203+ The description is a UTF-8 string with no convention defined for its
204+ contents. Examples might include 'Foocorp 11" Display' or 'Virtual X11
205+ output via :1'.
206+
207+ The description event is sent after creating an xdg_output (see
208+ xdg_output_manager.get_xdg_output) and whenever the description
209+ changes. The description is optional, and may not be sent at all.
210+
211+ For objects of version 2 and lower, this event is only sent once per
212+ xdg_output, and the description does not change over the lifetime of
213+ the wl_output global.
214+
215+ This event is deprecated, instead clients should use
216+ wl_output.description. Compositors must still support this event.
217+ </description>
218+ <arg name="description" type="string" summary="output description"/>
219+ </event>
220+
221+ </interface>
222+</protocol>
@@ -0,0 +1,222 @@
1+<?xml version="1.0" encoding="UTF-8"?>
2+<protocol name="xdg_output_unstable_v1">
3+
4+ <copyright>
5+ Copyright © 2017 Red Hat Inc.
6+
7+ Permission is hereby granted, free of charge, to any person obtaining a
8+ copy of this software and associated documentation files (the "Software"),
9+ to deal in the Software without restriction, including without limitation
10+ the rights to use, copy, modify, merge, publish, distribute, sublicense,
11+ and/or sell copies of the Software, and to permit persons to whom the
12+ Software is furnished to do so, subject to the following conditions:
13+
14+ The above copyright notice and this permission notice (including the next
15+ paragraph) shall be included in all copies or substantial portions of the
16+ Software.
17+
18+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21+ THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24+ DEALINGS IN THE SOFTWARE.
25+ </copyright>
26+
27+ <description summary="Protocol to describe output regions">
28+ This protocol aims at describing outputs in a way which is more in line
29+ with the concept of an output on desktop oriented systems.
30+
31+ Some information are more specific to the concept of an output for
32+ a desktop oriented system and may not make sense in other applications,
33+ such as IVI systems for example.
34+
35+ Typically, the global compositor space on a desktop system is made of
36+ a contiguous or overlapping set of rectangular regions.
37+
38+ The logical_position and logical_size events defined in this protocol
39+ might provide information identical to their counterparts already
40+ available from wl_output, in which case the information provided by this
41+ protocol should be preferred to their equivalent in wl_output. The goal is
42+ to move the desktop specific concepts (such as output location within the
43+ global compositor space, etc.) out of the core wl_output protocol.
44+
45+ Warning! The protocol described in this file is experimental and
46+ backward incompatible changes may be made. Backward compatible
47+ changes may be added together with the corresponding interface
48+ version bump.
49+ Backward incompatible changes are done by bumping the version
50+ number in the protocol and interface names and resetting the
51+ interface version. Once the protocol is to be declared stable,
52+ the 'z' prefix and the version number in the protocol and
53+ interface names are removed and the interface version number is
54+ reset.
55+ </description>
56+
57+ <interface name="zxdg_output_manager_v1" version="3">
58+ <description summary="manage xdg_output objects">
59+ A global factory interface for xdg_output objects.
60+ </description>
61+
62+ <request name="destroy" type="destructor">
63+ <description summary="destroy the xdg_output_manager object">
64+ Using this request a client can tell the server that it is not
65+ going to use the xdg_output_manager object anymore.
66+
67+ Any objects already created through this instance are not affected.
68+ </description>
69+ </request>
70+
71+ <request name="get_xdg_output">
72+ <description summary="create an xdg output from a wl_output">
73+ This creates a new xdg_output object for the given wl_output.
74+ </description>
75+ <arg name="id" type="new_id" interface="zxdg_output_v1"/>
76+ <arg name="output" type="object" interface="wl_output"/>
77+ </request>
78+ </interface>
79+
80+ <interface name="zxdg_output_v1" version="3">
81+ <description summary="compositor logical output region">
82+ An xdg_output describes part of the compositor geometry.
83+
84+ This typically corresponds to a monitor that displays part of the
85+ compositor space.
86+
87+ For objects version 3 onwards, after all xdg_output properties have been
88+ sent (when the object is created and when properties are updated), a
89+ wl_output.done event is sent. This allows changes to the output
90+ properties to be seen as atomic, even if they happen via multiple events.
91+ </description>
92+
93+ <request name="destroy" type="destructor">
94+ <description summary="destroy the xdg_output object">
95+ Using this request a client can tell the server that it is not
96+ going to use the xdg_output object anymore.
97+ </description>
98+ </request>
99+
100+ <event name="logical_position">
101+ <description summary="position of the output within the global compositor space">
102+ The position event describes the location of the wl_output within
103+ the global compositor space.
104+
105+ The logical_position event is sent after creating an xdg_output
106+ (see xdg_output_manager.get_xdg_output) and whenever the location
107+ of the output changes within the global compositor space.
108+ </description>
109+ <arg name="x" type="int"
110+ summary="x position within the global compositor space"/>
111+ <arg name="y" type="int"
112+ summary="y position within the global compositor space"/>
113+ </event>
114+
115+ <event name="logical_size">
116+ <description summary="size of the output in the global compositor space">
117+ The logical_size event describes the size of the output in the
118+ global compositor space.
119+
120+ Most regular Wayland clients should not pay attention to the
121+ logical size and would rather rely on xdg_shell interfaces.
122+
123+ Some clients such as Xwayland, however, need this to configure
124+ their surfaces in the global compositor space as the compositor
125+ may apply a different scale from what is advertised by the output
126+ scaling property (to achieve fractional scaling, for example).
127+
128+ For example, for a wl_output mode 3840×2160 and a scale factor 2:
129+
130+ - A compositor not scaling the monitor viewport in its compositing space
131+ will advertise a logical size of 3840×2160,
132+
133+ - A compositor scaling the monitor viewport with scale factor 2 will
134+ advertise a logical size of 1920×1080,
135+
136+ - A compositor scaling the monitor viewport using a fractional scale of
137+ 1.5 will advertise a logical size of 2560×1440.
138+
139+ For example, for a wl_output mode 1920×1080 and a 90 degree rotation,
140+ the compositor will advertise a logical size of 1080x1920.
141+
142+ The logical_size event is sent after creating an xdg_output
143+ (see xdg_output_manager.get_xdg_output) and whenever the logical
144+ size of the output changes, either as a result of a change in the
145+ applied scale or because of a change in the corresponding output
146+ mode(see wl_output.mode) or transform (see wl_output.transform).
147+ </description>
148+ <arg name="width" type="int"
149+ summary="width in global compositor space"/>
150+ <arg name="height" type="int"
151+ summary="height in global compositor space"/>
152+ </event>
153+
154+ <event name="done" deprecated-since="3">
155+ <description summary="all information about the output have been sent">
156+ This event is sent after all other properties of an xdg_output
157+ have been sent.
158+
159+ This allows changes to the xdg_output properties to be seen as
160+ atomic, even if they happen via multiple events.
161+
162+ For objects version 3 onwards, this event is deprecated. Compositors
163+ are not required to send it anymore and must send wl_output.done
164+ instead.
165+ </description>
166+ </event>
167+
168+ <!-- Version 2 additions -->
169+
170+ <event name="name" since="2">
171+ <description summary="name of this output">
172+ Many compositors will assign names to their outputs, show them to the
173+ user, allow them to be configured by name, etc. The client may wish to
174+ know this name as well to offer the user similar behaviors.
175+
176+ The naming convention is compositor defined, but limited to
177+ alphanumeric characters and dashes (-). Each name is unique among all
178+ wl_output globals, but if a wl_output global is destroyed the same name
179+ may be reused later. The names will also remain consistent across
180+ sessions with the same hardware and software configuration.
181+
182+ Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do
183+ not assume that the name is a reflection of an underlying DRM
184+ connector, X11 connection, etc.
185+
186+ The name event is sent after creating an xdg_output (see
187+ xdg_output_manager.get_xdg_output). This event is only sent once per
188+ xdg_output, and the name does not change over the lifetime of the
189+ wl_output global.
190+
191+ This event is deprecated, instead clients should use wl_output.name.
192+ Compositors must still support this event.
193+ </description>
194+ <arg name="name" type="string" summary="output name"/>
195+ </event>
196+
197+ <event name="description" since="2">
198+ <description summary="human-readable description of this output">
199+ Many compositors can produce human-readable descriptions of their
200+ outputs. The client may wish to know this description as well, to
201+ communicate the user for various purposes.
202+
203+ The description is a UTF-8 string with no convention defined for its
204+ contents. Examples might include 'Foocorp 11" Display' or 'Virtual X11
205+ output via :1'.
206+
207+ The description event is sent after creating an xdg_output (see
208+ xdg_output_manager.get_xdg_output) and whenever the description
209+ changes. The description is optional, and may not be sent at all.
210+
211+ For objects of version 2 and lower, this event is only sent once per
212+ xdg_output, and the description does not change over the lifetime of
213+ the wl_output global.
214+
215+ This event is deprecated, instead clients should use
216+ wl_output.description. Compositors must still support this event.
217+ </description>
218+ <arg name="description" type="string" summary="output description"/>
219+ </event>
220+
221+ </interface>
222+</protocol>

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 1

Tags 14

↑↓ moveenter openesc close