JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.nativewindow.util.PixelRectangle Interface Reference

Pixel Rectangle identified by it's hashCode(). More...

Inheritance diagram for com.jogamp.nativewindow.util.PixelRectangle:
Collaboration diagram for com.jogamp.nativewindow.util.PixelRectangle:

Classes

class  GenericPixelRect
 Generic PixelRectangle implementation. More...
 

Public Member Functions

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

Pixel Rectangle identified by it's hashCode().

The getPixels() are assumed to be immutable.

Definition at line 38 of file PixelRectangle.java.

Member Function Documentation

◆ getPixelformat()

PixelFormat com.jogamp.nativewindow.util.PixelRectangle.getPixelformat ( )

◆ getPixels()

ByteBuffer com.jogamp.nativewindow.util.PixelRectangle.getPixels ( )

Returns the pixels.

Implemented in com.jogamp.nativewindow.util.PixelRectangle.GenericPixelRect.

Here is the caller graph for this function:

◆ getSize()

DimensionImmutable com.jogamp.nativewindow.util.PixelRectangle.getSize ( )

Returns the size, i.e.

width and height.

Implemented in com.jogamp.nativewindow.util.PixelRectangle.GenericPixelRect.

Here is the caller graph for this function:

◆ getStride()

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

Implemented in com.jogamp.nativewindow.util.PixelRectangle.GenericPixelRect, and com.jogamp.newt.Display.PointerIcon.

◆ hashCode()

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

Implemented in com.jogamp.nativewindow.util.PixelRectangle.GenericPixelRect, and com.jogamp.newt.Display.PointerIcon.

◆ isGLOriented()

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

Implemented in com.jogamp.nativewindow.util.PixelRectangle.GenericPixelRect, and com.jogamp.newt.Display.PointerIcon.

◆ toString()

String com.jogamp.nativewindow.util.PixelRectangle.toString ( )

Implemented in com.jogamp.nativewindow.util.PixelRectangle.GenericPixelRect.

Here is the caller graph for this function:

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