Enum Class VipsBlendMode

java.lang.Object
java.lang.Enum<VipsBlendMode>
app.photofox.vipsffm.enums.VipsBlendMode
All Implemented Interfaces:
VEnum, VNamedEnum, Serializable, Comparable<VipsBlendMode>, Constable
public enum VipsBlendMode extends Enum<VipsBlendMode> implements VNamedEnum

The various Porter-Duff and PDF blend modes. See VImage.composite(java.util.List<app.photofox.vipsffm.VImage>, java.util.List<java.lang.Integer>, app.photofox.vipsffm.VipsOption...), for example.

The Cairo docs have a nice explanation of all the blend modes:

https://www.cairographics.org/operators

The non-separable modes are not implemented.

  • Enum Constant Details

    • BLEND_MODE_CLEAR

      public static final VipsBlendMode BLEND_MODE_CLEAR

      where the second object is drawn, the first is removed

    • BLEND_MODE_SOURCE

      public static final VipsBlendMode BLEND_MODE_SOURCE

      the second object is drawn as if nothing were below

    • BLEND_MODE_OVER

      public static final VipsBlendMode BLEND_MODE_OVER

      the image shows what you would expect if you held two semi-transparent slides on top of each other

    • BLEND_MODE_IN

      public static final VipsBlendMode BLEND_MODE_IN

      the first object is removed completely, the second is only drawn where the first was

    • BLEND_MODE_OUT

      public static final VipsBlendMode BLEND_MODE_OUT

      the second is drawn only where the first isn't

    • BLEND_MODE_ATOP

      public static final VipsBlendMode BLEND_MODE_ATOP

      this leaves the first object mostly intact, but mixes both objects in the overlapping area

    • BLEND_MODE_DEST

      public static final VipsBlendMode BLEND_MODE_DEST

      leaves the first object untouched, the second is discarded completely

    • BLEND_MODE_DEST_OVER

      public static final VipsBlendMode BLEND_MODE_DEST_OVER

      like OVER, but swaps the arguments

    • BLEND_MODE_DEST_IN

      public static final VipsBlendMode BLEND_MODE_DEST_IN

      like IN, but swaps the arguments

    • BLEND_MODE_DEST_OUT

      public static final VipsBlendMode BLEND_MODE_DEST_OUT

      like OUT, but swaps the arguments

    • BLEND_MODE_DEST_ATOP

      public static final VipsBlendMode BLEND_MODE_DEST_ATOP

      like ATOP, but swaps the arguments

    • BLEND_MODE_XOR

      public static final VipsBlendMode BLEND_MODE_XOR

      something like a difference operator

    • BLEND_MODE_ADD

      public static final VipsBlendMode BLEND_MODE_ADD

      a bit like adding the two images

    • BLEND_MODE_SATURATE

      public static final VipsBlendMode BLEND_MODE_SATURATE

      a bit like the darker of the two

    • BLEND_MODE_MULTIPLY

      public static final VipsBlendMode BLEND_MODE_MULTIPLY

      at least as dark as the darker of the two inputs

    • BLEND_MODE_SCREEN

      public static final VipsBlendMode BLEND_MODE_SCREEN

      at least as light as the lighter of the inputs

    • BLEND_MODE_OVERLAY

      public static final VipsBlendMode BLEND_MODE_OVERLAY

      multiplies or screens colors, depending on the lightness

    • BLEND_MODE_DARKEN

      public static final VipsBlendMode BLEND_MODE_DARKEN

      the darker of each component

    • BLEND_MODE_LIGHTEN

      public static final VipsBlendMode BLEND_MODE_LIGHTEN

      the lighter of each component

    • BLEND_MODE_COLOUR_DODGE

      public static final VipsBlendMode BLEND_MODE_COLOUR_DODGE

      brighten first by a factor second

    • BLEND_MODE_COLOUR_BURN

      public static final VipsBlendMode BLEND_MODE_COLOUR_BURN

      darken first by a factor of second

    • BLEND_MODE_HARD_LIGHT

      public static final VipsBlendMode BLEND_MODE_HARD_LIGHT

      multiply or screen, depending on lightness

    • BLEND_MODE_SOFT_LIGHT

      public static final VipsBlendMode BLEND_MODE_SOFT_LIGHT

      darken or lighten, depending on lightness

    • BLEND_MODE_DIFFERENCE

      public static final VipsBlendMode BLEND_MODE_DIFFERENCE

      difference of the two

    • BLEND_MODE_EXCLUSION

      public static final VipsBlendMode BLEND_MODE_EXCLUSION

      somewhat like DIFFERENCE, but lower-contrast

    • BLEND_MODE_LAST

      public static final VipsBlendMode BLEND_MODE_LAST

  • Field Details

  • Method Details

    • values

      public static VipsBlendMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static VipsBlendMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()
      Specified by:
      getName in interface VNamedEnum

    • getNickname

      public String getNickname()
      Specified by:
      getNickname in interface VNamedEnum

    • getRawValue

      public int getRawValue()
      Specified by:
      getRawValue in interface VEnum