public final class BlendComposite extends Object implements Composite
A blend composite defines the rule according to which a drawing primitive (known as the source) is mixed with existing graphics (know as the destination.)
BlendComposite
is an implementation of the
Composite
interface and must therefore be set as a state on
a Graphics2D
surface.
Please refer to Graphics2D.setComposite(java.awt.Composite)
for more information on how to use this class with a graphics surface.
This class offers a certain number of blending modes, or compositing rules. These rules are inspired from graphics editing software packages, like Adobe Photoshop or The GIMP.
Given the wide variety of implemented blending modes and the difficulty to describe them with words, please refer to those tools to visually see the result of these blending modes.
Each blending mode has an associated opacity, defined as a float value between 0.0 and 1.0. Changing the opacity controls the force with which the compositing operation is applied. For instance, a composite with an opacity of 0.0 will not draw the source onto the destination. With an opacity of 1.0, the source will be fully drawn onto the destination, according to the selected blending mode rule.
The opacity, or alpha value, is used by the composite instance to mutiply the alpha value of each pixel of the source when being composited over the destination.
Blend composites can be created in various manners:
BlendComposite.Average
.derive(float)
or derive(BlendingMode)
. Deriving allows
you to change either the opacity or the blending mode. Example:
BlendComposite.Average.derive(0.5f)
.getInstance(BlendingMode)
or
getInstance(BlendingMode, float)
.Due to incorrect implementations of various blending modes incompatible changes have occurred. The following will help users alleviate problems during migration:
BlendComposite.BlendingMode.BLUE
and BlendComposite.BlendingMode.GREEN
have been swapped.BlendComposite.BlendingMode
,
Graphics2D
,
Composite
,
AlphaComposite
Modifier and Type | Class and Description |
---|---|
private static class |
BlendComposite.BlendingBgrContext |
private static class |
BlendComposite.BlendingContext |
static class |
BlendComposite.BlendingMode
A blending mode defines the compositing rule of a
BlendComposite . |
private static class |
BlendComposite.BlendingRgbContext |
Modifier | Constructor and Description |
---|---|
private |
BlendComposite(BlendComposite.BlendingMode mode) |
private |
BlendComposite(BlendComposite.BlendingMode mode,
float alpha) |
Modifier and Type | Method and Description |
---|---|
CompositeContext |
createContext(ColorModel srcColorModel,
ColorModel dstColorModel,
RenderingHints hints) |
BlendComposite |
derive(BlendComposite.BlendingMode mode)
Returns a
BlendComposite object that uses the specified
blending mode and this object's alpha value. |
BlendComposite |
derive(float alpha)
Returns a
BlendComposite object that uses the specified
opacity, or alpha, and this object's blending mode. |
boolean |
equals(Object obj) |
float |
getAlpha()
Returns the opacity of this composite.
|
static BlendComposite |
getInstance(BlendComposite.BlendingMode mode)
Creates a new composite based on the blending mode passed
as a parameter.
|
static BlendComposite |
getInstance(BlendComposite.BlendingMode mode,
float alpha)
Creates a new composite based on the blending mode and opacity passed
as parameters.
|
BlendComposite.BlendingMode |
getMode()
Returns the blending mode of this composite.
|
int |
hashCode() |
private static boolean |
isBgrColorModel(ColorModel cm) |
private static boolean |
isRgbColorModel(ColorModel cm) |
public static final BlendComposite Average
public static final BlendComposite Multiply
public static final BlendComposite Screen
public static final BlendComposite Darken
public static final BlendComposite Lighten
public static final BlendComposite Overlay
public static final BlendComposite HardLight
public static final BlendComposite SoftLight
public static final BlendComposite VividLight
public static final BlendComposite LinearLight
public static final BlendComposite PinLight
public static final BlendComposite HardMix
public static final BlendComposite Difference
public static final BlendComposite Negation
public static final BlendComposite Exclusion
public static final BlendComposite ColorDodge
public static final BlendComposite InverseColorDodge
public static final BlendComposite SoftDodge
public static final BlendComposite ColorBurn
public static final BlendComposite InverseColorBurn
public static final BlendComposite SoftBurn
public static final BlendComposite Reflect
public static final BlendComposite Glow
public static final BlendComposite Freeze
public static final BlendComposite Heat
public static final BlendComposite Add
public static final BlendComposite Subtract
public static final BlendComposite Stamp
public static final BlendComposite Red
public static final BlendComposite Green
public static final BlendComposite Blue
public static final BlendComposite Hue
public static final BlendComposite Saturation
public static final BlendComposite Color
public static final BlendComposite Luminosity
private final float alpha
private final BlendComposite.BlendingMode mode
private BlendComposite(BlendComposite.BlendingMode mode)
private BlendComposite(BlendComposite.BlendingMode mode, float alpha)
public static BlendComposite getInstance(BlendComposite.BlendingMode mode)
Creates a new composite based on the blending mode passed as a parameter. A default opacity of 1.0 is applied.
mode
- the blending mode defining the compositing ruleBlendComposite
based on the selected blending
mode, with an opacity of 1.0public static BlendComposite getInstance(BlendComposite.BlendingMode mode, float alpha)
Creates a new composite based on the blending mode and opacity passed as parameters. The opacity must be a value between 0.0 and 1.0.
mode
- the blending mode defining the compositing rulealpha
- the constant alpha to be multiplied with the alpha of the
source. alpha
must be a floating point between 0.0 and 1.0.BlendComposite
based on the selected blending
mode and opacityIllegalArgumentException
- if the opacity is less than 0.0 or
greater than 1.0public BlendComposite derive(BlendComposite.BlendingMode mode)
Returns a BlendComposite
object that uses the specified
blending mode and this object's alpha value. If the newly specified
blending mode is the same as this object's, this object is returned.
mode
- the blending mode defining the compositing ruleBlendComposite
object derived from this object,
that uses the specified blending modepublic BlendComposite derive(float alpha)
Returns a BlendComposite
object that uses the specified
opacity, or alpha, and this object's blending mode. If the newly specified
opacity is the same as this object's, this object is returned.
alpha
- the constant alpha to be multiplied with the alpha of the
source. alpha
must be a floating point between 0.0 and 1.0.BlendComposite
object derived from this object,
that uses the specified blending modeIllegalArgumentException
- if the opacity is less than 0.0 or
greater than 1.0public float getAlpha()
Returns the opacity of this composite. If no opacity has been defined, 1.0 is returned.
public BlendComposite.BlendingMode getMode()
Returns the blending mode of this composite.
private static boolean isRgbColorModel(ColorModel cm)
private static boolean isBgrColorModel(ColorModel cm)
public CompositeContext createContext(ColorModel srcColorModel, ColorModel dstColorModel, RenderingHints hints)
createContext
in interface Composite
WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses