Update comment to reflect strange aspects of subtitle alignment standards.
authorCarl Hetherington <cth@carlh.net>
Thu, 14 Jul 2022 21:30:47 +0000 (23:30 +0200)
committerCarl Hetherington <cth@carlh.net>
Thu, 14 Jul 2022 21:30:47 +0000 (23:30 +0200)
src/types.h

index 9aacdfdbf0c5f8b41f6ee6c0d2945f1bdc038a8e..b6335546c4f3f9aab291ac6288c60fc548f638e5 100644 (file)
@@ -176,9 +176,21 @@ extern HAlign string_to_halign (std::string s);
 
 enum class VAlign
 {
-       TOP,    ///< vertical position is distance from top of screen to top of subtitle
-       CENTER, ///< vertical position is distance from centre of screen to centre of subtitle
-       BOTTOM  ///< vertical position is distance from bottom of screen to bottom of subtitle
+       /** vertical position is distance:
+        *    from top of screen to top of subtitle (for SMPTE) or
+        *    from top of screen to subtitle baseline (for Interop)
+        */
+       TOP,
+       /** vertical position is distance:
+        *    from centre of screen to centre of subtitle (for SMPTE) or
+        *    from centre of screen to subtitle baseline (for Interop)
+        */
+       CENTER,
+       /** vertical position is distance:
+        *    from bottom of screen to bottom of subtitle (for SMPTE) or
+        *    from bottom of screen to subtitle baseline (for Interop)
+        */
+       BOTTOM
 };