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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
//! presentation time feedback event
//!
//! A presentation_feedback object returns an indication that a
//! wl_surface content update has become visible to the user.
//! One object corresponds to one content update submission
//! (wl_surface.commit). There are two possible outcomes: the
//! content update is presented to the user, and a presentation
//! timestamp delivered; or, the user did not see the content
//! update because it was superseded or its surface destroyed,
//! and the content update is discarded.
//!
//! Once a presentation_feedback object has delivered a 'presented'
//! or 'discarded' event it is automatically destroyed.
use crate::protocol_helpers::prelude::*;
use super::super::all_types::*;
/// A wp_presentation_feedback object.
///
/// See the documentation of [the module][self] for the interface description.
pub struct WpPresentationFeedback {
core: ObjectCore,
handler: HandlerHolder<dyn WpPresentationFeedbackHandler>,
}
struct DefaultHandler;
impl WpPresentationFeedbackHandler for DefaultHandler { }
impl ConcreteObject for WpPresentationFeedback {
const XML_VERSION: u32 = 2;
const INTERFACE: ObjectInterface = ObjectInterface::WpPresentationFeedback;
const INTERFACE_NAME: &str = "wp_presentation_feedback";
}
impl WpPresentationFeedback {
/// Sets a new handler.
pub fn set_handler(&self, handler: impl WpPresentationFeedbackHandler) {
self.set_boxed_handler(Box::new(handler));
}
/// Sets a new, already boxed handler.
pub fn set_boxed_handler(&self, handler: Box<dyn WpPresentationFeedbackHandler>) {
if self.core.state.destroyed.get() {
return;
}
self.handler.set(Some(handler));
}
}
impl Debug for WpPresentationFeedback {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("WpPresentationFeedback")
.field("server_obj_id", &self.core.server_obj_id.get())
.field("client_id", &self.core.client_id.get())
.field("client_obj_id", &self.core.client_obj_id.get())
.finish()
}
}
impl WpPresentationFeedback {
/// Since when the sync_output message is available.
pub const MSG__SYNC_OUTPUT__SINCE: u32 = 1;
/// presentation synchronized to this output
///
/// As presentation can be synchronized to only one output at a
/// time, this event tells which output it was. This event is only
/// sent prior to the presented event.
///
/// As clients may bind to the same global wl_output multiple
/// times, this event is sent for each bound instance that matches
/// the synchronized output. If a client has not bound to the
/// right wl_output global at all, this event is not sent.
///
/// # Arguments
///
/// - `output`: presentation output
#[inline]
pub fn try_send_sync_output(
&self,
output: &Rc<WlOutput>,
) -> Result<(), ObjectError> {
let (
arg0,
) = (
output,
);
let arg0 = arg0.core();
let core = self.core();
let client_ref = core.client.borrow();
let Some(client) = &*client_ref else {
return Err(ObjectError(ObjectErrorKind::ReceiverNoClient));
};
let id = core.client_obj_id.get().unwrap_or(0);
if arg0.client_id.get() != Some(client.endpoint.id) {
return Err(ObjectError(ObjectErrorKind::ArgNoClientId("output", client.endpoint.id)));
}
let arg0_id = arg0.client_obj_id.get().unwrap_or(0);
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, client_id: u64, id: u32, arg0: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} <= wp_presentation_feedback#{}.sync_output(output: wl_output#{})\n", client_id, id, arg0);
state.log(args);
}
log(&self.core.state, client.endpoint.id, id, arg0_id);
}
let endpoint = &client.endpoint;
if !endpoint.flush_queued.replace(true) {
self.core.state.add_flushable_endpoint(endpoint, Some(client));
}
let mut outgoing_ref = endpoint.outgoing.borrow_mut();
let outgoing = &mut *outgoing_ref;
let mut fmt = outgoing.formatter();
fmt.words([
id,
0,
arg0_id,
]);
Ok(())
}
/// presentation synchronized to this output
///
/// As presentation can be synchronized to only one output at a
/// time, this event tells which output it was. This event is only
/// sent prior to the presented event.
///
/// As clients may bind to the same global wl_output multiple
/// times, this event is sent for each bound instance that matches
/// the synchronized output. If a client has not bound to the
/// right wl_output global at all, this event is not sent.
///
/// # Arguments
///
/// - `output`: presentation output
#[inline]
pub fn send_sync_output(
&self,
output: &Rc<WlOutput>,
) {
let res = self.try_send_sync_output(
output,
);
if let Err(e) = res {
log_send("wp_presentation_feedback.sync_output", &e);
}
}
/// Since when the presented message is available.
pub const MSG__PRESENTED__SINCE: u32 = 1;
/// the content update was displayed
///
/// The associated content update was displayed to the user at the
/// indicated time (tv_sec_hi/lo, tv_nsec). For the interpretation of
/// the timestamp, see presentation.clock_id event.
///
/// The timestamp corresponds to the time when the content update
/// turned into light the first time on the surface's main output.
/// Compositors may approximate this from the framebuffer flip
/// completion events from the system, and the latency of the
/// physical display path if known.
///
/// This event is preceded by all related sync_output events
/// telling which output's refresh cycle the feedback corresponds
/// to, i.e. the main output for the surface. Compositors are
/// recommended to choose the output containing the largest part
/// of the wl_surface, or keeping the output they previously
/// chose. Having a stable presentation output association helps
/// clients predict future output refreshes (vblank).
///
/// The 'refresh' argument gives the compositor's prediction of how
/// many nanoseconds after tv_sec, tv_nsec the very next output
/// refresh may occur. This is to further aid clients in
/// predicting future refreshes, i.e., estimating the timestamps
/// targeting the next few vblanks. If such prediction cannot
/// usefully be done, the argument is zero.
///
/// For version 2 and later, if the output does not have a constant
/// refresh rate, explicit video mode switches excluded, then the
/// refresh argument must be either an appropriate rate picked by the
/// compositor (e.g. fastest rate), or 0 if no such rate exists.
/// For version 1, if the output does not have a constant refresh rate,
/// the refresh argument must be zero.
///
/// The 64-bit value combined from seq_hi and seq_lo is the value
/// of the output's vertical retrace counter when the content
/// update was first scanned out to the display. This value must
/// be compatible with the definition of MSC in
/// GLX_OML_sync_control specification. Note, that if the display
/// path has a non-zero latency, the time instant specified by
/// this counter may differ from the timestamp's.
///
/// If the output does not have a concept of vertical retrace or a
/// refresh cycle, or the output device is self-refreshing without
/// a way to query the refresh count, then the arguments seq_hi
/// and seq_lo must be zero.
///
/// # Arguments
///
/// - `tv_sec_hi`: high 32 bits of the seconds part of the presentation timestamp
/// - `tv_sec_lo`: low 32 bits of the seconds part of the presentation timestamp
/// - `tv_nsec`: nanoseconds part of the presentation timestamp
/// - `refresh`: nanoseconds till next refresh
/// - `seq_hi`: high 32 bits of refresh counter
/// - `seq_lo`: low 32 bits of refresh counter
/// - `flags`: combination of 'kind' values
#[inline]
pub fn try_send_presented(
&self,
tv_sec_hi: u32,
tv_sec_lo: u32,
tv_nsec: u32,
refresh: u32,
seq_hi: u32,
seq_lo: u32,
flags: WpPresentationFeedbackKind,
) -> Result<(), ObjectError> {
let (
arg0,
arg1,
arg2,
arg3,
arg4,
arg5,
arg6,
) = (
tv_sec_hi,
tv_sec_lo,
tv_nsec,
refresh,
seq_hi,
seq_lo,
flags,
);
let core = self.core();
let client_ref = core.client.borrow();
let Some(client) = &*client_ref else {
return Err(ObjectError(ObjectErrorKind::ReceiverNoClient));
};
let id = core.client_obj_id.get().unwrap_or(0);
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, client_id: u64, id: u32, arg0: u32, arg1: u32, arg2: u32, arg3: u32, arg4: u32, arg5: u32, arg6: WpPresentationFeedbackKind) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} <= wp_presentation_feedback#{}.presented(tv_sec_hi: {}, tv_sec_lo: {}, tv_nsec: {}, refresh: {}, seq_hi: {}, seq_lo: {}, flags: {:?})\n", client_id, id, arg0, arg1, arg2, arg3, arg4, arg5, arg6);
state.log(args);
}
log(&self.core.state, client.endpoint.id, id, arg0, arg1, arg2, arg3, arg4, arg5, arg6);
}
let endpoint = &client.endpoint;
if !endpoint.flush_queued.replace(true) {
self.core.state.add_flushable_endpoint(endpoint, Some(client));
}
let mut outgoing_ref = endpoint.outgoing.borrow_mut();
let outgoing = &mut *outgoing_ref;
let mut fmt = outgoing.formatter();
fmt.words([
id,
1,
arg0,
arg1,
arg2,
arg3,
arg4,
arg5,
arg6.0,
]);
drop(fmt);
drop(outgoing_ref);
drop(client_ref);
self.core.handle_client_destroy();
Ok(())
}
/// the content update was displayed
///
/// The associated content update was displayed to the user at the
/// indicated time (tv_sec_hi/lo, tv_nsec). For the interpretation of
/// the timestamp, see presentation.clock_id event.
///
/// The timestamp corresponds to the time when the content update
/// turned into light the first time on the surface's main output.
/// Compositors may approximate this from the framebuffer flip
/// completion events from the system, and the latency of the
/// physical display path if known.
///
/// This event is preceded by all related sync_output events
/// telling which output's refresh cycle the feedback corresponds
/// to, i.e. the main output for the surface. Compositors are
/// recommended to choose the output containing the largest part
/// of the wl_surface, or keeping the output they previously
/// chose. Having a stable presentation output association helps
/// clients predict future output refreshes (vblank).
///
/// The 'refresh' argument gives the compositor's prediction of how
/// many nanoseconds after tv_sec, tv_nsec the very next output
/// refresh may occur. This is to further aid clients in
/// predicting future refreshes, i.e., estimating the timestamps
/// targeting the next few vblanks. If such prediction cannot
/// usefully be done, the argument is zero.
///
/// For version 2 and later, if the output does not have a constant
/// refresh rate, explicit video mode switches excluded, then the
/// refresh argument must be either an appropriate rate picked by the
/// compositor (e.g. fastest rate), or 0 if no such rate exists.
/// For version 1, if the output does not have a constant refresh rate,
/// the refresh argument must be zero.
///
/// The 64-bit value combined from seq_hi and seq_lo is the value
/// of the output's vertical retrace counter when the content
/// update was first scanned out to the display. This value must
/// be compatible with the definition of MSC in
/// GLX_OML_sync_control specification. Note, that if the display
/// path has a non-zero latency, the time instant specified by
/// this counter may differ from the timestamp's.
///
/// If the output does not have a concept of vertical retrace or a
/// refresh cycle, or the output device is self-refreshing without
/// a way to query the refresh count, then the arguments seq_hi
/// and seq_lo must be zero.
///
/// # Arguments
///
/// - `tv_sec_hi`: high 32 bits of the seconds part of the presentation timestamp
/// - `tv_sec_lo`: low 32 bits of the seconds part of the presentation timestamp
/// - `tv_nsec`: nanoseconds part of the presentation timestamp
/// - `refresh`: nanoseconds till next refresh
/// - `seq_hi`: high 32 bits of refresh counter
/// - `seq_lo`: low 32 bits of refresh counter
/// - `flags`: combination of 'kind' values
#[inline]
pub fn send_presented(
&self,
tv_sec_hi: u32,
tv_sec_lo: u32,
tv_nsec: u32,
refresh: u32,
seq_hi: u32,
seq_lo: u32,
flags: WpPresentationFeedbackKind,
) {
let res = self.try_send_presented(
tv_sec_hi,
tv_sec_lo,
tv_nsec,
refresh,
seq_hi,
seq_lo,
flags,
);
if let Err(e) = res {
log_send("wp_presentation_feedback.presented", &e);
}
}
/// Since when the discarded message is available.
pub const MSG__DISCARDED__SINCE: u32 = 1;
/// the content update was not displayed
///
/// The content update was never displayed to the user.
#[inline]
pub fn try_send_discarded(
&self,
) -> Result<(), ObjectError> {
let core = self.core();
let client_ref = core.client.borrow();
let Some(client) = &*client_ref else {
return Err(ObjectError(ObjectErrorKind::ReceiverNoClient));
};
let id = core.client_obj_id.get().unwrap_or(0);
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, client_id: u64, id: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}client#{:<4} <= wp_presentation_feedback#{}.discarded()\n", client_id, id);
state.log(args);
}
log(&self.core.state, client.endpoint.id, id);
}
let endpoint = &client.endpoint;
if !endpoint.flush_queued.replace(true) {
self.core.state.add_flushable_endpoint(endpoint, Some(client));
}
let mut outgoing_ref = endpoint.outgoing.borrow_mut();
let outgoing = &mut *outgoing_ref;
let mut fmt = outgoing.formatter();
fmt.words([
id,
2,
]);
drop(fmt);
drop(outgoing_ref);
drop(client_ref);
self.core.handle_client_destroy();
Ok(())
}
/// the content update was not displayed
///
/// The content update was never displayed to the user.
#[inline]
pub fn send_discarded(
&self,
) {
let res = self.try_send_discarded(
);
if let Err(e) = res {
log_send("wp_presentation_feedback.discarded", &e);
}
}
}
/// A message handler for [`WpPresentationFeedback`] proxies.
pub trait WpPresentationFeedbackHandler: Any {
/// Event handler for wl_display.delete_id messages deleting the ID of this object.
///
/// The default handler forwards the event to the client, if any.
#[inline]
fn delete_id(&mut self, slf: &Rc<WpPresentationFeedback>) {
slf.core.delete_id();
}
/// presentation synchronized to this output
///
/// As presentation can be synchronized to only one output at a
/// time, this event tells which output it was. This event is only
/// sent prior to the presented event.
///
/// As clients may bind to the same global wl_output multiple
/// times, this event is sent for each bound instance that matches
/// the synchronized output. If a client has not bound to the
/// right wl_output global at all, this event is not sent.
///
/// # Arguments
///
/// - `output`: presentation output
///
/// All borrowed proxies passed to this function are guaranteed to be
/// immutable and non-null.
#[inline]
fn handle_sync_output(
&mut self,
slf: &Rc<WpPresentationFeedback>,
output: &Rc<WlOutput>,
) {
if !slf.core.forward_to_client.get() {
return;
}
if let Some(client_id) = slf.core.client_id.get() {
if let Some(client_id_2) = output.core().client_id.get() {
if client_id != client_id_2 {
return;
}
}
}
let res = slf.try_send_sync_output(
output,
);
if let Err(e) = res {
log_forward("wp_presentation_feedback.sync_output", &e);
}
}
/// the content update was displayed
///
/// The associated content update was displayed to the user at the
/// indicated time (tv_sec_hi/lo, tv_nsec). For the interpretation of
/// the timestamp, see presentation.clock_id event.
///
/// The timestamp corresponds to the time when the content update
/// turned into light the first time on the surface's main output.
/// Compositors may approximate this from the framebuffer flip
/// completion events from the system, and the latency of the
/// physical display path if known.
///
/// This event is preceded by all related sync_output events
/// telling which output's refresh cycle the feedback corresponds
/// to, i.e. the main output for the surface. Compositors are
/// recommended to choose the output containing the largest part
/// of the wl_surface, or keeping the output they previously
/// chose. Having a stable presentation output association helps
/// clients predict future output refreshes (vblank).
///
/// The 'refresh' argument gives the compositor's prediction of how
/// many nanoseconds after tv_sec, tv_nsec the very next output
/// refresh may occur. This is to further aid clients in
/// predicting future refreshes, i.e., estimating the timestamps
/// targeting the next few vblanks. If such prediction cannot
/// usefully be done, the argument is zero.
///
/// For version 2 and later, if the output does not have a constant
/// refresh rate, explicit video mode switches excluded, then the
/// refresh argument must be either an appropriate rate picked by the
/// compositor (e.g. fastest rate), or 0 if no such rate exists.
/// For version 1, if the output does not have a constant refresh rate,
/// the refresh argument must be zero.
///
/// The 64-bit value combined from seq_hi and seq_lo is the value
/// of the output's vertical retrace counter when the content
/// update was first scanned out to the display. This value must
/// be compatible with the definition of MSC in
/// GLX_OML_sync_control specification. Note, that if the display
/// path has a non-zero latency, the time instant specified by
/// this counter may differ from the timestamp's.
///
/// If the output does not have a concept of vertical retrace or a
/// refresh cycle, or the output device is self-refreshing without
/// a way to query the refresh count, then the arguments seq_hi
/// and seq_lo must be zero.
///
/// # Arguments
///
/// - `tv_sec_hi`: high 32 bits of the seconds part of the presentation timestamp
/// - `tv_sec_lo`: low 32 bits of the seconds part of the presentation timestamp
/// - `tv_nsec`: nanoseconds part of the presentation timestamp
/// - `refresh`: nanoseconds till next refresh
/// - `seq_hi`: high 32 bits of refresh counter
/// - `seq_lo`: low 32 bits of refresh counter
/// - `flags`: combination of 'kind' values
#[inline]
fn handle_presented(
&mut self,
slf: &Rc<WpPresentationFeedback>,
tv_sec_hi: u32,
tv_sec_lo: u32,
tv_nsec: u32,
refresh: u32,
seq_hi: u32,
seq_lo: u32,
flags: WpPresentationFeedbackKind,
) {
if !slf.core.forward_to_client.get() {
return;
}
let res = slf.try_send_presented(
tv_sec_hi,
tv_sec_lo,
tv_nsec,
refresh,
seq_hi,
seq_lo,
flags,
);
if let Err(e) = res {
log_forward("wp_presentation_feedback.presented", &e);
}
}
/// the content update was not displayed
///
/// The content update was never displayed to the user.
#[inline]
fn handle_discarded(
&mut self,
slf: &Rc<WpPresentationFeedback>,
) {
if !slf.core.forward_to_client.get() {
return;
}
let res = slf.try_send_discarded(
);
if let Err(e) = res {
log_forward("wp_presentation_feedback.discarded", &e);
}
}
}
impl ObjectPrivate for WpPresentationFeedback {
fn new(state: &Rc<State>, version: u32) -> Rc<Self> {
Rc::<Self>::new_cyclic(|slf| Self {
core: ObjectCore::new(state, slf.clone(), ObjectInterface::WpPresentationFeedback, version),
handler: Default::default(),
})
}
fn delete_id(self: Rc<Self>) -> Result<(), (ObjectError, Rc<dyn Object>)> {
let Some(mut handler) = self.handler.try_borrow_mut() else {
return Err((ObjectError(ObjectErrorKind::HandlerBorrowed), self));
};
if let Some(handler) = &mut *handler {
handler.delete_id(&self);
} else {
self.core.delete_id();
}
Ok(())
}
fn handle_request(self: Rc<Self>, client: &Rc<Client>, msg: &[u32], fds: &mut VecDeque<Rc<OwnedFd>>) -> Result<(), ObjectError> {
let Some(mut handler) = self.handler.try_borrow_mut() else {
return Err(ObjectError(ObjectErrorKind::HandlerBorrowed));
};
let handler = &mut *handler;
match msg[1] & 0xffff {
n => {
let _ = client;
let _ = msg;
let _ = fds;
let _ = handler;
return Err(ObjectError(ObjectErrorKind::UnknownMessageId(n)));
}
}
}
fn handle_event(self: Rc<Self>, server: &Endpoint, msg: &[u32], fds: &mut VecDeque<Rc<OwnedFd>>) -> Result<(), ObjectError> {
let Some(mut handler) = self.handler.try_borrow_mut() else {
return Err(ObjectError(ObjectErrorKind::HandlerBorrowed));
};
let handler = &mut *handler;
match msg[1] & 0xffff {
0 => {
let [
arg0,
] = msg[2..] else {
return Err(ObjectError(ObjectErrorKind::WrongMessageSize(msg.len() as u32 * 4, 12)));
};
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, id: u32, arg0: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}server -> wp_presentation_feedback#{}.sync_output(output: wl_output#{})\n", id, arg0);
state.log(args);
}
log(&self.core.state, msg[0], arg0);
}
let arg0_id = arg0;
let Some(arg0) = server.lookup(arg0_id) else {
return Err(ObjectError(ObjectErrorKind::NoServerObject(arg0_id)));
};
let Ok(arg0) = (arg0 as Rc<dyn Any>).downcast::<WlOutput>() else {
let o = server.lookup(arg0_id).unwrap();
return Err(ObjectError(ObjectErrorKind::WrongObjectType("output", o.core().interface, ObjectInterface::WlOutput)));
};
let arg0 = &arg0;
if let Some(handler) = handler {
(**handler).handle_sync_output(&self, arg0);
} else {
DefaultHandler.handle_sync_output(&self, arg0);
}
}
1 => {
let [
arg0,
arg1,
arg2,
arg3,
arg4,
arg5,
arg6,
] = msg[2..] else {
return Err(ObjectError(ObjectErrorKind::WrongMessageSize(msg.len() as u32 * 4, 36)));
};
let arg6 = WpPresentationFeedbackKind(arg6);
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, id: u32, arg0: u32, arg1: u32, arg2: u32, arg3: u32, arg4: u32, arg5: u32, arg6: WpPresentationFeedbackKind) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}server -> wp_presentation_feedback#{}.presented(tv_sec_hi: {}, tv_sec_lo: {}, tv_nsec: {}, refresh: {}, seq_hi: {}, seq_lo: {}, flags: {:?})\n", id, arg0, arg1, arg2, arg3, arg4, arg5, arg6);
state.log(args);
}
log(&self.core.state, msg[0], arg0, arg1, arg2, arg3, arg4, arg5, arg6);
}
self.core.handle_server_destroy();
if let Some(handler) = handler {
(**handler).handle_presented(&self, arg0, arg1, arg2, arg3, arg4, arg5, arg6);
} else {
DefaultHandler.handle_presented(&self, arg0, arg1, arg2, arg3, arg4, arg5, arg6);
}
}
2 => {
if msg.len() != 2 {
return Err(ObjectError(ObjectErrorKind::WrongMessageSize(msg.len() as u32 * 4, 8)));
}
#[cfg(feature = "logging")]
if self.core.state.log {
#[cold]
fn log(state: &State, id: u32) {
let (millis, micros) = time_since_epoch();
let prefix = &state.log_prefix;
let args = format_args!("[{millis:7}.{micros:03}] {prefix}server -> wp_presentation_feedback#{}.discarded()\n", id);
state.log(args);
}
log(&self.core.state, msg[0]);
}
self.core.handle_server_destroy();
if let Some(handler) = handler {
(**handler).handle_discarded(&self);
} else {
DefaultHandler.handle_discarded(&self);
}
}
n => {
let _ = server;
let _ = msg;
let _ = fds;
let _ = handler;
return Err(ObjectError(ObjectErrorKind::UnknownMessageId(n)));
}
}
Ok(())
}
fn get_request_name(&self, id: u32) -> Option<&'static str> {
let _ = id;
None
}
fn get_event_name(&self, id: u32) -> Option<&'static str> {
let name = match id {
0 => "sync_output",
1 => "presented",
2 => "discarded",
_ => return None,
};
Some(name)
}
}
impl Object for WpPresentationFeedback {
fn core(&self) -> &ObjectCore {
&self.core
}
fn unset_handler(&self) {
self.handler.set(None);
}
fn get_handler_any_ref(&self) -> Result<HandlerRef<'_, dyn Any>, HandlerAccessError> {
let borrowed = self.handler.try_borrow().ok_or(HandlerAccessError::AlreadyBorrowed)?;
if borrowed.is_none() {
return Err(HandlerAccessError::NoHandler);
}
Ok(HandlerRef::map(borrowed, |handler| &**handler.as_ref().unwrap() as &dyn Any))
}
fn get_handler_any_mut(&self) -> Result<HandlerMut<'_, dyn Any>, HandlerAccessError> {
let borrowed = self.handler.try_borrow_mut().ok_or(HandlerAccessError::AlreadyBorrowed)?;
if borrowed.is_none() {
return Err(HandlerAccessError::NoHandler);
}
Ok(HandlerMut::map(borrowed, |handler| &mut **handler.as_mut().unwrap() as &mut dyn Any))
}
}
impl WpPresentationFeedback {
/// Since when the kind.vsync enum variant is available.
pub const ENM__KIND_VSYNC__SINCE: u32 = 1;
/// Since when the kind.hw_clock enum variant is available.
pub const ENM__KIND_HW_CLOCK__SINCE: u32 = 1;
/// Since when the kind.hw_completion enum variant is available.
pub const ENM__KIND_HW_COMPLETION__SINCE: u32 = 1;
/// Since when the kind.zero_copy enum variant is available.
pub const ENM__KIND_ZERO_COPY__SINCE: u32 = 1;
}
/// bitmask of flags in presented event
///
/// These flags provide information about how the presentation of
/// the related content update was done. The intent is to help
/// clients assess the reliability of the feedback and the visual
/// quality with respect to possible tearing and timings.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[derive(Default)]
pub struct WpPresentationFeedbackKind(pub u32);
/// An iterator over the set bits in a [`WpPresentationFeedbackKind`].
///
/// You can construct this with the `IntoIterator` implementation of `WpPresentationFeedbackKind`.
#[derive(Clone, Debug)]
pub struct WpPresentationFeedbackKindIter(pub u32);
impl WpPresentationFeedbackKind {
/// presentation was vsync'd
///
/// The presentation was synchronized to the "vertical retrace" by
/// the display hardware such that tearing does not happen.
/// Relying on software scheduling is not acceptable for this
/// flag. If presentation is done by a copy to the active
/// frontbuffer, then it must guarantee that tearing cannot
/// happen.
pub const VSYNC: Self = Self(0x1);
/// hardware provided the presentation timestamp
///
/// The display hardware provided measurements that the hardware
/// driver converted into a presentation timestamp. Sampling a
/// clock in software is not acceptable for this flag.
pub const HW_CLOCK: Self = Self(0x2);
/// hardware signalled the start of the presentation
///
/// The display hardware signalled that it started using the new
/// image content. The opposite of this is e.g. a timer being used
/// to guess when the display hardware has switched to the new
/// image content.
pub const HW_COMPLETION: Self = Self(0x4);
/// presentation was done zero-copy
///
/// The presentation of this update was done zero-copy. This means
/// the buffer from the client was given to display hardware as
/// is, without copying it. Compositing with OpenGL counts as
/// copying, even if textured directly from the client buffer.
/// Possible zero-copy cases include direct scanout of a
/// fullscreen surface and a surface on a hardware overlay.
pub const ZERO_COPY: Self = Self(0x8);
}
impl WpPresentationFeedbackKind {
#[inline]
pub const fn empty() -> Self {
Self(0)
}
#[inline]
#[must_use]
pub const fn is_empty(self) -> bool {
self.0 == 0
}
#[inline]
#[must_use]
pub const fn contains(self, other: Self) -> bool {
self.0 & other.0 == other.0
}
#[inline]
#[must_use]
pub const fn intersects(self, other: Self) -> bool {
self.0 & other.0 != 0
}
#[inline]
pub const fn insert(&mut self, other: Self) {
*self = self.union(other);
}
#[inline]
pub const fn remove(&mut self, other: Self) {
*self = self.difference(other);
}
#[inline]
pub const fn toggle(&mut self, other: Self) {
*self = self.symmetric_difference(other);
}
#[inline]
pub const fn set(&mut self, other: Self, value: bool) {
if value {
self.insert(other);
} else {
self.remove(other);
}
}
#[inline]
#[must_use]
pub const fn intersection(self, other: Self) -> Self {
Self(self.0 & other.0)
}
#[inline]
#[must_use]
pub const fn union(self, other: Self) -> Self {
Self(self.0 | other.0)
}
#[inline]
#[must_use]
pub const fn difference(self, other: Self) -> Self {
Self(self.0 & !other.0)
}
#[inline]
#[must_use]
pub const fn complement(self) -> Self {
Self(!self.0)
}
#[inline]
#[must_use]
pub const fn symmetric_difference(self, other: Self) -> Self {
Self(self.0 ^ other.0)
}
#[inline]
pub const fn all_known() -> Self {
#[allow(clippy::eq_op, clippy::identity_op)]
Self(0 | 0x1 | 0x2 | 0x4 | 0x8)
}
}
impl Iterator for WpPresentationFeedbackKindIter {
type Item = WpPresentationFeedbackKind;
fn next(&mut self) -> Option<Self::Item> {
if self.0 == 0 {
return None;
}
let bit = 1 << self.0.trailing_zeros();
self.0 &= !bit;
Some(WpPresentationFeedbackKind(bit))
}
}
impl IntoIterator for WpPresentationFeedbackKind {
type Item = WpPresentationFeedbackKind;
type IntoIter = WpPresentationFeedbackKindIter;
fn into_iter(self) -> Self::IntoIter {
WpPresentationFeedbackKindIter(self.0)
}
}
impl BitAnd for WpPresentationFeedbackKind {
type Output = Self;
fn bitand(self, rhs: Self) -> Self::Output {
self.intersection(rhs)
}
}
impl BitAndAssign for WpPresentationFeedbackKind {
fn bitand_assign(&mut self, rhs: Self) {
*self = self.intersection(rhs);
}
}
impl BitOr for WpPresentationFeedbackKind {
type Output = Self;
fn bitor(self, rhs: Self) -> Self::Output {
self.union(rhs)
}
}
impl BitOrAssign for WpPresentationFeedbackKind {
fn bitor_assign(&mut self, rhs: Self) {
*self = self.union(rhs);
}
}
impl BitXor for WpPresentationFeedbackKind {
type Output = Self;
fn bitxor(self, rhs: Self) -> Self::Output {
self.symmetric_difference(rhs)
}
}
impl BitXorAssign for WpPresentationFeedbackKind {
fn bitxor_assign(&mut self, rhs: Self) {
*self = self.symmetric_difference(rhs);
}
}
impl Sub for WpPresentationFeedbackKind {
type Output = Self;
fn sub(self, rhs: Self) -> Self::Output {
self.difference(rhs)
}
}
impl SubAssign for WpPresentationFeedbackKind {
fn sub_assign(&mut self, rhs: Self) {
*self = self.difference(rhs);
}
}
impl Not for WpPresentationFeedbackKind {
type Output = Self;
fn not(self) -> Self::Output {
self.complement()
}
}
impl Debug for WpPresentationFeedbackKind {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let mut v = self.0;
let mut first = true;
if v & 0x1 == 0x1 {
v &= !0x1;
if first {
first = false;
} else {
f.write_str(" | ")?;
}
f.write_str("VSYNC")?;
}
if v & 0x2 == 0x2 {
v &= !0x2;
if first {
first = false;
} else {
f.write_str(" | ")?;
}
f.write_str("HW_CLOCK")?;
}
if v & 0x4 == 0x4 {
v &= !0x4;
if first {
first = false;
} else {
f.write_str(" | ")?;
}
f.write_str("HW_COMPLETION")?;
}
if v & 0x8 == 0x8 {
v &= !0x8;
if first {
first = false;
} else {
f.write_str(" | ")?;
}
f.write_str("ZERO_COPY")?;
}
if v != 0 {
if first {
first = false;
} else {
f.write_str(" | ")?;
}
write!(f, "0x{v:032x}")?;
}
if first {
f.write_str("0")?;
}
Ok(())
}
}