Effect: Clarify GlEffect javadoc exception cause.

PiperOrigin-RevId: 504273335
androidx · Jan 25, 2023 · 301683a · 301683a
1 parent 7fbdbeb
commit 301683a
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/libraries/effect/src/main/java/androidx/media3/effect/GlEffect.java b/libraries/effect/src/main/java/androidx/media3/effect/GlEffect.java
@@ -31,11 +31,13 @@
 public interface GlEffect extends Effect {
 
   /**
-   * Returns a {@link SingleFrameGlTextureProcessor} that applies the effect.
+   * Returns a {@link GlTextureProcessor} that applies the effect.
    *
    * @param context A {@link Context}.
    * @param useHdr Whether input textures come from an HDR source. If {@code true}, colors will be
    *     in linear RGB BT.2020. If {@code false}, colors will be in linear RGB BT.709.
+   * @throws FrameProcessingException If an error occurs while creating the {@link
+   *     GlTextureProcessor}.
    */
   GlTextureProcessor toGlTextureProcessor(Context context, boolean useHdr)
       throws FrameProcessingException;