Enum Class PaintCompositeMode

java.lang.Object
java.lang.Enum<PaintCompositeMode>
org.freedesktop.harfbuzz.PaintCompositeMode
All Implemented Interfaces:
Serializable, Comparable<PaintCompositeMode>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum PaintCompositeMode extends Enum<PaintCompositeMode> implements Enumeration

The values of this enumeration describe the compositing modes that can be used when combining temporary redirected drawing with the backdrop.

See the OpenType spec COLR section for details.

Since:
7.0.0

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CLEAR
    clear destination layer (bounded)
    COLOR_BURN
    darkens the destination color to reflect the source color.
    COLOR_DODGE
    brightens the destination color to reflect the source color.
    DARKEN
    replaces the destination with the source if it is darker, otherwise keeps the source.
    DEST
    ignore the source
    DEST_ATOP
    leave destination on top of source content and only there (unbounded)
    DEST_IN
    leave destination only where there was source content (unbounded)
    DEST_OUT
    leave destination only where there was no source content
    DEST_OVER
    draw destination on top of source
    DIFFERENCE
    Takes the difference of the source and destination color.
    EXCLUSION
    Produces an effect similar to difference, but with lower contrast.
    HARD_LIGHT
    Multiplies or screens, dependent on source color.
    HSL_COLOR
    Creates a color with the hue and saturation of the source and the luminosity of the target.
    HSL_HUE
    Creates a color with the hue of the source and the saturation and luminosity of the target.
    HSL_LUMINOSITY
    Creates a color with the luminosity of the source and the hue and saturation of the target.
    HSL_SATURATION
    Creates a color with the saturation of the source and the hue and luminosity of the target.
    LIGHTEN
    replaces the destination with the source if it is lighter, otherwise keeps the source.
    MULTIPLY
    source and destination layers are multiplied.
    OVERLAY
    multiplies or screens, depending on the lightness of the destination color.
    PLUS
    source and destination layers are accumulated
    SCREEN
    source and destination are complemented and multiplied.
    SOFT_LIGHT
    Darkens or lightens, dependent on source color.
    SRC
    replace destination layer (bounded)
    SRC_ATOP
    draw source on top of destination content and only there
    SRC_IN
    draw source where there was destination content (unbounded)
    SRC_OUT
    draw source where there was no destination content (unbounded)
    SRC_OVER
    draw source layer on top of destination layer (bounded)
    XOR
    source and destination are shown where there is only one of them

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable Type
    getType()
    Get the GType of the PaintCompositeMode class.
    int
    getValue()
    Get the numeric value of this enum
    static PaintCompositeMode
    of(int value)
    Create a new PaintCompositeMode for the provided value
    static PaintCompositeMode
    of(MemorySegment address)
    Create a new PaintCompositeMode for the value in the provided memory address.
    static PaintCompositeMode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PaintCompositeMode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

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

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • CLEAR

      public static final PaintCompositeMode CLEAR
      clear destination layer (bounded)

    • SRC

      public static final PaintCompositeMode SRC
      replace destination layer (bounded)

    • DEST

      public static final PaintCompositeMode DEST
      ignore the source

    • SRC_OVER

      public static final PaintCompositeMode SRC_OVER
      draw source layer on top of destination layer (bounded)

    • DEST_OVER

      public static final PaintCompositeMode DEST_OVER
      draw destination on top of source

    • SRC_IN

      public static final PaintCompositeMode SRC_IN
      draw source where there was destination content (unbounded)

    • DEST_IN

      public static final PaintCompositeMode DEST_IN
      leave destination only where there was source content (unbounded)

    • SRC_OUT

      public static final PaintCompositeMode SRC_OUT
      draw source where there was no destination content (unbounded)

    • DEST_OUT

      public static final PaintCompositeMode DEST_OUT
      leave destination only where there was no source content

    • SRC_ATOP

      public static final PaintCompositeMode SRC_ATOP
      draw source on top of destination content and only there

    • DEST_ATOP

      public static final PaintCompositeMode DEST_ATOP
      leave destination on top of source content and only there (unbounded)

    • XOR

      public static final PaintCompositeMode XOR
      source and destination are shown where there is only one of them

    • PLUS

      public static final PaintCompositeMode PLUS
      source and destination layers are accumulated

    • SCREEN

      public static final PaintCompositeMode SCREEN
      source and destination are complemented and multiplied. This causes the result to be at least as light as the lighter inputs.

    • OVERLAY

      public static final PaintCompositeMode OVERLAY
      multiplies or screens, depending on the lightness of the destination color.

    • DARKEN

      public static final PaintCompositeMode DARKEN
      replaces the destination with the source if it is darker, otherwise keeps the source.

    • LIGHTEN

      public static final PaintCompositeMode LIGHTEN
      replaces the destination with the source if it is lighter, otherwise keeps the source.

    • COLOR_DODGE

      public static final PaintCompositeMode COLOR_DODGE
      brightens the destination color to reflect the source color.

    • COLOR_BURN

      public static final PaintCompositeMode COLOR_BURN
      darkens the destination color to reflect the source color.

    • HARD_LIGHT

      public static final PaintCompositeMode HARD_LIGHT
      Multiplies or screens, dependent on source color.

    • SOFT_LIGHT

      public static final PaintCompositeMode SOFT_LIGHT
      Darkens or lightens, dependent on source color.

    • DIFFERENCE

      public static final PaintCompositeMode DIFFERENCE
      Takes the difference of the source and destination color.

    • EXCLUSION

      public static final PaintCompositeMode EXCLUSION
      Produces an effect similar to difference, but with lower contrast.

    • MULTIPLY

      public static final PaintCompositeMode MULTIPLY
      source and destination layers are multiplied. This causes the result to be at least as dark as the darker inputs.

    • HSL_HUE

      public static final PaintCompositeMode HSL_HUE
      Creates a color with the hue of the source and the saturation and luminosity of the target.

    • HSL_SATURATION

      public static final PaintCompositeMode HSL_SATURATION
      Creates a color with the saturation of the source and the hue and luminosity of the target. Painting with this mode onto a gray area produces no change.

    • HSL_COLOR

      public static final PaintCompositeMode HSL_COLOR
      Creates a color with the hue and saturation of the source and the luminosity of the target. This preserves the gray levels of the target and is useful for coloring monochrome images or tinting color images.

    • HSL_LUMINOSITY

      public static final PaintCompositeMode HSL_LUMINOSITY
      Creates a color with the luminosity of the source and the hue and saturation of the target. This produces an inverse effect to HBPAINTCOMPOSITEMODEHSLCOLOR.

  • Method Details

    • values

      public static PaintCompositeMode[] 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 PaintCompositeMode 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

    • of

      public static PaintCompositeMode of(int value)
      Create a new PaintCompositeMode for the provided value
      Parameters:
      value - the enum value
      Returns:
      the enum for the provided value

    • getValue

      public int getValue()
      Get the numeric value of this enum
      Specified by:
      getValue in interface Enumeration
      Returns:
      the enum value

    • of

      public static PaintCompositeMode of(MemorySegment address)
      Create a new PaintCompositeMode for the value in the provided memory address.
      Parameters:
      address - the memory address holding a enum value
      Returns:
      the enum for the value in the provided memory address

    • getType

      public static @Nullable Type getType()
      Get the GType of the PaintCompositeMode class.
      Returns:
      the GType