Package 

Interface Overlay

  • 
public interface Overlay

    Base interface for overlays.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public enum Overlay.Target

    • Method Summary

      Modifier and Type Method Description
      abstract void drawOn(@NonNull() Overlay.Target target, @NonNull() Canvas canvas) Called for this overlay to draw itself on the specified target and canvas.
      abstract boolean drawsOn(@NonNull() Overlay.Target target) Called to understand if this overlay would like to draw onto the giventarget or not.
      abstract void setHardwareCanvasEnabled(boolean on) Sets the overlay renderer to lock and capture the hardware canvas in orderto capture hardware accelerated views such as video players
      abstract boolean getHardwareCanvasEnabled() Returns true if hardware canvas capture is enabled, false by default

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • drawOn

         abstract void drawOn(@NonNull() Overlay.Target target, @NonNull() Canvas canvas)

        Called for this overlay to draw itself on the specified target and canvas.

        Parameters:
        target - target
        canvas - target canvas

      • drawsOn

         abstract boolean drawsOn(@NonNull() Overlay.Target target)

        Called to understand if this overlay would like to draw onto the giventarget or not. If true is returned, drawOn can becalled at a future time.

        Parameters:
        target - the target

      • setHardwareCanvasEnabled

         abstract void setHardwareCanvasEnabled(boolean on)

        Sets the overlay renderer to lock and capture the hardware canvas in orderto capture hardware accelerated views such as video players

        Parameters:
        on - enabled

      • getHardwareCanvasEnabled

         abstract boolean getHardwareCanvasEnabled()

        Returns true if hardware canvas capture is enabled, false by default