io.humble.video

Class PixelComponentDescriptor

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.PixelComponentDescriptor

public class PixelComponentDescriptor
extends RefCounted

Describes how different pixel components (e.g. the YUV values) are
represented in memory for a given PixelFormat.

Method Summary

Modifier and Type	Method and Description
PixelComponentDescriptor	copyReference() Create a new PixelComponentDescriptor object that is actually referring to the exact same underlying native object.
boolean	equals(Object obj) Compares two values, returning true if the underlying objects in native code are the same object.
int	getDepthMinus1() number of bits in the component minus 1
int	getOffsetPlus1() Number of elements before the component of the first pixel plus 1. Elements are bits for bitstream formats, bytes otherwise.
int	getPlane() which of the 4 planes contains the component
int	getShift() number of least significant bits that must be shifted away to get the value
int	getStepMinus1() Number of elements between 2 horizontally consecutive pixels minus 1. Elements are bits for bitstream formats, bytes otherwise.
int	hashCode() Get a hashable value for this object.

Methods inherited from class io.humble.ferry.RefCounted

delete, getCurrentRefCount

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

copyReference

public PixelComponentDescriptor copyReference()

Create a new PixelComponentDescriptor object that is actually referring to the exact same underlying native object.

Overrides:

copyReference in class RefCounted

Returns:

the new Java object.

equals

public boolean equals(Object obj)

Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.

Overrides:

equals in class Object

Returns:

True if the underlying native object is the same. False otherwise.

hashCode

public int hashCode()

Get a hashable value for this object.

Overrides:

hashCode in class Object

Returns:

the hashable value.

getPlane

public int getPlane()

which of the 4 planes contains the component

getStepMinus1

public int getStepMinus1()

Number of elements between 2 horizontally consecutive pixels minus 1.
Elements are bits for bitstream formats, bytes otherwise.

getOffsetPlus1

public int getOffsetPlus1()

Number of elements before the component of the first pixel plus 1.
Elements are bits for bitstream formats, bytes otherwise.

getShift

public int getShift()

number of least significant bits that must be shifted away to get the value

getDepthMinus1

public int getDepthMinus1()

number of bits in the component minus 1