java.lang.Object

com.jogamp.nativewindow.util.PixelFormat.PackedComposition

All Implemented Interfaces:: PixelFormat.Composition

Enclosing class:: PixelFormat

public static class PixelFormat.PackedComposition extends Object implements PixelFormat.Composition

Packed pixel composition, see PixelFormat.Composition.

Components are interleaved, i.e. packed.

Field Summary

Fields inherited from interface com.jogamp.nativewindow.util.PixelFormat.Composition
UNDEF
Constructor Summary

Constructors

Constructor

Description

PackedComposition(PixelFormat.CType[] componentOrder, int[] componentMask, int[] componentBitShift, int bitStride)

PackedComposition(PixelFormat.CType[] componentOrder, int componentCount, int bpc, int bitStride)
Method Summary

Modifier and Type

Method

Description

final int

bitsPerPixel()

Number of bits per pixel, e.g.

final int

bitStride()

Bit distance between pixels.

final int

bytesPerPixel()

Number of bytes per pixel, i.e.

final int[]

componentBitCount()

Returns the number of bits of all components, see PixelFormat.Composition.componentBitMask().

final int[]

componentBitMask()

Returns the un-shifted bit-mask of all components.

final int[]

componentBitShift()

Returns the bit-shift of all components, see PixelFormat.Composition.componentBitMask().

final int

componentCount()

Number of components per pixel, e.g.

final PixelFormat.CType[]

componentOrder()

Returns the Component type order of all components, see PixelFormat.Composition.componentBitMask().

final int

decodeSingleI32(int shifted, int cIdx)

Decodes a component from the shifted pixel data with a PixelFormat.Composition.bytesPerPixel() of up to 32bit.

final int

decodeSingleI64(long shifted, int cIdx)

Decodes a component from the shifted pixel data with a PixelFormat.Composition.bytesPerPixel() of up to 64bit.

final int

defaultValue(int cIdx, boolean shiftResult)

final int

encode3CompI32(int c1NormI32, int c2NormI32, int c3NormI32)

final int

encode3CompI8(byte c1NormI8, byte c2NormI8, byte c3NormI8)

final int

encode4CompI32(int c1NormI32, int c2NormI32, int c3NormI32, int c4NormI32)

final int

encode4CompI8(byte c1NormI8, byte c2NormI8, byte c3NormI8, byte c4NormI8)

final int

encodeSingleI32(int norm, int cIdx)

final long

encodeSingleI64(int norm, int cIdx)

final int

encodeSingleI8(byte normI8, int cIdx)

final boolean

equals(Object obj)

Returns Object.equals(Object)

final int

find(PixelFormat.CType s)

Returns the index of given PixelFormat.CType within PixelFormat.Composition.componentOrder(), -1 if not exists.

final int

fromFloat(float f, int cIdx, boolean shiftResult)

final int

hashCode()

Returns cached immutable hash value, see Object.hashCode().

final boolean

isInterleaved()

Returns true if all components are packed, i.e.

final boolean

isUniform()

Returns true if all components are of same bit-size, e.g.

final float

toFloat(int i32, int cIdx, boolean i32Shifted)

final String

toString()

Returns Object.toString().

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

Constructor Details
- PackedComposition
  
  public PackedComposition(PixelFormat.CType[] componentOrder, int componentCount, int bpc, int bitStride)
  
  Parameters:
  
  componentOrder - Component type order of all components, see componentBitMask().
  
  componentCount - number of components
  
  bpc - bits per component
  
  bitStride - stride bits to next pixel
- PackedComposition
  
  public PackedComposition(PixelFormat.CType[] componentOrder, int[] componentMask, int[] componentBitShift, int bitStride)
  
  Parameters:
  
  componentOrder - Component type order of all components, see componentBitMask().
  
  componentMask - bit-mask of of all components, see componentBitMask().
  
  componentBitShift - bit-shift of all components, see componentBitMask().
  
  bitStride - stride bits to next pixel
