Image.ArrayComponentOrder (org.dayflower.pathtracer API)

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

All Implemented Interfaces:

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

Enclosing class:

Image
```
public static enum Image.ArrayComponentOrder
extends java.lang.Enum<Image.ArrayComponentOrder>
```
An ArrayComponentOrder is used to tell us what order the R-, G-, B- and A-components are stored in arrays.
This class has nothing to do with the way the R-, G-, B- and A-components are stored in an int, in packed form.
The names of the constants in this class should not be confused with the names of similar things in other libraries. They only reflect the way the components are stored in an array. The order of the letters signify the order in which they are stored in the array, starting from some offset. An example would be ARGB, where A denotes offset + 0, R denotes offset + 1, G denotes offset + 2 and B denotes offset + 3.

Since:

1.0.0

Author:

Jörgen Lundgren

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARGB` The components are stored as A, R, G and B.
`BGR` The components are stored as B, G and R.
`BGRA` The components are stored as B, G, R and A.
`RGB` The components are stored as R, G and B.
`RGBA` The components are stored as R, G, B and A.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getComponentCount()` Returns the component count of this `ArrayComponentOrder` instance.
`int`	`getOffsetA()` Returns the offset for the A-component, or `-1` if it does not have one.
`int`	`getOffsetB()` Returns the offset for the B-component, or `-1` if it does not have one.
`int`	`getOffsetG()` Returns the offset for the G-component, or `-1` if it does not have one.
`int`	`getOffsetR()` Returns the offset for the R-component, or `-1` if it does not have one.
`boolean`	`hasOffsetA()` Returns `true` if, and only if, this `ArrayComponentOrder` has an offset for the A-component, `false` otherwise.
`boolean`	`hasOffsetB()` Returns `true` if, and only if, this `ArrayComponentOrder` has an offset for the B-component, `false` otherwise.
`boolean`	`hasOffsetG()` Returns `true` if, and only if, this `ArrayComponentOrder` has an offset for the G-component, `false` otherwise.
`boolean`	`hasOffsetR()` Returns `true` if, and only if, this `ArrayComponentOrder` has an offset for the R-component, `false` otherwise.
`int`	`readA(byte[] array, int offset)` Returns an `int` with the A-component, or `255` if it does not have an offset for the A-component.
`int`	`readA(int[] array, int offset)` Returns an `int` with the A-component, or `255` if it does not have an offset for the A-component.
`int`	`readB(byte[] array, int offset)` Returns an `int` with the B-component, or `0` if it does not have an offset for the B-component.
`int`	`readB(int[] array, int offset)` Returns an `int` with the B-component, or `0` if it does not have an offset for the B-component.
`int`	`readG(byte[] array, int offset)` Returns an `int` with the G-component, or `0` if it does not have an offset for the G-component.
`int`	`readG(int[] array, int offset)` Returns an `int` with the G-component, or `0` if it does not have an offset for the G-component.
`int`	`readR(byte[] array, int offset)` Returns an `int` with the R-component, or `0` if it does not have an offset for the R-component.
`int`	`readR(int[] array, int offset)` Returns an `int` with the R-component, or `0` if it does not have an offset for the R-component.
`static Image.ArrayComponentOrder`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Image.ArrayComponentOrder[]`	`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
  - ARGB
```
public static final Image.ArrayComponentOrder ARGB
```
    The components are stored as A, R, G and B.
    The following code demonstrates the way it is stored in an array:
```
 
 array = new int[4];
 array[0] = a;
 array[1] = r;
 array[2] = g;
 array[3] = b;
 
 
```
  - BGR
```
public static final Image.ArrayComponentOrder BGR
```
    The components are stored as B, G and R.
    The following code demonstrates the way it is stored in an array:
```
 
 array = new int[3];
 array[0] = b;
 array[1] = g;
 array[2] = r;
 
 
```
  - BGRA
```
public static final Image.ArrayComponentOrder BGRA
```
    The components are stored as B, G, R and A.
    The following code demonstrates the way it is stored in an array:
```
 
 array = new int[4];
 array[0] = b;
 array[1] = g;
 array[2] = r;
 array[3] = a;
 
 
```
  - RGB
```
public static final Image.ArrayComponentOrder RGB
```
    The components are stored as R, G and B.
    The following code demonstrates the way it is stored in an array:
```
 
 array = new int[3];
 array[0] = r;
 array[1] = g;
 array[2] = b;
 
 
```
  - RGBA
```
public static final Image.ArrayComponentOrder RGBA
```
    The components are stored as R, G, B and A.
    The following code demonstrates the way it is stored in an array:
```
 
 array = new int[4];
 array[0] = r;
 array[1] = g;
 array[2] = b;
 array[3] = a;
 
 
```
- Method Detail
  - values
```
public static Image.ArrayComponentOrder[] 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.ArrayComponentOrder c : Image.ArrayComponentOrder.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.ArrayComponentOrder 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
  - hasOffsetA
```
public boolean hasOffsetA()
```
    Returns true if, and only if, this ArrayComponentOrder has an offset for the A-component, false otherwise.
    
    Returns:
    
    true if, and only if, this ArrayComponentOrder has an offset for the A-component, false otherwise
  - hasOffsetB
```
public boolean hasOffsetB()
```
    Returns true if, and only if, this ArrayComponentOrder has an offset for the B-component, false otherwise.
    
    Returns:
    
    true if, and only if, this ArrayComponentOrder has an offset for the B-component, false otherwise
  - hasOffsetG
```
public boolean hasOffsetG()
```
    Returns true if, and only if, this ArrayComponentOrder has an offset for the G-component, false otherwise.
    
    Returns:
    
    true if, and only if, this ArrayComponentOrder has an offset for the G-component, false otherwise
  - hasOffsetR
```
public boolean hasOffsetR()
```
    Returns true if, and only if, this ArrayComponentOrder has an offset for the R-component, false otherwise.
    
    Returns:
    
    true if, and only if, this ArrayComponentOrder has an offset for the R-component, false otherwise
  - getComponentCount
```
public int getComponentCount()
```
    Returns the component count of this ArrayComponentOrder instance.
    
    Returns:
    
    the component count of this ArrayComponentOrder instance
  - getOffsetA
```
public int getOffsetA()
```
    Returns the offset for the A-component, or -1 if it does not have one.
    
    Returns:
    
    the offset for the A-component, or -1 if it does not have one
  - getOffsetB
```
public int getOffsetB()
```
    Returns the offset for the B-component, or -1 if it does not have one.
    
    Returns:
    
    the offset for the B-component, or -1 if it does not have one
  - getOffsetG
```
public int getOffsetG()
```
    Returns the offset for the G-component, or -1 if it does not have one.
    
    Returns:
    
    the offset for the G-component, or -1 if it does not have one
  - getOffsetR
```
public int getOffsetR()
```
    Returns the offset for the R-component, or -1 if it does not have one.
    
    Returns:
    
    the offset for the R-component, or -1 if it does not have one
  - readA
```
public int readA(byte[] array,
                 int offset)
```
    Returns an int with the A-component, or 255 if it does not have an offset for the A-component.
    If array is null, a NullPointerException will be thrown.
    If offset + getOffsetA() is less than 0, or greater than or equal to array.length, an ArrayIndexOutOfBoundsException will be thrown.
    
    Parameters:
    
    array - the array to read from
    
    offset - the absolute offset in the array to read from
    
    Returns:
    
    an int with the A-component, or 255 if it does not have an offset for the A-component
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if, and only if, offset + getOffsetA() is less than 0, or greater than or equal to array.length
    
    java.lang.NullPointerException - thrown if, and only if, array is null
  - readA
```
public int readA(int[] array,
                 int offset)
```
    Returns an int with the A-component, or 255 if it does not have an offset for the A-component.
    If array is null, a NullPointerException will be thrown.
    If offset + getOffsetA() is less than 0, or greater than or equal to array.length, an ArrayIndexOutOfBoundsException will be thrown.
    
    Parameters:
    
    array - the array to read from
    
    offset - the absolute offset in the array to read from
    
    Returns:
    
    an int with the A-component, or 255 if it does not have an offset for the A-component
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if, and only if, offset + getOffsetA() is less than 0, or greater than or equal to array.length
    
    java.lang.NullPointerException - thrown if, and only if, array is null
  - readB
```
public int readB(byte[] array,
                 int offset)
```
    Returns an int with the B-component, or 0 if it does not have an offset for the B-component.
    If array is null, a NullPointerException will be thrown.
    If offset + getOffsetB() is less than 0, or greater than or equal to array.length, an ArrayIndexOutOfBoundsException will be thrown.
    
    Parameters:
    
    array - the array to read from
    
    offset - the absolute offset in the array to read from
    
    Returns:
    
    an int with the B-component, or 0 if it does not have an offset for the B-component
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if, and only if, offset + getOffsetB() is less than 0, or greater than or equal to array.length
    
    java.lang.NullPointerException - thrown if, and only if, array is null
  - readB
```
public int readB(int[] array,
                 int offset)
```
    Returns an int with the B-component, or 0 if it does not have an offset for the B-component.
    If array is null, a NullPointerException will be thrown.
    If offset + getOffsetB() is less than 0, or greater than or equal to array.length, an ArrayIndexOutOfBoundsException will be thrown.
    
    Parameters:
    
    array - the array to read from
    
    offset - the absolute offset in the array to read from
    
    Returns:
    
    an int with the B-component, or 0 if it does not have an offset for the B-component
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if, and only if, offset + getOffsetB() is less than 0, or greater than or equal to array.length
    
    java.lang.NullPointerException - thrown if, and only if, array is null
  - readG
```
public int readG(byte[] array,
                 int offset)
```
    Returns an int with the G-component, or 0 if it does not have an offset for the G-component.
    If array is null, a NullPointerException will be thrown.
    If offset + getOffsetG() is less than 0, or greater than or equal to array.length, an ArrayIndexOutOfBoundsException will be thrown.
    
    Parameters:
    
    array - the array to read from
    
    offset - the absolute offset in the array to read from
    
    Returns:
    
    an int with the G-component, or 0 if it does not have an offset for the G-component
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if, and only if, offset + getOffsetG() is less than 0, or greater than or equal to array.length
    
    java.lang.NullPointerException - thrown if, and only if, array is null
  - readG
```
public int readG(int[] array,
                 int offset)
```
    Returns an int with the G-component, or 0 if it does not have an offset for the G-component.
    If array is null, a NullPointerException will be thrown.
    If offset + getOffsetG() is less than 0, or greater than or equal to array.length, an ArrayIndexOutOfBoundsException will be thrown.
    
    Parameters:
    
    array - the array to read from
    
    offset - the absolute offset in the array to read from
    
    Returns:
    
    an int with the G-component, or 0 if it does not have an offset for the G-component
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if, and only if, offset + getOffsetG() is less than 0, or greater than or equal to array.length
    
    java.lang.NullPointerException - thrown if, and only if, array is null
  - readR
```
public int readR(byte[] array,
                 int offset)
```
    Returns an int with the R-component, or 0 if it does not have an offset for the R-component.
    If array is null, a NullPointerException will be thrown.
    If offset + getOffsetR() is less than 0, or greater than or equal to array.length, an ArrayIndexOutOfBoundsException will be thrown.
    
    Parameters:
    
    array - the array to read from
    
    offset - the absolute offset in the array to read from
    
    Returns:
    
    an int with the R-component, or 0 if it does not have an offset for the R-component
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if, and only if, offset + getOffsetR() is less than 0, or greater than or equal to array.length
    
    java.lang.NullPointerException - thrown if, and only if, array is null
  - readR
```
public int readR(int[] array,
                 int offset)
```
    Returns an int with the R-component, or 0 if it does not have an offset for the R-component.
    If array is null, a NullPointerException will be thrown.
    If offset + getOffsetR() is less than 0, or greater than or equal to array.length, an ArrayIndexOutOfBoundsException will be thrown.
    
    Parameters:
    
    array - the array to read from
    
    offset - the absolute offset in the array to read from
    
    Returns:
    
    an int with the R-component, or 0 if it does not have an offset for the R-component
    
    Throws:
    
    java.lang.ArrayIndexOutOfBoundsException - thrown if, and only if, offset + getOffsetR() is less than 0, or greater than or equal to array.length
    
    java.lang.NullPointerException - thrown if, and only if, array is null

Enum Image.ArrayComponentOrder

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ARGB

BGR

BGRA

RGB

RGBA

Method Detail

values

valueOf

hasOffsetA

hasOffsetB

hasOffsetG

hasOffsetR

getComponentCount

getOffsetA

getOffsetB

getOffsetG

getOffsetR

readA

readA

readB

readB

readG

readG

readR

readR