APIdia Launch Partner
Top Description Fields Constructors Methods
java.awt

public final Class AlphaComposite

extends Object
implements Composite
Class Inheritance
All Implemented Interfaces
java.awt.Composite
Imports
java.awt.image.ColorModel, java.lang.annotation.Native, sun.java2d.SunCompositeContext

The AlphaComposite class implements basic alpha compositing rules for combining source and destination colors to achieve blending and transparency effects with graphics and images. The specific rules implemented by this class are the basic set of 12 rules described in T. Porter and T. Duff, "Compositing Digital Images", SIGGRAPH 84, 253-259. The rest of this documentation assumes some familiarity with the definitions and concepts outlined in that paper.

This class extends the standard equations defined by Porter and Duff to include one additional factor. An instance of the AlphaComposite class can contain an alpha value that is used to modify the opacity or coverage of every source pixel before it is used in the blending equations.

It is important to note that the equations defined by the Porter and Duff paper are all defined to operate on color components that are premultiplied by their corresponding alpha components. Since the ColorModel and Raster classes allow the storage of pixel data in either premultiplied or non-premultiplied form, all input data must be normalized into premultiplied form before applying the equations and all results might need to be adjusted back to the form required by the destination before the pixel values are stored.

Also note that this class defines only the equations for combining color and alpha values in a purely mathematical sense. The accurate application of its equations depends on the way the data is retrieved from its sources and stored in its destinations. See Implementation Caveats for further information.

The following factors are used in the description of the blending equation in the Porter and Duff paper:

Factors
Factor Definition
As the alpha component of the source pixel
Cs a color component of the source pixel in premultiplied form
Ad the alpha component of the destination pixel
Cd a color component of the destination pixel in premultiplied form
Fs the fraction of the source pixel that contributes to the output
Fd the fraction of the destination pixel that contributes to the output
Ar the alpha component of the result
Cr a color component of the result in premultiplied form

Using these factors, Porter and Duff define 12 ways of choosing the blending factors Fs and Fd to produce each of 12 desirable visual effects. The equations for determining Fs and Fd are given in the descriptions of the 12 static fields that specify visual effects. For example, the description for SRC_OVER specifies that Fs = 1 and Fd = (1-As). Once a set of equations for determining the blending factors is known they can then be applied to each pixel to produce a result using the following set of equations:

     Fs = f(Ad)
     Fd = f(As)
     Ar = As*Fs + Ad*Fd
     Cr = Cs*Fs + Cd*Fd

The following factors will be used to discuss our extensions to the blending equation in the Porter and Duff paper:

Factors
Factor Definition
Csr one of the raw color components of the source pixel
Cdr one of the raw color components of the destination pixel
Aac the "extra" alpha component from the AlphaComposite instance
Asr the raw alpha component of the source pixel
Adr the raw alpha component of the destination pixel
Adf the final alpha component stored in the destination
Cdf the final raw color component stored in the destination

Preparing Inputs

The AlphaComposite class defines an additional alpha value that is applied to the source alpha. This value is applied as if an implicit SRC_IN rule were first applied to the source pixel against a pixel with the indicated alpha by multiplying both the raw source alpha and the raw source colors by the alpha in the AlphaComposite. This leads to the following equation for producing the alpha used in the Porter and Duff blending equation:

     As = Asr * Aac 
All of the raw source color components need to be multiplied by the alpha in the AlphaComposite instance. Additionally, if the source was not in premultiplied form then the color components also need to be multiplied by the source alpha. Thus, the equation for producing the source color components for the Porter and Duff equation depends on whether the source pixels are premultiplied or not:
     Cs = Csr * Asr * Aac     (if source is not premultiplied)
     Cs = Csr * Aac           (if source is premultiplied) 
No adjustment needs to be made to the destination alpha:
     Ad = Adr 

The destination color components need to be adjusted only if they are not in premultiplied form:

     Cd = Cdr * Ad    (if destination is not premultiplied)
     Cd = Cdr         (if destination is premultiplied) 

Applying the Blending Equation