Method Details
- toString
  
  public final String toString()
  
  Description copied from interface: PixelFormat.Composition
  
  Returns Object.toString().
  
  Specified by:
  
  toString in interface PixelFormat.Composition
  
  Overrides:
  
  toString in class Object
- isUniform
  
  public final boolean isUniform()
  
  Description copied from interface: PixelFormat.Composition
  
  Returns true if all components are of same bit-size, e.g. RGBA8888, otherwise false, e.g. RGBA5551
  
  Specified by:
  
  isUniform in interface PixelFormat.Composition
- isInterleaved
  
  public final boolean isInterleaved()
  
  Returns true if all components are packed, i.e. interleaved, e.g. RGBA8888, otherwise false.
  Instances of PixelFormat.PackedComposition returns true.
  
  Specified by:
  
  isInterleaved in interface PixelFormat.Composition
- componentCount
  
  public final int componentCount()
  
  Description copied from interface: PixelFormat.Composition
  
  Number of components per pixel, e.g. 3 for RGBx8888.
  
  Specified by:
  
  componentCount in interface PixelFormat.Composition
- bitsPerPixel
  
  public final int bitsPerPixel()
  
  Description copied from interface: PixelFormat.Composition
  
  Number of bits per pixel, e.g. 24 bits for RGBx8888.
  
  Specified by:
  
  bitsPerPixel in interface PixelFormat.Composition
- bitStride
  
  public final int bitStride()
  
  Description copied from interface: PixelFormat.Composition
  
  Bit distance between pixels.
  For packed pixels e.g. 32 bits for RGBx8888.
  
  Specified by:
  
  bitStride in interface PixelFormat.Composition
- bytesPerPixel
  
  public final int bytesPerPixel()
  
  Description copied from interface: PixelFormat.Composition
  
  Number of bytes per pixel, i.e. packed PixelFormat.Composition.bitStride() in bytes, e.g. 4 for RGBx8888.
  
  Specified by:
  
  bytesPerPixel in interface PixelFormat.Composition
- componentOrder
  
  public final PixelFormat.CType[] componentOrder()
  
  Description copied from interface: PixelFormat.Composition
  
  Returns the Component type order of all components, see PixelFormat.Composition.componentBitMask().
  
  Specified by:
  
  componentOrder in interface PixelFormat.Composition
- find
  
  public final int find(PixelFormat.CType s)
  
  Description copied from interface: PixelFormat.Composition
  
  Returns the index of given PixelFormat.CType within PixelFormat.Composition.componentOrder(), -1 if not exists.
  
  Specified by:
  
  find in interface PixelFormat.Composition
- componentBitMask
  
  public final int[] componentBitMask()
  
  Description copied from interface: PixelFormat.Composition
  Returns the un-shifted bit-mask of all components.
  Components mask is returned in the order Low-Index to High-Index, e.g.:
  
  RGB565: 0: R 0x1F, 1: G 0x3F, 2: B 0x1F
  
  RGBA5551: 0: R 0x1F, 1: G 0x1F, 2: B 0x1F, 3: A 0x01
  
  RGBA8888: 0: R 0xFF, 1: G 0xFF, 2: B 0xFF, 3: A 0xFF
  Specified by:
  
  componentBitMask in interface PixelFormat.Composition
- componentBitCount
  
  public final int[] componentBitCount()
  
  Description copied from interface: PixelFormat.Composition
  
  Returns the number of bits of all components, see PixelFormat.Composition.componentBitMask().
  
  Specified by:
  
  componentBitCount in interface PixelFormat.Composition
- componentBitShift
  
  public final int[] componentBitShift()
  
  Description copied from interface: PixelFormat.Composition
  
  Returns the bit-shift of all components, see PixelFormat.Composition.componentBitMask().
  
  Specified by:
  
  componentBitShift in interface PixelFormat.Composition
