Image.PackedIntComponentOrder (org.dayflower.pathtracer API)

java.lang.Object
- java.lang.Enum<Image.PackedIntComponentOrder>
- - org.dayflower.pathtracer.util.Image.PackedIntComponentOrder

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Image.PackedIntComponentOrder>

Enclosing class:

Image
```
public static enum Image.PackedIntComponentOrder
extends java.lang.Enum<Image.PackedIntComponentOrder>
```
A PackedIntComponentOrder is used to tell us what order the R-, G-, B- and A-components are stored in an int, in a packed form.
The names of the constants in this class signifies the order of the components, from most significant byte to least significant byte.

Since:

1.0.0

Author:

Jörgen Lundgren

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABGR` A `PackedIntComponentOrder` that stores the A-, B-, G- and R-components, in that order, from most significant byte to least significant byte.
`ARGB` A `PackedIntComponentOrder` that stores the A-, R-, G- and B-components, in that order, from most significant byte to least significant byte.
`BGR` A `PackedIntComponentOrder` that stores the B-, G- and R-components, in that order, from most significant byte to least significant byte.
`RGB` A `PackedIntComponentOrder` that stores the R-, G- and B-components, in that order, from most significant byte to least significant byte.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getComponentCount()` Returns the component count of this `PackedIntComponentOrder` instance.
`int`	`getShiftA()` Returns the shift for the A-component, or `-1` if it does not have one.
`int`	`getShiftB()` Returns the shift for the B-component, or `-1` if it does not have one.
`int`	`getShiftG()` Returns the shift for the G-component, or `-1` if it does not have one.
`int`	`getShiftR()` Returns the shift for the R-component, or `-1` if it does not have one.
`boolean`	`hasShiftA()` Returns `true` if, and only if, this `PackedIntComponentOrder` has a shift for the A-component, `false` otherwise.
`boolean`	`hasShiftB()` Returns `true` if, and only if, this `PackedIntComponentOrder` has a shift for the B-component, `false` otherwise.
`boolean`	`hasShiftG()` Returns `true` if, and only if, this `PackedIntComponentOrder` has a shift for the G-component, `false` otherwise.
`boolean`	`hasShiftR()` Returns `true` if, and only if, this `PackedIntComponentOrder` has a shift for the R-component, `false` otherwise.
`int`	`pack(int r, int g, int b)` Returns an `int` with `r`, `g` and `b` in a packed form.
`int`	`pack(int r, int g, int b, int a)` Returns an `int` with `r`, `g`, `b` and `a` in a packed form.
`int`	`unpackA(int color)` Returns an `int` with the unpacked A-component, or `255` if it could not unpack.
`int`	`unpackB(int color)` Returns an `int` with the unpacked B-component, or `0` if it could not unpack.
`int`	`unpackG(int color)` Returns an `int` with the unpacked G-component, or `0` if it could not unpack.
`int`	`unpackR(int color)` Returns an `int` with the unpacked R-component, or `0` if it could not unpack.
`static Image.PackedIntComponentOrder`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Image.PackedIntComponentOrder[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

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

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

- Enum Constant Detail
  - ABGR
```
public static final Image.PackedIntComponentOrder ABGR
```
    A PackedIntComponentOrder that stores the A-, B-, G- and R-components, in that order, from most significant byte to least significant byte.
    The components are stored in the following way:
```
 
 int a = (colorABGR >> 24) & 0xFF;
 int b = (colorABGR >> 16) & 0xFF;
 int g = (colorABGR >>  8) & 0xFF;
 int r = (colorABGR >>  0) & 0xFF;
 
 
```
  - ARGB
```
public static final Image.PackedIntComponentOrder ARGB
```
    A PackedIntComponentOrder that stores the A-, R-, G- and B-components, in that order, from most significant byte to least significant byte.
    The components are stored in the following way:
```
 
 int a = (colorARGB >> 24) & 0xFF;
 int r = (colorARGB >> 16) & 0xFF;
 int g = (colorARGB >>  8) & 0xFF;
 int b = (colorARGB >>  0) & 0xFF;
 
 
```
  - BGR
```
public static final Image.PackedIntComponentOrder BGR
```
    A PackedIntComponentOrder that stores the B-, G- and R-components, in that order, from most significant byte to least significant byte.
    The components are stored in the following way:
```
 
 int b = (colorBGR >> 16) & 0xFF;
 int g = (colorBGR >>  8) & 0xFF;
 int r = (colorBGR >>  0) & 0xFF;
 
 
```
  - RGB
```
public static final Image.PackedIntComponentOrder RGB
```
    A PackedIntComponentOrder that stores the R-, G- and B-components, in that order, from most significant byte to least significant byte.
    The components are stored in the following way:
```
 
 int r = (colorRGB >> 16) & 0xFF;
 int g = (colorRGB >>  8) & 0xFF;
 int b = (colorRGB >>  0) & 0xFF;
 
 
```
- Method Detail
  - values
```
public static Image.PackedIntComponentOrder[] 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 (Image.PackedIntComponentOrder c : Image.PackedIntComponentOrder.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Image.PackedIntComponentOrder 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
  - hasShiftA
```
public boolean hasShiftA()
```
    Returns true if, and only if, this PackedIntComponentOrder has a shift for the A-component, false otherwise.
    
    Returns:
    
    true if, and only if, this PackedIntComponentOrder has a shift for the A-component, false otherwise
  - hasShiftB
```
public boolean hasShiftB()
```
    Returns true if, and only if, this PackedIntComponentOrder has a shift for the B-component, false otherwise.
    
    Returns:
    
    true if, and only if, this PackedIntComponentOrder has a shift for the B-component, false otherwise
  - hasShiftG
```
public boolean hasShiftG()
```
    Returns true if, and only if, this PackedIntComponentOrder has a shift for the G-component, false otherwise.
    
    Returns:
    
    true if, and only if, this PackedIntComponentOrder has a shift for the G-component, false otherwise
  - hasShiftR
```
public boolean hasShiftR()
```
    Returns true if, and only if, this PackedIntComponentOrder has a shift for the R-component, false otherwise.
    
    Returns:
    
    true if, and only if, this PackedIntComponentOrder has a shift for the R-component, false otherwise
  - getComponentCount
```
public int getComponentCount()
```
    Returns the component count of this PackedIntComponentOrder instance.
    
    Returns:
    
    the component count of this PackedIntComponentOrder instance
  - getShiftA
```
public int getShiftA()
```
    Returns the shift for the A-component, or -1 if it does not have one.
    
    Returns:
    
    the shift for the A-component, or -1 if it does not have one
  - getShiftB
```
public int getShiftB()
```
    Returns the shift for the B-component, or -1 if it does not have one.
    
    Returns:
    
    the shift for the B-component, or -1 if it does not have one
  - getShiftG
```
public int getShiftG()
```
    Returns the shift for the G-component, or -1 if it does not have one.
    
    Returns:
    
    the shift for the G-component, or -1 if it does not have one
  - getShiftR
```
public int getShiftR()
```
    Returns the shift for the R-component, or -1 if it does not have one.
    
    Returns:
    
    the shift for the R-component, or -1 if it does not have one
  - pack
```
public int pack(int r,
                int g,
                int b)
```
    Returns an int with r, g and b in a packed form.
    
    Parameters:
    
    r - the R-component
    
    g - the G-component
    
    b - the B-component
    
    Returns:
    
    an int with r, g and b in a packed form
  - pack
```
public int pack(int r,
                int g,
                int b,
                int a)
```
    Returns an int with r, g, b and a in a packed form.
    
    Parameters:
    
    r - the R-component
    
    g - the G-component
    
    b - the B-component
    
    a - the A-component
    
    Returns:
    
    an int with r, g, b and a in a packed form
  - unpackA
```
public int unpackA(int color)
```
    Returns an int with the unpacked A-component, or 255 if it could not unpack.
    
    Parameters:
    
    color - an int with the components in packed form
    
    Returns:
    
    an int with the unpacked A-component, or 255 if it could not unpack
  - unpackB
```
public int unpackB(int color)
```
    Returns an int with the unpacked B-component, or 0 if it could not unpack.
    
    Parameters:
    
    color - an int with the components in packed form
    
    Returns:
    
    an int with the unpacked B-component, or 0 if it could not unpack
  - unpackG
```
public int unpackG(int color)
```
    Returns an int with the unpacked G-component, or 0 if it could not unpack.
    
    Parameters:
    
    color - an int with the components in packed form
    
    Returns:
    
    an int with the unpacked G-component, or 0 if it could not unpack
  - unpackR
```
public int unpackR(int color)
```
    Returns an int with the unpacked R-component, or 0 if it could not unpack.
    
    Parameters:
    
    color - an int with the components in packed form
    
    Returns:
    
    an int with the unpacked R-component, or 0 if it could not unpack

Enum Image.PackedIntComponentOrder

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ABGR

ARGB

BGR

RGB

Method Detail

values

valueOf

hasShiftA

hasShiftB

hasShiftG

hasShiftR

getComponentCount

getShiftA

getShiftB

getShiftG

getShiftR

pack

pack

unpackA

unpackB

unpackG

unpackR