Mention alpha for matrix transformation background color.

PiperOrigin-RevId: 453633920
androidx · Jun 9, 2022 · cdb8038 · cdb8038
1 parent 457f446
commit cdb8038
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 5 deletions.
diff --git a/libraries/transformer/src/main/java/androidx/media3/transformer/GlMatrixTransformation.java b/libraries/transformer/src/main/java/androidx/media3/transformer/GlMatrixTransformation.java
@@ -28,7 +28,8 @@
  * axes). Transformed pixels that are moved outside of the normal device coordinate range are
  * clipped.
  *
- * <p>Output frame pixels outside of the transformed input frame will be black.
+ * <p>Output frame pixels outside of the transformed input frame will be black, with alpha = 0 if
+ * applicable.
  */
 @UnstableApi
 public interface GlMatrixTransformation extends GlEffect {

diff --git a/libraries/transformer/src/main/java/androidx/media3/transformer/MatrixTransformation.java b/libraries/transformer/src/main/java/androidx/media3/transformer/MatrixTransformation.java
@@ -25,7 +25,8 @@
  * axes). Transformed pixels that are moved outside of the normal device coordinate range are
  * clipped.
  *
- * <p>Output frame pixels outside of the transformed input frame will be black.
+ * <p>Output frame pixels outside of the transformed input frame will be black, with alpha = 0 if
+ * applicable.
  */
 @UnstableApi
 public interface MatrixTransformation extends GlMatrixTransformation {

diff --git a/.../transformer/src/main/java/androidx/media3/transformer/MatrixTransformationProcessor.java b/.../transformer/src/main/java/androidx/media3/transformer/MatrixTransformationProcessor.java
@@ -37,7 +37,7 @@
  * Transformed vertices that are moved outside of this range after any of the transformation
  * matrices are clipped to the NDC range.
  *
- * <p>The background color of the output frame will be black.
+ * <p>The background color of the output frame will be (r=0, g=0, b=0, a=0).
  */
 @UnstableApi
 @SuppressWarnings("FunctionalInterfaceClash") // b/228192298

diff --git a/libraries/transformer/src/main/java/androidx/media3/transformer/Presentation.java b/libraries/transformer/src/main/java/androidx/media3/transformer/Presentation.java
@@ -40,7 +40,7 @@
  *
  * <p>Cropping or aspect ratio is applied before setting resolution.
  *
- * <p>The background color of the output frame will be black.
+ * <p>The background color of the output frame will be black, with alpha = 0 if applicable.
  */
 @UnstableApi
 public final class Presentation implements MatrixTransformation {

diff --git a/...aries/transformer/src/main/java/androidx/media3/transformer/ScaleToFitTransformation.java b/...aries/transformer/src/main/java/androidx/media3/transformer/ScaleToFitTransformation.java
@@ -32,7 +32,7 @@
  * <p>All input frames' pixels will be preserved and copied into an output frame, potentially
  * changing the width and height of the frame by scaling dimensions to fit.
  *
- * <p>The background color of the output frame will be black.
+ * <p>The background color of the output frame will be black, with alpha = 0 if applicable.
  */
 @UnstableApi
 public final class ScaleToFitTransformation implements MatrixTransformation {