JOGL 2.3.2 · jogamp.newt.PointerIconImpl

Modifier and Type	Field and Description
private final DisplayImpl	display
private long	handle
private int	hashCode
private volatile boolean	hashCodeComputed
private final PointImmutable	hotspot
private final PixelFormat	pixelformat
private final ByteBuffer	pixels
private final DimensionImmutable	size

Access	Constructor and Description
public	PointerIconImpl(final DisplayImpl display, final PixelFormat pixelformat, final DimensionImmutable size, final ByteBuffer pixels, final PointImmutable hotspot, final long handle)
public	PointerIconImpl(final DisplayImpl display, final PixelRectangle pixelrect, final PointImmutable hotspot, final long handle)

Method Summary

Modifier and Type	Method and Description
public synchronized void	destroy() Implements com.jogamp.newt.Display.PointerIcon.destroy. Destroys this instance.
pack-priv synchronized void	destroyOnEDT(final long dpy) No checks, assume execution on EDT
public final Display	getDisplay() Implements com.jogamp.newt.Display.PointerIcon.getDisplay.
public final synchronized long	getHandle()
public final PointImmutable	getHotspot() Implements com.jogamp.newt.Display.PointerIcon.getHotspot. Returns the hotspot.
public final PixelFormat	getPixelformat() Implements com.jogamp.nativewindow.util.PixelRectangle.getPixelformat. Returns the `PixelFormat`.
public final ByteBuffer	getPixels() Implements com.jogamp.nativewindow.util.PixelRectangle.getPixels. Returns the pixels.
public final DimensionImmutable	getSize() Implements com.jogamp.nativewindow.util.PixelRectangle.getSize. Returns the size, i.e. width and height.
public final int	getStride() Implements com.jogamp.newt.Display.PointerIcon.getStride. Always neatly packed, i.e. width * bytes_per_pixel.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements com.jogamp.newt.Display.PointerIcon.hashCode. Computes a hash code over: display pixelformat size stride isGLOriented pixels hotspot
public final boolean	isGLOriented() Implements com.jogamp.newt.Display.PointerIcon.isGLOriented. Always false, i.e. origin is TOP-LEFT.
public final synchronized boolean	isValid() Implements com.jogamp.newt.Display.PointerIcon.isValid. Returns true if valid, otherwise false.
public final String	toString() Overrides java.lang.Object.toString. Implements com.jogamp.nativewindow.util.PixelRectangle.toString. Returns a string representation of the object.
public final synchronized boolean	validate() Implements com.jogamp.newt.Display.PointerIcon.validate. Returns true if instance `isValid()` or validation was successful, otherwise false.
public final synchronized long	validatedHandle()

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

display	back to summary
private final DisplayImpl display

handle	back to summary
private long handle

hashCode	back to summary
private int hashCode

hashCodeComputed	back to summary
private volatile boolean hashCodeComputed

hotspot	back to summary
private final PointImmutable hotspot

pixelformat	back to summary
private final PixelFormat pixelformat

pixels	back to summary
private final ByteBuffer pixels

size	back to summary
private final DimensionImmutable size

PointerIconImpl	back to summary
public PointerIconImpl(final DisplayImpl display, final PixelFormat pixelformat, final DimensionImmutable size, final ByteBuffer pixels, final PointImmutable hotspot, final long handle)

PointerIconImpl	back to summary
public PointerIconImpl(final DisplayImpl display, final PixelRectangle pixelrect, final PointImmutable hotspot, final long handle)

Method Detail

destroy back to summary

destroy	back to summary
public synchronized void destroy() Implements com.jogamp.newt.Display.PointerIcon.destroy. Doc from com.jogamp.newt.Display.PointerIcon.destroy. Destroys this instance. Will be called automatically if it's `associated Display` is destroyed. Annotations @Override

public synchronized void destroy()

Implements com.jogamp.newt.Display.PointerIcon.destroy.

Doc from com.jogamp.newt.Display.PointerIcon.destroy.

Destroys this instance.

Will be called automatically if it's associated Display is destroyed.

Annotations

@Override

destroyOnEDT	back to summary
pack-priv synchronized void destroyOnEDT(final long dpy) No checks, assume execution on EDT

getDisplay	back to summary
public final Display getDisplay() Implements com.jogamp.newt.Display.PointerIcon.getDisplay. Returns:Display Doc from com.jogamp.newt.Display.PointerIcon.getDisplay. the associated Display Annotations @Override

getDisplay

back to summary

public final Display getDisplay()

Implements com.jogamp.newt.Display.PointerIcon.getDisplay.

Returns:Display

Doc from com.jogamp.newt.Display.PointerIcon.getDisplay.

the associated Display

Annotations

@Override

getHandle	back to summary
public final synchronized long getHandle()

getHotspot	back to summary
public final PointImmutable getHotspot() Implements com.jogamp.newt.Display.PointerIcon.getHotspot. Doc from com.jogamp.newt.Display.PointerIcon.getHotspot. Returns the hotspot. Annotations @Override

getHotspot

back to summary

public final PointImmutable getHotspot()

Implements com.jogamp.newt.Display.PointerIcon.getHotspot.

Doc from com.jogamp.newt.Display.PointerIcon.getHotspot.

Returns the hotspot.

Annotations

@Override

getPixelformat back to summary

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

public final 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 final 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 final 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 final 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 final 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 final int getStride() Implements com.jogamp.newt.Display.PointerIcon.getStride. Doc from com.jogamp.newt.Display.PointerIcon.getStride. Always neatly packed, i.e. width * bytes_per_pixel. Returns stride in byte-size, i.e. byte count from one line to the next. Must be >= `getPixelformat()`.`bytesPerPixel()` * `getSize()`.`getWidth()`. Annotations @Override

public final int getStride()

Implements com.jogamp.newt.Display.PointerIcon.getStride.

Doc from com.jogamp.newt.Display.PointerIcon.getStride.

Always neatly packed, i.e. width * bytes_per_pixel.

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.newt.Display.PointerIcon.hashCode. Doc from com.jogamp.newt.Display.PointerIcon.hashCode. Computes a hash code over: display pixelformat size stride isGLOriented pixels hotspot Dismissing the native handle! The hashCode shall be computed only once with first call and stored for later retrieval to enhance performance. 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.newt.Display.PointerIcon.hashCode.

Doc from com.jogamp.newt.Display.PointerIcon.hashCode.

Computes a hash code over:

display
pixelformat
size
stride
isGLOriented
pixels
hotspot

Dismissing the native handle!

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

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 final boolean isGLOriented() Implements com.jogamp.newt.Display.PointerIcon.isGLOriented. Doc from com.jogamp.newt.Display.PointerIcon.isGLOriented. Always false, i.e. origin is TOP-LEFT. 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 final boolean isGLOriented()

Implements com.jogamp.newt.Display.PointerIcon.isGLOriented.

Doc from com.jogamp.newt.Display.PointerIcon.isGLOriented.

Always false, i.e. origin is TOP-LEFT.

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

isValid back to summary

isValid	back to summary
public final synchronized boolean isValid() Implements com.jogamp.newt.Display.PointerIcon.isValid. Doc from com.jogamp.newt.Display.PointerIcon.isValid. Returns true if valid, otherwise false. A PointerIcon instance becomes invalid if it's `associated Display` is destroyed. Annotations @Override

public final synchronized boolean isValid()

Implements com.jogamp.newt.Display.PointerIcon.isValid.

Doc from com.jogamp.newt.Display.PointerIcon.isValid.

Returns true if valid, otherwise false.

A PointerIcon instance becomes invalid if it's associated Display is destroyed.

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

@Override

validate back to summary

validate	back to summary
public final synchronized boolean validate() Implements com.jogamp.newt.Display.PointerIcon.validate. Doc from com.jogamp.newt.Display.PointerIcon.validate. Returns true if instance `isValid()` or validation was successful, otherwise false. Validation, i.e. recreation, is required if instance became invalid, see `isValid()`. Annotations @Override

public final synchronized boolean validate()

Implements com.jogamp.newt.Display.PointerIcon.validate.

Doc from com.jogamp.newt.Display.PointerIcon.validate.

Returns true if instance isValid() or validation was successful, otherwise false.

Validation, i.e. recreation, is required if instance became invalid, see isValid().

Annotations

@Override

validatedHandle	back to summary
public final synchronized long validatedHandle()

public Class PointerIconImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail