Package org.apache.poi.hwmf.record

Enum HwmfBinaryRasterOp

java.lang.Object
java.lang.Enum<HwmfBinaryRasterOp>
org.apache.poi.hwmf.record.HwmfBinaryRasterOp
All Implemented Interfaces:
Serializable, Comparable<HwmfBinaryRasterOp>, java.lang.constant.Constable
public enum HwmfBinaryRasterOp extends Enum<HwmfBinaryRasterOp>
The BinaryRasterOperation Enumeration section lists the binary raster-operation codes. Rasteroperation codes define how metafile processing combines the bits from the selected pen with the bits in the destination bitmap. Each raster-operation code represents a Boolean operation in which the values of the pixels in the selected pen and the destination bitmap are combined. Following are the two operands used in these operations.
Raster-operation code meaning
OperandMeaning
PSelected pen
DDestination bitmap
Following are the Boolean operators used in these operations.
Boolean operator meaning
OperandMeaning
aBitwise AND
nBitwise NOT (inverse)
oBitwise OR
xBitwise exclusive OR (XOR)
All Boolean operations are presented in reverse Polish notation. For example, the following operation replaces the values of the pixels in the destination bitmap with a combination of the pixel values of the pen and the selected brush: DPo. Each raster-operation code is a 32-bit integer whose high-order word is a Boolean operation index and whose low-order word is the operation code. The 16-bit operation index is a zero-extended, 8-bit value that represents all possible outcomes resulting from the Boolean operation on two parameters (in this case, the pen and destination values). For example, the operation indexes for the DPo and DPan operations are shown in the following list.
Raster-operation examples
PDDPoDPan
0001
0111
1011
1110

  • Enum Constant Details

    • R2_BLACK

      public static final HwmfBinaryRasterOp R2_BLACK
      0, Pixel is always 0

    • R2_NOTMERGEPEN

      public static final HwmfBinaryRasterOp R2_NOTMERGEPEN
      DPon, Pixel is the inverse of the R2_MERGEPEN color.

    • R2_MASKNOTPEN

      public static final HwmfBinaryRasterOp R2_MASKNOTPEN
      DPna, Pixel is a combination of the screen color and the inverse of the pen color.

    • R2_NOTCOPYPEN

      public static final HwmfBinaryRasterOp R2_NOTCOPYPEN
      Pn, Pixel is the inverse of the pen color.

    • R2_MASKPENNOT

      public static final HwmfBinaryRasterOp R2_MASKPENNOT
      PDna, Pixel is a combination of the colors common to both the pen and the inverse of the screen.

    • R2_NOT

      public static final HwmfBinaryRasterOp R2_NOT
      Dn, Pixel is the inverse of the screen color.

    • R2_XORPEN

      public static final HwmfBinaryRasterOp R2_XORPEN
      DPx, Pixel is a combination of the colors in the pen or in the screen, but not in both.

    • R2_NOTMASKPEN

      public static final HwmfBinaryRasterOp R2_NOTMASKPEN
      DPan, Pixel is the inverse of the R2_MASKPEN color.

    • R2_MASKPEN

      public static final HwmfBinaryRasterOp R2_MASKPEN
      DPa, Pixel is a combination of the colors common to both the pen and the screen.

    • R2_NOTXORPEN

      public static final HwmfBinaryRasterOp R2_NOTXORPEN
      DPxn, Pixel is the inverse of the R2_XORPEN color.

    • R2_NOP

      public static final HwmfBinaryRasterOp R2_NOP
      D, Pixel remains unchanged.

    • R2_MERGENOTPEN

      public static final HwmfBinaryRasterOp R2_MERGENOTPEN
      DPno, Pixel is a combination of the colors common to both the screen and the inverse of the pen.

    • R2_COPYPEN

      public static final HwmfBinaryRasterOp R2_COPYPEN
      P, Pixel is the pen color.

    • R2_MERGEPENNOT

      public static final HwmfBinaryRasterOp R2_MERGEPENNOT
      PDno, Pixel is a combination of the pen color and the inverse of the screen color.

    • R2_MERGEPEN

      public static final HwmfBinaryRasterOp R2_MERGEPEN
      DPo, Pixel is a combination of the pen color and the screen color.

    • R2_WHITE

      public static final HwmfBinaryRasterOp R2_WHITE
      1, Pixel is always 1

  • Method Details

    • values

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

    • valueOf

      public static HwmfBinaryRasterOp valueOf(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getOpIndex

      public int getOpIndex()

    • valueOf

      public static HwmfBinaryRasterOp valueOf(int opIndex)
      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:
      opIndex - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • process

      public void process(int[] srcPixels, int[] dstPixels)