Canvas.Composite (PlayN Core 2.0.4 API)

java.lang.Object
- java.lang.Enum<Canvas.Composite>
- - playn.core.Canvas.Composite

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Canvas.Composite>

Enclosing class:

Canvas
```
public static enum Canvas.Composite
extends java.lang.Enum<Canvas.Composite>
```
Values that may be used with Canvas.setCompositeOperation(Composite).

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DST_ATOP` B atop A.
`DST_IN` B in A.
`DST_OUT` B out A.
`DST_OVER` B over A.
`MULTIPLY` A * B.
`SRC` A (B is ignored).
`SRC_ATOP` A atop B.
`SRC_IN` A in B.
`SRC_OUT` A out B.
`SRC_OVER` A over B.
`XOR` A xor B.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Canvas.Composite`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Canvas.Composite[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SRC
```
public static final Canvas.Composite SRC
```
    A (B is ignored). Display the source image instead of the destination image. [Sa, Sc]
  - DST_ATOP
```
public static final Canvas.Composite DST_ATOP
```
    B atop A. Same as source-atop but using the destination image instead of the source image and vice versa. [Sa, Sa * Dc + Sc * (1 - Da)].
  - SRC_OVER
```
public static final Canvas.Composite SRC_OVER
```
    A over B. Display the source image wherever the source image is opaque. Display the destination image elsewhere. [Sa + (1 - Sa)*Da, Rc = Sc + (1 - Sa)*Dc].
  - DST_OVER
```
public static final Canvas.Composite DST_OVER
```
    B over A. Same as source-over but using the destination image instead of the source image and vice versa. [Sa + (1 - Sa)*Da, Rc = Dc + (1 - Da)*Sc].
  - SRC_IN
```
public static final Canvas.Composite SRC_IN
```
    A in B. Display the source image wherever both the source image and destination image are opaque. Display transparency elsewhere. [Sa * Da, Sc * Da].
  - DST_IN
```
public static final Canvas.Composite DST_IN
```
    B in A. Same as source-in but using the destination image instead of the source image and vice versa. [Sa * Da, Sa * Dc].
  - SRC_OUT
```
public static final Canvas.Composite SRC_OUT
```
    A out B. Display the source image wherever the source image is opaque and the destination image is transparent. Display transparency elsewhere. [Sa * (1 - Da), Sc * (1 - Da)].
  - DST_OUT
```
public static final Canvas.Composite DST_OUT
```
    B out A. Same as source-out but using the destination image instead of the source image and vice versa. [Da * (1 - Sa), Dc * (1 - Sa)].
  - SRC_ATOP
```
public static final Canvas.Composite SRC_ATOP
```
    A atop B. Display the source image wherever both images are opaque. Display the destination image wherever the destination image is opaque but the source image is transparent. Display transparency elsewhere. [Da, Sc * Da + (1 - Sa) * Dc].
  - XOR
```
public static final Canvas.Composite XOR
```
    A xor B. Exclusive OR of the source image and destination image. [Sa + Da - 2 * Sa * Da, Sc * (1 - Da) + (1 - Sa) * Dc].
  - MULTIPLY
```
public static final Canvas.Composite MULTIPLY
```
    A * B. Multiplies the source and destination images. NOTE: this is not supported by the HTML5 and Flash backends. [Sa * Da, Sc * Dc].
- Method Detail
  - values
```
public static Canvas.Composite[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Canvas.Composite c : Canvas.Composite.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Canvas.Composite valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null

Enum Canvas.Composite

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SRC

DST_ATOP

SRC_OVER

DST_OVER

SRC_IN

DST_IN

SRC_OUT

DST_OUT

SRC_ATOP

XOR

MULTIPLY

Method Detail

values

valueOf