- decodeSingleI32
  
  public final int decodeSingleI32(int shifted, int cIdx)
  
  Description copied from interface: PixelFormat.Composition
  
  Decodes a component from the shifted pixel data with a PixelFormat.Composition.bytesPerPixel() of up to 32bit.
  
  Specified by:
  
  decodeSingleI32 in interface PixelFormat.Composition
  
  Parameters:
  
  shifted - complete pixel encoded into on 32bit integer
  
  cIdx - the desired component index
  
  Returns:
  
  the decoded component value
- decodeSingleI64
  
  public final int decodeSingleI64(long shifted, int cIdx)
  
  Description copied from interface: PixelFormat.Composition
  
  Decodes a component from the shifted pixel data with a PixelFormat.Composition.bytesPerPixel() of up to 64bit.
  
  Specified by:
  
  decodeSingleI64 in interface PixelFormat.Composition
  
  Parameters:
  
  shifted - complete pixel encoded into on 64bit integer
  
  cIdx - the desired component index
  
  Returns:
  
  the decoded component value
- encodeSingleI32
  
  public final int encodeSingleI32(int norm, int cIdx)
  
  Specified by:
  
  encodeSingleI32 in interface PixelFormat.Composition
- encodeSingleI64
  
  public final long encodeSingleI64(int norm, int cIdx)
  
  Specified by:
  
  encodeSingleI64 in interface PixelFormat.Composition
- encode3CompI32
  
  public final int encode3CompI32(int c1NormI32, int c2NormI32, int c3NormI32)
  
  Specified by:
  
  encode3CompI32 in interface PixelFormat.Composition
- encode4CompI32
  
  public final int encode4CompI32(int c1NormI32, int c2NormI32, int c3NormI32, int c4NormI32)
  
  Specified by:
  
  encode4CompI32 in interface PixelFormat.Composition
- encodeSingleI8
  
  public final int encodeSingleI8(byte normI8, int cIdx)
  
  Specified by:
  
  encodeSingleI8 in interface PixelFormat.Composition
- encode3CompI8
  
  public final int encode3CompI8(byte c1NormI8, byte c2NormI8, byte c3NormI8)
  
  Specified by:
  
  encode3CompI8 in interface PixelFormat.Composition
- encode4CompI8
  
  public final int encode4CompI8(byte c1NormI8, byte c2NormI8, byte c3NormI8, byte c4NormI8)
  
  Specified by:
  
  encode4CompI8 in interface PixelFormat.Composition
- toFloat
  
  public final float toFloat(int i32, int cIdx, boolean i32Shifted)
  
  Specified by:
  
  toFloat in interface PixelFormat.Composition
- fromFloat
  
  public final int fromFloat(float f, int cIdx, boolean shiftResult)
  
  Specified by:
  
  fromFloat in interface PixelFormat.Composition
- defaultValue
  
  public final int defaultValue(int cIdx, boolean shiftResult)
  
  Specified by:
  
  defaultValue in interface PixelFormat.Composition
- hashCode
  
  public final int hashCode()
  
  Description copied from interface: PixelFormat.Composition
  
  Returns cached immutable hash value, see Object.hashCode().
  
  Specified by:
  
  hashCode in interface PixelFormat.Composition
  
  Overrides:
  
  hashCode in class Object
- equals
  
  public final boolean equals(Object obj)
  
  Description copied from interface: PixelFormat.Composition
  
  Returns Object.equals(Object)
  
  Specified by:
  
  equals in interface PixelFormat.Composition
  
  Overrides:
  
  equals in class Object

Class PixelFormat.PackedComposition

Field Summary

Fields inherited from interface com.jogamp.nativewindow.util.PixelFormat.Composition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

PackedComposition

PackedComposition

Method Details

toString

isUniform

isInterleaved

componentCount

bitsPerPixel

bitStride

bytesPerPixel

componentOrder

find

componentBitMask

componentBitCount

componentBitShift

decodeSingleI32

decodeSingleI64

encodeSingleI32

encodeSingleI64

encode3CompI32

encode4CompI32

encodeSingleI8

encode3CompI8

encode4CompI8

toFloat

fromFloat

defaultValue

hashCode

equals