Merge pull request #69 from awxkee/dev

Doc refactor
awxkee · Feb 11, 2025 · 1744931 · 1744931
2 parents 8f02dfd + ff5fb69
commit 1744931
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 37 deletions.
diff --git a/src/rdp.rs b/src/rdp.rs
@@ -403,7 +403,8 @@ fn rdp_yuv_to_rgb<const ORIGIN_CHANNELS: u8>(
 }
 
 macro_rules! d_backward {
-    ($method: ident, $cn: expr, $name: ident, $stride_name: ident) => {
+    ($method: ident, $cn: expr, $name: ident, $stride_name: ident, $px_name: expr) => {
+        #[doc = concat!("Converts RemoteFX YUV 4:4:4 to ", $px_name, "with 8 bit-depth precision.")]
         pub fn $method(
             planar_image: &YuvPlanarImage<i16>,
             $name: &mut [u8],
@@ -414,12 +415,36 @@ macro_rules! d_backward {
     };
 }
 
-d_backward!(rdp_yuv444_to_rgb, RdpChannels::Rgb, rgb, rgb_stride);
-d_backward!(rdp_yuv444_to_rgba, RdpChannels::Rgba, rgba, rgba_stride);
-d_backward!(rdp_yuv444_to_bgra, RdpChannels::Bgra, bgra, bgra_stride);
-d_backward!(rdp_yuv444_to_abgr, RdpChannels::Abgr, abgr, abgr_stride);
-d_backward!(rdp_yuv444_to_bgr, RdpChannels::Bgr, bgr, bgr_stride);
-d_backward!(rdp_yuv444_to_argb, RdpChannels::Argb, argb, argb_stride);
+d_backward!(rdp_yuv444_to_rgb, RdpChannels::Rgb, rgb, rgb_stride, "RGB");
+d_backward!(
+    rdp_yuv444_to_rgba,
+    RdpChannels::Rgba,
+    rgba,
+    rgba_stride,
+    "RGBA"
+);
+d_backward!(
+    rdp_yuv444_to_bgra,
+    RdpChannels::Bgra,
+    bgra,
+    bgra_stride,
+    "BGRA"
+);
+d_backward!(
+    rdp_yuv444_to_abgr,
+    RdpChannels::Abgr,
+    abgr,
+    abgr_stride,
+    "ABGR"
+);
+d_backward!(rdp_yuv444_to_bgr, RdpChannels::Bgr, bgr, bgr_stride, "BGR");
+d_backward!(
+    rdp_yuv444_to_argb,
+    RdpChannels::Argb,
+    argb,
+    argb_stride,
+    "ARGB"
+);
 
 #[cfg(test)]
 mod tests {

diff --git a/src/yuv_p16_rgba16_alpha.rs b/src/yuv_p16_rgba16_alpha.rs
@@ -489,7 +489,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv420,
     YuvEndianness::LittleEndian,
-    "AYUV 420P10",
+    "YUVA 420P10",
     "RGBA",
     "rgba",
     10
@@ -500,7 +500,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv420,
     YuvEndianness::BigEndian,
-    "AYUV 420P10 BE",
+    "YUVA 420P10 BE",
     "RGBA",
     "rgba",
     10
@@ -511,7 +511,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv422,
     YuvEndianness::LittleEndian,
-    "AYUV 422P10",
+    "YUVA 422P10",
     "RGBA",
     "rgba",
     10
@@ -522,7 +522,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv422,
     YuvEndianness::LittleEndian,
-    "AYUV 422P10 BE",
+    "YUVA 422P10 BE",
     "RGBA",
     "rgba",
     10
@@ -532,7 +532,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv444,
     YuvEndianness::LittleEndian,
-    "AYUV 444P10",
+    "YUVA 444P10",
     "RGBA",
     "rgba",
     10
@@ -543,7 +543,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv444,
     YuvEndianness::BigEndian,
-    "AYUV 444P10 BE",
+    "YUVA 444P10 BE",
     "RGBA",
     "rgba",
     10
@@ -554,7 +554,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv420,
     YuvEndianness::LittleEndian,
-    "AYUV 420P12",
+    "YUVA 420P12",
     "RGBA",
     "rgba",
     12
@@ -565,7 +565,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv420,
     YuvEndianness::BigEndian,
-    "AYUV 420P12 BE",
+    "YUVA 420P12 BE",
     "RGBA",
     "rgba",
     12
@@ -575,7 +575,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv420,
     YuvEndianness::LittleEndian,
-    "AYUV 420P14",
+    "YUVA 420P14",
     "RGBA",
     "rgba",
     14
@@ -586,7 +586,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv420,
     YuvEndianness::BigEndian,
-    "AYUV 420P14 BE",
+    "YUVA 420P14 BE",
     "RGBA",
     "rgba",
     14
@@ -597,7 +597,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv422,
     YuvEndianness::LittleEndian,
-    "AYUV 422P12",
+    "YUVA 422P12",
     "RGBA",
     "rgba",
     12
@@ -608,7 +608,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv422,
     YuvEndianness::LittleEndian,
-    "AYUV 422P12 BE",
+    "YUVA 422P12 BE",
     "RGBA",
     "rgba",
     12
@@ -618,7 +618,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv422,
     YuvEndianness::LittleEndian,
-    "AYUV 422P14",
+    "YUVA 422P14",
     "RGBA",
     "rgba",
     14
@@ -629,7 +629,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv422,
     YuvEndianness::LittleEndian,
-    "AYUV 422P14 BE",
+    "YUVA 422P14 BE",
     "RGBA",
     "rgba",
     14
@@ -640,7 +640,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv444,
     YuvEndianness::LittleEndian,
-    "AYUV 444P12",
+    "YUVA 444P12",
     "RGBA",
     "rgba",
     12
@@ -651,7 +651,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv444,
     YuvEndianness::BigEndian,
-    "AYUV 444P12 BE",
+    "YUVA 444P12 BE",
     "RGBA",
     "rgba",
     12
@@ -661,7 +661,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv444,
     YuvEndianness::LittleEndian,
-    "AYUV 444P14",
+    "YUVA 444P14",
     "RGBA",
     "rgba",
     14
@@ -672,7 +672,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv444,
     YuvEndianness::BigEndian,
-    "AYUV 444P14 BE",
+    "YUVA 444P14 BE",
     "RGBA",
     "rgba",
     14

diff --git a/src/yuv_p16_rgba_alpha.rs b/src/yuv_p16_rgba_alpha.rs
@@ -461,7 +461,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv420,
     YuvEndianness::LittleEndian,
-    "AYUV 420P10",
+    "YUVA 420P10",
     "RGBA",
     "rgba",
     10
@@ -472,7 +472,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv420,
     YuvEndianness::BigEndian,
-    "AYUV 420P10 BE",
+    "YUVA 420P10 BE",
     "RGBA",
     "rgba",
     10
@@ -483,7 +483,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv422,
     YuvEndianness::LittleEndian,
-    "AYUV 422P10",
+    "YUVA 422P10",
     "RGBA",
     "rgba",
     10
@@ -494,7 +494,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv422,
     YuvEndianness::BigEndian,
-    "AYUV 422P10 BE",
+    "YUVA 422P10 BE",
     "RGBA",
     "rgba",
     10
@@ -504,7 +504,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv444,
     YuvEndianness::LittleEndian,
-    "AYUV 444P10",
+    "YUVA 444P10",
     "RGBA",
     "rgba",
     10
@@ -515,7 +515,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv444,
     YuvEndianness::BigEndian,
-    "AYUV 444P10 BE",
+    "YUVA 444P10 BE",
     "RGBA",
     "rgba",
     10
@@ -526,7 +526,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv420,
     YuvEndianness::LittleEndian,
-    "AYUV 420P12",
+    "YUVA 420P12",
     "RGBA",
     "rgba",
     12
@@ -537,7 +537,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv420,
     YuvEndianness::BigEndian,
-    "AYUV 420P12 BE",
+    "YUVA 420P12 BE",
     "RGBA",
     "rgba",
     12
@@ -547,7 +547,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv422,
     YuvEndianness::LittleEndian,
-    "AYUV 422P12",
+    "YUVA 422P12",
     "RGBA",
     "rgba",
     12
@@ -558,7 +558,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv422,
     YuvEndianness::BigEndian,
-    "AYUV 422P12 BE",
+    "YUVA 422P12 BE",
     "RGBA",
     "rgba",
     12
@@ -568,7 +568,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv444,
     YuvEndianness::LittleEndian,
-    "AYUV 444P12",
+    "YUVA 444P12",
     "RGBA",
     "rgba",
     12
@@ -579,7 +579,7 @@ d_cnv!(
     YuvSourceChannels::Rgba,
     YuvChromaSubsampling::Yuv444,
     YuvEndianness::BigEndian,
-    "AYUV 444P12 BE",
+    "YUVA 444P12 BE",
     "RGBA",
     "rgba",
     12