Package io.github.humbleui.skija

Enum AnimationDisposalMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AnimationDisposalMode>
    public enum AnimationDisposalMode
extends java.lang.Enum<AnimationDisposalMode>

    This specifies how the next frame is based on this frame.

    Names are based on the GIF 89a spec.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      _UNUSED  
      KEEP
      The next frame should be drawn on top of this one.
      RESTORE_BG_COLOR
      Similar to KEEP, except the area inside this frame's rectangle should be cleared to the BackGround color (transparent) before drawing the next frame.
      RESTORE_PREVIOUS
      The next frame should be drawn on top of the previous frame - i.e.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static AnimationDisposalMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AnimationDisposalMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • KEEP

        public static final AnimationDisposalMode KEEP

        The next frame should be drawn on top of this one.

        In a GIF, a value of 0 (not specified) is also treated as KEEP.

      • RESTORE_BG_COLOR

        public static final AnimationDisposalMode RESTORE_BG_COLOR

        Similar to KEEP, except the area inside this frame's rectangle should be cleared to the BackGround color (transparent) before drawing the next frame.

      • RESTORE_PREVIOUS

        public static final AnimationDisposalMode RESTORE_PREVIOUS

        The next frame should be drawn on top of the previous frame - i.e. disregarding this one.

        In a GIF, a value of 4 is also treated as RestorePrevious.

    • Method Detail

      • values

        public static AnimationDisposalMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AnimationDisposalMode c : AnimationDisposalMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AnimationDisposalMode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null