JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.newt.Display.PointerIcon Interface Reference

Native PointerIcon handle. More...

Inheritance diagram for com.jogamp.newt.Display.PointerIcon:
Collaboration diagram for com.jogamp.newt.Display.PointerIcon:

Public Member Functions

int getStride ()
 Always neatly packed, i.e. More...
 
boolean isGLOriented ()
 Always false, i.e. More...
 
int hashCode ()
 Computes a hash code over: More...
 
Display getDisplay ()
 
PointImmutable getHotspot ()
 Returns the hotspot. More...
 
boolean isValid ()
 Returns true if valid, otherwise false. More...
 
void destroy ()
 Destroys this instance. More...
 
- Public Member Functions inherited from com.jogamp.nativewindow.util.PixelRectangle
int hashCode ()
 
PixelFormat getPixelformat ()
 Returns the PixelFormat. More...
 
DimensionImmutable getSize ()
 Returns the size, i.e. More...
 
int getStride ()
 Returns stride in byte-size, i.e. More...
 
boolean isGLOriented ()
 Returns true if the memory is laid out in OpenGL's coordinate system, origin at bottom left. More...
 
ByteBuffer getPixels ()
 Returns the pixels. More...
 
String toString ()
 

Detailed Description

Native PointerIcon handle.

Instances can be created via Display's createPointerIcon(pngResource, ..) or createPointerIcon(pixelrect, ..).

Instance is destroy()'ed automatically if it's associated Display is destroyed.

Instance can be re-validated after destruction via validate().

PointerIcon must not be destroyed while in use!

PointerIcon may be destroyed manually after use, i.e. when no Window uses them anymore. However, this is not required.

PointerIcons can be used via Window#setPointerIcon(PointerIcon).

Definition at line 92 of file Display.java.

Member Function Documentation

◆ destroy()

void com.jogamp.newt.Display.PointerIcon.destroy ( )

Destroys this instance.

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

◆ getDisplay()

Display com.jogamp.newt.Display.PointerIcon.getDisplay ( )
Returns
the associated Display

◆ getHotspot()

PointImmutable com.jogamp.newt.Display.PointerIcon.getHotspot ( )

Returns the hotspot.

◆ getStride()

int 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().

Implements com.jogamp.nativewindow.util.PixelRectangle.

◆ hashCode()

int 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.

Implements com.jogamp.nativewindow.util.PixelRectangle.

◆ isGLOriented()

boolean 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.

Implements com.jogamp.nativewindow.util.PixelRectangle.

◆ isValid()

boolean com.jogamp.newt.Display.PointerIcon.isValid ( )

Returns true if valid, otherwise false.

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


The documentation for this interface was generated from the following file: