Modifier and Type	Class and Description
public static class	PixelRectangle.GenericPixelRect Generic PixelRectangle implementation

Modifier and Type	Method and Description
public PixelFormat	getPixelformat() Returns the `PixelFormat`.
public ByteBuffer	getPixels() Returns the pixels.
public DimensionImmutable	getSize() Returns the size, i.e. width and height.
public int	getStride() Returns stride in byte-size, i.e. byte count from one line to the next.
public int	hashCode() Computes a hash code over: pixelformat size stride isGLOriented pixels
public boolean	isGLOriented() Returns `true` if the memory is laid out in OpenGL's coordinate system, origin at bottom left.
public String	toString()

Method Detail

getPixelformat	back to summary
public PixelFormat getPixelformat() Returns the `PixelFormat`.

getPixels	back to summary
public ByteBuffer getPixels() Returns the pixels.

getSize	back to summary
public DimensionImmutable getSize() Returns the size, i.e. width and height.

getStride back to summary

getStride	back to summary
public int getStride() Returns stride in byte-size, i.e. byte count from one line to the next. Must be >= `getPixelformat()`.`bytesPerPixel()` * `getSize()`.`getWidth()`.

public int getStride()

Returns stride in byte-size, i.e. byte count from one line to the next.

Must be >= getPixelformat().bytesPerPixel() * getSize().getWidth().

hashCode	back to summary
public int hashCode() Computes a hash code over: pixelformat size stride isGLOriented pixels The hashCode shall be computed only once with first call and stored for later retrieval to enhance performance. Annotations @Override

hashCode

back to summary

public int hashCode()

Computes a hash code over:

pixelformat
size
stride
isGLOriented
pixels

The hashCode shall be computed only once with first call and stored for later retrieval to enhance performance.

Annotations

@Override

isGLOriented	back to summary
public boolean isGLOriented() Returns `true` if the memory is laid out in OpenGL's coordinate system, origin at bottom left. Otherwise returns `false`, i.e. origin at top left.

toString	back to summary
public String toString() Annotations @Override

com.jogamp.nativewindow.util back to summary

public Class PixelRectangle.GenericPixelRect

Class Inheritance

extends Object
implements PixelRectangle

java.lang.Object
com.jogamp.nativewindow.util.PixelRectangle.GenericPixelRect

All Implemented Interfaces

com.jogamp.nativewindow.util.PixelRectangle

Known Direct Subclasses

com.jogamp.opengl.util.PNGPixelRect

Generic PixelRectangle implementation

Field Summary

Modifier and Type	Field and Description
private int	hashCode
private volatile boolean	hashCodeComputed
protected final boolean	isGLOriented
protected final PixelFormat	pixelformat
protected final ByteBuffer	pixels
protected final DimensionImmutable	size
protected final int	strideInBytes

Constructor Summary

Access	Constructor and Description
public	GenericPixelRect(final PixelFormat pixelformat, final DimensionImmutable size, int stride in byte-size, i.e. byte count from one line to the next. If not zero, value must be >= `width * bytes-per-pixel`. If zero, stride is set to `width * bytes-per-pixel`. strideInBytes, final boolean isGLOriented, final ByteBuffer pixels)
public	GenericPixelRect(final PixelRectangle src) Copy ctor validating src.

Method Summary

Modifier and Type	Method and Description
public PixelFormat	getPixelformat() Implements com.jogamp.nativewindow.util.PixelRectangle.getPixelformat. Returns the `PixelFormat`.
public ByteBuffer	getPixels() Implements com.jogamp.nativewindow.util.PixelRectangle.getPixels. Returns the pixels.
public DimensionImmutable	getSize() Implements com.jogamp.nativewindow.util.PixelRectangle.getSize. Returns the size, i.e. width and height.
public int	getStride() Implements com.jogamp.nativewindow.util.PixelRectangle.getStride. Returns stride in byte-size, i.e. byte count from one line to the next.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements com.jogamp.nativewindow.util.PixelRectangle.hashCode. Computes a hash code over: pixelformat size stride isGLOriented pixels
public boolean	isGLOriented() Implements com.jogamp.nativewindow.util.PixelRectangle.isGLOriented. Returns `true` if the memory is laid out in OpenGL's coordinate system, origin at bottom left.
public final String	toString() Overrides java.lang.Object.toString. Implements com.jogamp.nativewindow.util.PixelRectangle.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass notify notifyAll wait wait wait

Field Detail

hashCode	back to summary
private int hashCode

hashCodeComputed	back to summary
private volatile boolean hashCodeComputed

isGLOriented	back to summary
protected final boolean isGLOriented

pixelformat	back to summary
protected final PixelFormat pixelformat

pixels	back to summary
protected final ByteBuffer pixels

size	back to summary
protected final DimensionImmutable size

strideInBytes	back to summary
protected final int strideInBytes

Constructor Detail

GenericPixelRect back to summary

GenericPixelRect	back to summary
public GenericPixelRect(final PixelFormat pixelformat, final DimensionImmutable size, int strideInBytes, final boolean isGLOriented, final ByteBuffer pixels) throws IllegalArgumentException, IndexOutOfBoundsException Parameters strideInBytes:int stride in byte-size, i.e. byte count from one line to the next. If not zero, value must be >= `width * bytes-per-pixel`. If zero, stride is set to `width * bytes-per-pixel`. Exceptions IllegalArgumentException: if `strideInBytes` is invalid. IndexOutOfBoundsException: if `pixels` has insufficient bytes left

public GenericPixelRect(final PixelFormat pixelformat, final DimensionImmutable size, int strideInBytes, final boolean isGLOriented, final ByteBuffer pixels) throws IllegalArgumentException, IndexOutOfBoundsException

Parameters

strideInBytes:int: stride in byte-size, i.e. byte count from one line to the next. If not zero, value must be >= width * bytes-per-pixel. If zero, stride is set to width * bytes-per-pixel.

Exceptions

IllegalArgumentException:: if strideInBytes is invalid.
IndexOutOfBoundsException:: if pixels has insufficient bytes left

GenericPixelRect back to summary

GenericPixelRect	back to summary
public GenericPixelRect(final PixelRectangle src) throws IllegalArgumentException, IndexOutOfBoundsException Copy ctor validating src. Exceptions IllegalArgumentException: if `strideInBytes` is invalid. IndexOutOfBoundsException: if `pixels` has insufficient bytes left

public GenericPixelRect(final PixelRectangle src) throws IllegalArgumentException, IndexOutOfBoundsException

Copy ctor validating src.

Exceptions

IllegalArgumentException:: if strideInBytes is invalid.
IndexOutOfBoundsException:: if pixels has insufficient bytes left

Method Detail

getPixelformat back to summary

getPixelformat	back to summary
public PixelFormat getPixelformat() Implements com.jogamp.nativewindow.util.PixelRectangle.getPixelformat. Doc from com.jogamp.nativewindow.util.PixelRectangle.getPixelformat. Returns the `PixelFormat`. Annotations @Override

public PixelFormat getPixelformat()

Implements com.jogamp.nativewindow.util.PixelRectangle.getPixelformat.

Doc from com.jogamp.nativewindow.util.PixelRectangle.getPixelformat.

Returns the PixelFormat.

Annotations

@Override

getPixels	back to summary
public ByteBuffer getPixels() Implements com.jogamp.nativewindow.util.PixelRectangle.getPixels. Doc from com.jogamp.nativewindow.util.PixelRectangle.getPixels. Returns the pixels. Annotations @Override

getPixels

back to summary

public ByteBuffer getPixels()

Implements com.jogamp.nativewindow.util.PixelRectangle.getPixels.

Doc from com.jogamp.nativewindow.util.PixelRectangle.getPixels.

Returns the pixels.

Annotations

@Override

getSize	back to summary
public DimensionImmutable getSize() Implements com.jogamp.nativewindow.util.PixelRectangle.getSize. Doc from com.jogamp.nativewindow.util.PixelRectangle.getSize. Returns the size, i.e. width and height. Annotations @Override

getSize

back to summary

public DimensionImmutable getSize()

Implements com.jogamp.nativewindow.util.PixelRectangle.getSize.

Doc from com.jogamp.nativewindow.util.PixelRectangle.getSize.

Returns the size, i.e. width and height.

Annotations

@Override

getStride back to summary

getStride	back to summary
public int getStride() Implements com.jogamp.nativewindow.util.PixelRectangle.getStride. Doc from com.jogamp.nativewindow.util.PixelRectangle.getStride. Returns stride in byte-size, i.e. byte count from one line to the next. Must be >= `getPixelformat()`.`bytesPerPixel()` * `getSize()`.`getWidth()`. Annotations @Override

public int getStride()

Implements com.jogamp.nativewindow.util.PixelRectangle.getStride.

Doc from com.jogamp.nativewindow.util.PixelRectangle.getStride.

Returns stride in byte-size, i.e. byte count from one line to the next.

Must be >= getPixelformat().bytesPerPixel() * getSize().getWidth().

Annotations

@Override

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements com.jogamp.nativewindow.util.PixelRectangle.hashCode. Doc from com.jogamp.nativewindow.util.PixelRectangle.hashCode. Computes a hash code over: pixelformat size stride isGLOriented pixels The hashCode shall be computed only once with first call and stored for later retrieval to enhance performance. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements com.jogamp.nativewindow.util.PixelRectangle.hashCode.

Doc from com.jogamp.nativewindow.util.PixelRectangle.hashCode.

Computes a hash code over:

pixelformat
size
stride
isGLOriented
pixels

The hashCode shall be computed only once with first call and stored for later retrieval to enhance performance.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

isGLOriented back to summary

isGLOriented	back to summary
public boolean isGLOriented() Implements com.jogamp.nativewindow.util.PixelRectangle.isGLOriented. Doc from com.jogamp.nativewindow.util.PixelRectangle.isGLOriented. Returns `true` if the memory is laid out in OpenGL's coordinate system, origin at bottom left. Otherwise returns `false`, i.e. origin at top left. Annotations @Override

public boolean isGLOriented()

Implements com.jogamp.nativewindow.util.PixelRectangle.isGLOriented.

Doc from com.jogamp.nativewindow.util.PixelRectangle.isGLOriented.

Returns true if the memory is laid out in OpenGL's coordinate system, origin at bottom left. Otherwise returns false, i.e. origin at top left.

Annotations

@Override

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Implements com.jogamp.nativewindow.util.PixelRectangle.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public final String toString()

Overrides java.lang.Object.toString.

Implements com.jogamp.nativewindow.util.PixelRectangle.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations