Package org.apache.pdfbox.pdmodel.graphics.blend

Class BlendMode

java.lang.Object

org.apache.pdfbox.pdmodel.graphics.blend.BlendMode

public class BlendMode
extends java.lang.Object

Blend mode.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BlendMode.BlendChannelFunction
static interface	BlendMode.BlendFunction

Field Summary

Fields

Modifier and Type	Field	Description
private BlendMode.BlendFunction	blend
private static java.util.Map<COSName,BlendMode>	BLEND_MODES
private BlendMode.BlendChannelFunction	blendChannel
static BlendMode	COLOR
static BlendMode	COLOR_BURN
static BlendMode	COLOR_DODGE
static BlendMode	COMPATIBLE
static BlendMode	DARKEN
static BlendMode	DIFFERENCE
static BlendMode	EXCLUSION
private static BlendMode.BlendFunction	fColor
private static BlendMode.BlendChannelFunction	fColorBurn
private static BlendMode.BlendChannelFunction	fColorDodge
private static BlendMode.BlendChannelFunction	fDarken
private static BlendMode.BlendChannelFunction	fDifference
private static BlendMode.BlendChannelFunction	fExclusion
private static BlendMode.BlendChannelFunction	fHardLight
private static BlendMode.BlendFunction	fHue	Functions for the blend operation of non-separable blend modes
private static BlendMode.BlendChannelFunction	fLighten
private static BlendMode.BlendFunction	fLuminosity
private static BlendMode.BlendChannelFunction	fMultiply
private static BlendMode.BlendChannelFunction	fNormal	Functions for the blend operation of separable blend modes
private static BlendMode.BlendChannelFunction	fOverlay
private static BlendMode.BlendFunction	fSaturation
private static BlendMode.BlendChannelFunction	fScreen
private static BlendMode.BlendChannelFunction	fSoftLight
static BlendMode	HARD_LIGHT
static BlendMode	HUE	Non-separable blend modes as defined in the PDF specification
private boolean	isSeparable
static BlendMode	LIGHTEN
static BlendMode	LUMINOSITY
static BlendMode	MULTIPLY
private COSName	name
static BlendMode	NORMAL	Separable blend modes as defined in the PDF specification
static BlendMode	OVERLAY
static BlendMode	SATURATION
static BlendMode	SCREEN
static BlendMode	SOFT_LIGHT

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BlendMode(COSName name, BlendMode.BlendChannelFunction blendChannel, BlendMode.BlendFunction blend)	Private constructor due to the limited set of possible blend modes.

Method Summary

Modifier and Type	Method	Description
private static java.util.Map<COSName,BlendMode>	createBlendModeMap()
private static int	get255Value(float val)
BlendMode.BlendChannelFunction	getBlendChannelFunction()	Returns the blend channel function, only available for separable blend modes.
BlendMode.BlendFunction	getBlendFunction()	Returns the blend function, only available for non separable blend modes.
COSName	getCOSName()	The blend mode name from the BM object.
static BlendMode	getInstance(COSBase cosBlendMode)	Determines the blend mode from the BM entry in the COS ExtGState.
private static void	getLuminosityRGB(float[] srcValues, float[] dstValues, float[] result)
private static void	getSaturationRGB(float[] srcValues, float[] dstValues, float[] result)
boolean	isSeparableBlendMode()	Determines if the blend mode is a separable blend mode.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

fNormal

private static final BlendMode.BlendChannelFunction fNormal

Functions for the blend operation of separable blend modes

fMultiply

private static final BlendMode.BlendChannelFunction fMultiply

fScreen

private static final BlendMode.BlendChannelFunction fScreen

fOverlay

private static final BlendMode.BlendChannelFunction fOverlay

fDarken

private static final BlendMode.BlendChannelFunction fDarken

fLighten

private static final BlendMode.BlendChannelFunction fLighten

fColorDodge

private static final BlendMode.BlendChannelFunction fColorDodge

fColorBurn

private static final BlendMode.BlendChannelFunction fColorBurn

fHardLight

private static final BlendMode.BlendChannelFunction fHardLight

fSoftLight

private static final BlendMode.BlendChannelFunction fSoftLight

fDifference

private static final BlendMode.BlendChannelFunction fDifference

fExclusion

private static final BlendMode.BlendChannelFunction fExclusion

fHue

private static final BlendMode.BlendFunction fHue

Functions for the blend operation of non-separable blend modes

fSaturation

private static final BlendMode.BlendFunction fSaturation

fColor

private static final BlendMode.BlendFunction fColor

fLuminosity

private static final BlendMode.BlendFunction fLuminosity

NORMAL

public static final BlendMode NORMAL

Separable blend modes as defined in the PDF specification

COMPATIBLE

public static final BlendMode COMPATIBLE

MULTIPLY

public static final BlendMode MULTIPLY

SCREEN

public static final BlendMode SCREEN

OVERLAY

public static final BlendMode OVERLAY

DARKEN

public static final BlendMode DARKEN

LIGHTEN

public static final BlendMode LIGHTEN

COLOR_DODGE

public static final BlendMode COLOR_DODGE

COLOR_BURN

public static final BlendMode COLOR_BURN

HARD_LIGHT

public static final BlendMode HARD_LIGHT

SOFT_LIGHT

public static final BlendMode SOFT_LIGHT

DIFFERENCE

public static final BlendMode DIFFERENCE

EXCLUSION

public static final BlendMode EXCLUSION

HUE

public static final BlendMode HUE

Non-separable blend modes as defined in the PDF specification

SATURATION

public static final BlendMode SATURATION

COLOR

public static final BlendMode COLOR

LUMINOSITY

public static final BlendMode LUMINOSITY

BLEND_MODES

private static final java.util.Map<COSName,BlendMode> BLEND_MODES

name

private final COSName name

blendChannel

private final BlendMode.BlendChannelFunction blendChannel

blend

private final BlendMode.BlendFunction blend

isSeparable

private final boolean isSeparable

Constructor Detail

BlendMode

private BlendMode(COSName name,
                  BlendMode.BlendChannelFunction blendChannel,
                  BlendMode.BlendFunction blend)

Private constructor due to the limited set of possible blend modes.

Parameters:

name - the corresponding COSName of the blend mode

blendChannel - the blend function for separable blend modes

blend - the blend function for non-separable blend modes

Method Detail

createBlendModeMap

private static java.util.Map<COSName,BlendMode> createBlendModeMap()

getCOSName

public COSName getCOSName()

The blend mode name from the BM object.

Returns:

name of blend mode.

isSeparableBlendMode

public boolean isSeparableBlendMode()

Determines if the blend mode is a separable blend mode.

Returns:

true for separable blend modes

getBlendChannelFunction

public BlendMode.BlendChannelFunction getBlendChannelFunction()

Returns the blend channel function, only available for separable blend modes.

Returns:

the blend channel function

getBlendFunction

public BlendMode.BlendFunction getBlendFunction()

Returns the blend function, only available for non separable blend modes.

Returns:

the blend function

getInstance

public static BlendMode getInstance(COSBase cosBlendMode)

Determines the blend mode from the BM entry in the COS ExtGState.

Parameters:

cosBlendMode - name or array

Returns:

blending mode

get255Value

private static int get255Value(float val)

getSaturationRGB

private static void getSaturationRGB(float[] srcValues,
                                     float[] dstValues,
                                     float[] result)

getLuminosityRGB

private static void getLuminosityRGB(float[] srcValues,
                                     float[] dstValues,
                                     float[] result)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object