The adjusted As, Ad, Cs, and Cd are used in the standard Porter and Duff equations to calculate the blending factors Fs and Fd and then the resulting premultiplied components Ar and Cr.

Preparing Results

The results only need to be adjusted if they are to be stored back into a destination buffer that holds data that is not premultiplied, using the following equations:

     Adf = Ar
     Cdf = Cr                 (if dest is premultiplied)
     Cdf = Cr / Ar            (if dest is not premultiplied) 
Note that since the division is undefined if the resulting alpha is zero, the division in that case is omitted to avoid the "divide by zero" and the color components are left as all zeros.

Performance Considerations

For performance reasons, it is preferable that Raster objects passed to the compose method of a CompositeContext object created by the AlphaComposite class have premultiplied data. If either the source Raster or the destination Raster is not premultiplied, however, appropriate conversions are performed before and after the compositing operation.

Implementation Caveats

See Also
Composite, CompositeContext

Field Summary

Modifier and TypeField and Description
public static final int
CLEAR

Both the color and the alpha of the destination are cleared (Porter-Duff Clear rule).

public static final AlphaComposite
Clear

AlphaComposite object that implements the opaque CLEAR rule with an alpha of 1.0f.

public static final int
DST

The destination is left untouched (Porter-Duff Destination rule).

public static final AlphaComposite
Dst

AlphaComposite object that implements the opaque DST rule with an alpha of 1.0f.

public static final int
DST_ATOP

The part of the destination lying inside of the source is composited over the source and replaces the destination (Porter-Duff Destination Atop Source rule).

public static final int
DST_IN

The part of the destination lying inside of the source replaces the destination (Porter-Duff Destination In Source rule).

public static final int
DST_OUT

The part of the destination lying outside of the source replaces the destination (Porter-Duff Destination Held Out By Source rule).

public static final int
DST_OVER

The destination is composited over the source and the result replaces the destination (Porter-Duff Destination Over Source rule).

public static final AlphaComposite
DstAtop

AlphaComposite object that implements the opaque DST_ATOP rule with an alpha of 1.0f.

public static final AlphaComposite
DstIn

AlphaComposite object that implements the opaque DST_IN rule with an alpha of 1.0f.

public static final AlphaComposite
DstOut

AlphaComposite object that implements the opaque DST_OUT rule with an alpha of 1.0f.

public static final AlphaComposite
DstOver

AlphaComposite object that implements the opaque DST_OVER rule with an alpha of 1.0f.

pack-priv float
private static final int
private static final int
pack-priv int
public static final int
SRC

The source is copied to the destination (Porter-Duff Source rule).

public static final AlphaComposite
Src

AlphaComposite object that implements the opaque SRC rule with an alpha of 1.0f.

public static final int
SRC_ATOP

The part of the source lying inside of the destination is composited onto the destination (Porter-Duff Source Atop Destination rule).

public static final int
SRC_IN

The part of the source lying inside of the destination replaces the destination (Porter-Duff Source In Destination rule).

public static final int
SRC_OUT

The part of the source lying outside of the destination replaces the destination (Porter-Duff Source Held Out By Destination rule).

public static final int
SRC_OVER

The source is composited over the destination (Porter-Duff Source Over Destination rule).

public static final AlphaComposite
SrcAtop

AlphaComposite object that implements the opaque SRC_ATOP rule with an alpha of 1.0f.

public static final AlphaComposite
SrcIn

AlphaComposite object that implements the opaque SRC_IN rule with an alpha of 1.0f.

public static final AlphaComposite
SrcOut

AlphaComposite object that implements the opaque SRC_OUT rule with an alpha of 1.0f.

public static final AlphaComposite
SrcOver

AlphaComposite object that implements the opaque SRC_OVER rule with an alpha of 1.0f.

public static final int
XOR

The part of the source that lies outside of the destination is combined with the part of the destination that lies outside of the source (Porter-Duff Source Xor Destination rule).

public static final AlphaComposite
Xor

AlphaComposite object that implements the opaque XOR rule with an alpha of 1.0f.

Constructor Summary

AccessConstructor and Description
private
AlphaComposite(int rule)

private
AlphaComposite(int rule, float alpha)

Method Summary

Modifier and TypeMethod and Description
public CompositeContext

Returns:

the CompositeContext object to be used to perform compositing operations.
createContext
(ColorModel
the ColorModel of the source
srcColorModel
,
ColorModel
the ColorModel of the destination
dstColorModel
,
RenderingHints hints)

Implements java.awt.Composite.createContext.

Creates a context for the compositing operation.

public AlphaComposite

Returns:

an AlphaComposite object derived from this object that uses the specified compositing rule.
derive
(int
the compositing rule
rule
)

Returns a similar AlphaComposite object that uses the specified compositing rule.

public AlphaComposite

Returns:

an AlphaComposite object derived from this object that uses the specified alpha value.
derive
(float
the constant alpha to be multiplied with the alpha of the source. alpha must be a floating point number in the inclusive range [0.0, 1.0].
alpha
)

Returns a similar AlphaComposite object that uses the specified alpha value.

public boolean

Returns:

true if obj equals this AlphaComposite; false otherwise.
equals
(Object
the Object to test for equality
obj
)

Overrides java.lang.Object.equals.

Determines whether the specified object is equal to this AlphaComposite.

public float

Returns:

the alpha value of this AlphaComposite.
getAlpha
()

Returns the alpha value of this AlphaComposite.

public static AlphaComposite

Returns:

the AlphaComposite object created
getInstance
(int
the compositing rule
rule
)

Creates an AlphaComposite object with the specified rule.

public static AlphaComposite

Returns:

the AlphaComposite object created
getInstance
(int
the compositing rule
rule
,
float
the constant alpha to be multiplied with the alpha of the source. alpha must be a floating point number in the inclusive range [0.0, 1.0].
alpha
)

Creates an AlphaComposite object with the specified rule and the constant alpha to multiply with the alpha of the source.

public int

Returns:

the compositing rule of this AlphaComposite.
getRule
()

Returns the compositing rule of this AlphaComposite.

public int

Returns:

a hash code for this composite.
hashCode
()

Overrides java.lang.Object.hashCode.

Returns the hashcode for this composite.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

CLEARback to summary
public static final int CLEAR

Both the color and the alpha of the destination are cleared (Porter-Duff Clear rule). Neither the source nor the destination is used as input.

Fs = 0 and Fd = 0, thus:

  Ar = 0
  Cr = 0
Annotations
@Native
Clearback to summary
public static final AlphaComposite Clear

AlphaComposite object that implements the opaque CLEAR rule with an alpha of 1.0f.

See Also
CLEAR
DSTback to summary
public static final int DST

The destination is left untouched (Porter-Duff Destination rule).

Fs = 0 and Fd = 1, thus:

  Ar = Ad
  Cr = Cd
Annotations
@Native
Since
1.4
Dstback to summary
public static final AlphaComposite Dst

AlphaComposite object that implements the opaque DST rule with an alpha of 1.0f.

Since
1.4
See Also
DST
DST_ATOPback to summary
public static final int DST_ATOP

The part of the destination lying inside of the source is composited over the source and replaces the destination (Porter-Duff Destination Atop Source rule).

Fs = (1-Ad) and Fd = As, thus:

  Ar = As*(1-Ad) + Ad*As = As
  Cr = Cs*(1-Ad) + Cd*As
Annotations
@Native
Since
1.4
DST_INback to summary
public static final int DST_IN

The part of the destination lying inside of the source replaces the destination (Porter-Duff Destination In Source rule).

Fs = 0 and Fd = As, thus:

  Ar = Ad*As
  Cr = Cd*As
Annotations
@Native
DST_OUTback to summary
public static final int DST_OUT

The part of the destination lying outside of the source replaces the destination (Porter-Duff Destination Held Out By Source rule).

Fs = 0 and Fd = (1-As), thus:

  Ar = Ad*(1-As)
  Cr = Cd*(1-As)
Annotations
@Native
DST_OVERback to summary
public static final int DST_OVER

