Interface Display.PointerIcon
-
- All Superinterfaces:
PixelRectangle
- Enclosing class:
- Display
public static interface Display.PointerIcon extends PixelRectangle
Native PointerIcon handle.Instances can be created via
Display'screatePointerIcon(pngResource, ..)orcreatePointerIcon(pixelrect, ..).Instance is
destroy()'ed automatically if it'sassociated Displayis destroyed.Instance can be re-validated after destruction via
#validate().Display.PointerIconmust not bedestroyedwhile in use!Display.PointerIconmay bedestroyedmanually after use, i.e. when noWindowuses themanymore. However, this is not required.PointerIcons can be used via
Window.setPointerIcon(PointerIcon).
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.jogamp.nativewindow.util.PixelRectangle
PixelRectangle.GenericPixelRect
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voiddestroy()Destroys this instance.DisplaygetDisplay()PointImmutablegetHotspot()Returns the hotspot.intgetStride()Always neatly packed, i.e.inthashCode()Computes a hash code over: display pixelformat size stride isGLOriented pixels hotspot Dismissing the native handle!booleanisGLOriented()Always false, i.e.booleanisValid()Returns true if valid, otherwise false.-
Methods inherited from interface com.jogamp.nativewindow.util.PixelRectangle
getPixelformat, getPixels, getSize, toString
-
-
-
-
Method Detail
-
getStride
int 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 >=
PixelRectangle.getPixelformat().bytesPerPixel()*PixelRectangle.getSize().getWidth().- Specified by:
getStridein interfacePixelRectangle
-
isGLOriented
boolean isGLOriented()
Always false, i.e. origin is TOP-LEFT.Returns
trueif the memory is laid out in OpenGL's coordinate system, origin at bottom left. Otherwise returnsfalse, i.e. origin at top left.- Specified by:
isGLOrientedin interfacePixelRectangle
-
hashCode
int hashCode()
Computes a hash code over:- display
- pixelformat
- size
- stride
- isGLOriented
- pixels
- hotspot
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.
- Specified by:
hashCodein interfacePixelRectangle- Overrides:
hashCodein classObject
-
getDisplay
Display getDisplay()
- Returns:
- the associated Display
-
getHotspot
PointImmutable getHotspot()
Returns the hotspot.
-
isValid
boolean isValid()
Returns true if valid, otherwise false.A PointerIcon instance becomes invalid if it's
associated Displayis destroyed.
-
destroy
void destroy()
Destroys this instance.Will be called automatically if it's
associated Displayis destroyed.
-
-