From 5f5bc79d860907c0eea5123c9bbcb0799d3586ad Mon Sep 17 00:00:00 2001 From: gered Date: Sun, 5 Jun 2022 13:01:10 -0400 Subject: [PATCH] doc comment update for clarification --- libretrogd/src/graphics/bitmap/blit.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/libretrogd/src/graphics/bitmap/blit.rs b/libretrogd/src/graphics/bitmap/blit.rs index ab246c1..40563d6 100644 --- a/libretrogd/src/graphics/bitmap/blit.rs +++ b/libretrogd/src/graphics/bitmap/blit.rs @@ -43,7 +43,8 @@ pub enum BlitMethod { offset: u8, }, /// Same as [BlitMethod::Transparent] except that the drawn pixels have their color indices - /// offset by the amount given. + /// offset by the amount given. The transparent color check is not affected by the offset and + /// is always treated as an absolute palette color index. TransparentOffset { transparent_color: u8, offset: u8 }, /// Combination of [BlitMethod::TransparentFlipped] and [BlitMethod::TransparentOffset]. TransparentFlippedOffset { @@ -75,7 +76,8 @@ pub enum BlitMethod { offset: u8, }, /// Same as [BlitMethod::RotoZoomTransparent] except that the drawn pixels have their color - /// indices offset by the amount given. + /// indices offset by the amount given. The transparent color check is not affected by the + /// offset and is always treated as an absolute palette color index. RotoZoomTransparentOffset { angle: f32, scale_x: f32,