The destination is composited over the source and the result replaces the destination (Porter-Duff Destination Over Source rule).

Fs = (1-Ad) and Fd = 1, thus:

  Ar = As*(1-Ad) + Ad
  Cr = Cs*(1-Ad) + Cd
Annotations
@Native
DstAtopback to summary
public static final AlphaComposite DstAtop

AlphaComposite object that implements the opaque DST_ATOP rule with an alpha of 1.0f.

Since
1.4
See Also
DST_ATOP
DstInback to summary
public static final AlphaComposite DstIn

AlphaComposite object that implements the opaque DST_IN rule with an alpha of 1.0f.

See Also
DST_IN
DstOutback to summary
public static final AlphaComposite DstOut

AlphaComposite object that implements the opaque DST_OUT rule with an alpha of 1.0f.

See Also
DST_OUT
DstOverback to summary
public static final AlphaComposite DstOver

AlphaComposite object that implements the opaque DST_OVER rule with an alpha of 1.0f.

See Also
DST_OVER
extraAlphaback to summary
pack-priv float extraAlpha
MAX_RULEback to summary
private static final int MAX_RULE
Annotations
@Native
MIN_RULEback to summary
private static final int MIN_RULE
Annotations
@Native
ruleback to summary
pack-priv int rule
SRCback to summary
public static final int SRC

The source is copied to the destination (Porter-Duff Source rule). The destination is not used as input.

Fs = 1 and Fd = 0, thus:

  Ar = As
  Cr = Cs
Annotations
@Native
Srcback to summary
public static final AlphaComposite Src

AlphaComposite object that implements the opaque SRC rule with an alpha of 1.0f.

See Also
SRC
SRC_ATOPback to summary
public static final int SRC_ATOP

The part of the source lying inside of the destination is composited onto the destination (Porter-Duff Source Atop Destination rule).

Fs = Ad and Fd = (1-As), thus:

  Ar = As*Ad + Ad*(1-As) = Ad
  Cr = Cs*Ad + Cd*(1-As)
Annotations
@Native
Since
1.4
SRC_INback to summary
public static final int SRC_IN

The part of the source lying inside of the destination replaces the destination (Porter-Duff Source In Destination rule).

Fs = Ad and Fd = 0, thus:

  Ar = As*Ad
  Cr = Cs*Ad
Annotations
@Native
SRC_OUTback to summary
public static final int SRC_OUT

The part of the source lying outside of the destination replaces the destination (Porter-Duff Source Held Out By Destination rule).

Fs = (1-Ad) and Fd = 0, thus:

  Ar = As*(1-Ad)
  Cr = Cs*(1-Ad)
Annotations
@Native
SRC_OVERback to summary
public static final int SRC_OVER

The source is composited over the destination (Porter-Duff Source Over Destination rule).

Fs = 1 and Fd = (1-As), thus:

  Ar = As + Ad*(1-As)
  Cr = Cs + Cd*(1-As)
Annotations
@Native
SrcAtopback to summary
public static final AlphaComposite SrcAtop

AlphaComposite object that implements the opaque SRC_ATOP rule with an alpha of 1.0f.

Since
1.4
See Also
SRC_ATOP
SrcInback to summary
public static final AlphaComposite SrcIn

AlphaComposite object that implements the opaque SRC_IN rule with an alpha of 1.0f.

See Also
SRC_IN
SrcOutback to summary
public static final AlphaComposite SrcOut

AlphaComposite object that implements the opaque SRC_OUT rule with an alpha of 1.0f.

See Also
SRC_OUT
SrcOverback to summary
public static final AlphaComposite SrcOver

AlphaComposite object that implements the opaque SRC_OVER rule with an alpha of 1.0f.

See Also
SRC_OVER
XORback to summary
public static final int XOR

The part of the source that lies outside of the destination is combined with the part of the destination that lies outside of the source (Porter-Duff Source Xor Destination rule).

Fs = (1-Ad) and Fd = (1-As), thus:

  Ar = As*(1-Ad) + Ad*(1-As)
  Cr = Cs*(1-Ad) + Cd*(1-As)
Annotations
@Native
Since
1.4
Xorback to summary
public static final AlphaComposite Xor

AlphaComposite object that implements the opaque XOR rule with an alpha of 1.0f.

Since
1.4
See Also
XOR

Constructor Detail

AlphaCompositeback to summary
private AlphaComposite(int rule)
AlphaCompositeback to summary
private AlphaComposite(int rule, float alpha)

Method Detail

createContextback to summary
public CompositeContext createContext(ColorModel srcColorModel, ColorModel dstColorModel, RenderingHints hints)

Implements java.awt.Composite.createContext.

Creates a context for the compositing operation. The context contains state that is used in performing the compositing operation.

Parameters
srcColorModel:ColorModel

the ColorModel of the source

dstColorModel:ColorModel

the ColorModel of the destination

Returns:CompositeContext

the CompositeContext object to be used to perform compositing operations.

deriveback to summary
public AlphaComposite derive(int rule)

Returns a similar AlphaComposite object that uses the specified compositing rule. If this object already uses the specified compositing rule, this object is returned.

Parameters
rule:int

the compositing rule

Returns:AlphaComposite

an AlphaComposite object derived from this object that uses the specified compositing rule.

Exceptions
IllegalArgumentException:
if rule is not one of the following: CLEAR, SRC, DST, SRC_OVER, DST_OVER, SRC_IN, DST_IN, SRC_OUT, DST_OUT, SRC_ATOP, DST_ATOP, or XOR
Since
1.6
deriveback to summary
public AlphaComposite derive(float alpha)

Returns a similar AlphaComposite object that uses the specified alpha value. If this object already has the specified alpha value, this object is returned.

Parameters
alpha:float

the constant alpha to be multiplied with the alpha of the source. alpha must be a floating point number in the inclusive range [0.0, 1.0].

Returns:AlphaComposite

an AlphaComposite object derived from this object that uses the specified alpha value.

Exceptions
IllegalArgumentException:
if alpha is less than 0.0 or greater than 1.0
Since
1.6
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Determines whether the specified object is equal to this AlphaComposite.

The result is true if and only if the argument is not null and is an AlphaComposite object that has the same compositing rule and alpha value as this object.

Parameters
obj:Object

the Object to test for equality

Returns:boolean

true if obj equals this AlphaComposite; false otherwise.

getAlphaback to summary
public float getAlpha()

Returns the alpha value of this AlphaComposite. If this AlphaComposite does not have an alpha value, 1.0 is returned.

Returns:float

the alpha value of this AlphaComposite.

getInstanceback to summary
public static AlphaComposite getInstance(int rule)

Creates an AlphaComposite object with the specified rule.

Parameters
rule:int

the compositing rule

Returns:AlphaComposite

the AlphaComposite object created

Exceptions
IllegalArgumentException:
if rule is not one of the following: CLEAR, SRC, DST, SRC_OVER, DST_OVER, SRC_IN, DST_IN, SRC_OUT, DST_OUT, SRC_ATOP, DST_ATOP, or XOR
getInstanceback to summary
public static AlphaComposite getInstance(int rule, float alpha)

Creates an AlphaComposite object with the specified rule and the constant alpha to multiply with the alpha of the source. The source is multiplied with the specified alpha before being composited with the destination.

Parameters
rule:int

the compositing rule

alpha:float

the constant alpha to be multiplied with the alpha of the source. alpha must be a floating point number in the inclusive range [0.0, 1.0].

Returns:AlphaComposite

the AlphaComposite object created

Exceptions
IllegalArgumentException:
if alpha is less than 0.0 or greater than 1.0, or if rule is not one of the following: CLEAR, SRC, DST, SRC_OVER, DST_OVER, SRC_IN, DST_IN, SRC_OUT, DST_OUT, SRC_ATOP, DST_ATOP, or XOR
getRuleback to summary
public int getRule()

Returns the compositing rule of this AlphaComposite.

Returns:int

the compositing rule of this AlphaComposite.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Returns the hashcode for this composite.

Returns:int

a hash code for this composite.