public abstract class

SingleFrameGlShaderProgram

extends BaseGlShaderProgram

 java.lang.Object

androidx.media3.effect.BaseGlShaderProgram

↳androidx.media3.effect.SingleFrameGlShaderProgram

Gradle dependencies

compile group: 'androidx.media3', name: 'media3-effect', version: '1.5.0-alpha01'

  • groupId: androidx.media3
  • artifactId: media3-effect
  • version: 1.5.0-alpha01

Artifact androidx.media3:media3-effect:1.5.0-alpha01 it located at Google repository (https://maven.google.com/)

Overview

Manages a GLSL shader program for processing a frame. Implementations generally copy input pixels into an output frame, with changes to pixels specific to the implementation.

SingleFrameGlShaderProgram implementations must produce exactly one output frame per input frame with the same presentation timestamp. For more flexibility, implement GlShaderProgram directly.

All methods in this class must be called on the thread that owns the OpenGL context.

Summary

Fields
from BaseGlShaderProgramoutputTexturePool
Constructors
publicSingleFrameGlShaderProgram(boolean useHighPrecisionColorComponents)

Creates a SingleFrameGlShaderProgram instance.

Methods
from BaseGlShaderProgramconfigure, drawFrame, flush, getInputListener, getOutputListener, onError, queueInputFrame, release, releaseOutputFrame, setErrorListener, setInputListener, setOutputListener, shouldClearTextureBuffer, signalEndOfCurrentInputStream
from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public SingleFrameGlShaderProgram(boolean useHighPrecisionColorComponents)

Creates a SingleFrameGlShaderProgram instance.

Parameters:

useHighPrecisionColorComponents: If false, uses colors with 8-bit unsigned bytes. If true, use 16-bit (half-precision) floating-point.

Source

/*
 * Copyright 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package androidx.media3.effect;

import androidx.media3.common.util.UnstableApi;

/**
 * Manages a GLSL shader program for processing a frame. Implementations generally copy input pixels
 * into an output frame, with changes to pixels specific to the implementation.
 *
 * <p>{@code SingleFrameGlShaderProgram} implementations must produce exactly one output frame per
 * input frame with the same presentation timestamp. For more flexibility, implement {@link
 * GlShaderProgram} directly.
 *
 * <p>All methods in this class must be called on the thread that owns the OpenGL context.
 *
 * @deprecated Use {@link BaseGlShaderProgram} instead.
 */
@UnstableApi
@Deprecated
public abstract class SingleFrameGlShaderProgram extends BaseGlShaderProgram {

  // TODO(b/275384398): Remove this class as it only wraps the BaseGlShaderProgram.

  /**
   * Creates a {@code SingleFrameGlShaderProgram} instance.
   *
   * @param useHighPrecisionColorComponents If {@code false}, uses colors with 8-bit unsigned bytes.
   *     If {@code true}, use 16-bit (half-precision) floating-point.
   */
  public SingleFrameGlShaderProgram(boolean useHighPrecisionColorComponents) {
    super(useHighPrecisionColorComponents, /* texturePoolCapacity= */ 1);
  }
}