From c5124a1daf92206644ae751521ef4e0128336f6c Mon Sep 17 00:00:00 2001
From: Vlad Zahorodnii <vlad.zahorodnii@kde.org>
Date: Fri, 15 Dec 2023 11:39:22 +0200
Subject: [PATCH] core: Document what each OutputTransform does

Flipped transforms are very confusing because the order of mirroring and
rotatation transforms matters in some cases.
---
 src/core/output.h | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)

diff --git a/src/core/output.h b/src/core/output.h
index 5137b4f939..8e0bb23fca 100644
--- a/src/core/output.h
+++ b/src/core/output.h
@@ -40,20 +40,19 @@ enum class ContentType {
 
 /**
  * The OutputTransform type is used to describe the transform applied to the output content.
- * Rotation is clockwise.
  */
 class KWIN_EXPORT OutputTransform
 {
 public:
     enum Kind {
-        Normal,
-        Rotated90,
-        Rotated180,
-        Rotated270,
-        Flipped,
-        Flipped90,
-        Flipped180,
-        Flipped270
+        Normal, // no rotation
+        Rotated90, // rotate 90 degrees clockwise
+        Rotated180, // rotate 180 degrees clockwise
+        Rotated270, // rotate 270 degrees clockwise
+        Flipped, // mirror horizontally
+        Flipped90, // rotate 90 degrees clockwise, then mirror horizontally
+        Flipped180, // rotate 180 degrees clockwise, then mirror horizontally
+        Flipped270, // rotate 270 degrees clockwise, then mirror horizontally
     };
 
     OutputTransform() = default;