Module overrungl.glfw

Package overrungl.glfw

Class GLFWImage

java.lang.Object

overrungl.Pointer

overrungl.Struct

overrungl.glfw.GLFWImage

All Implemented Interfaces:

Addressable

Direct Known Subclasses:

GLFWImage.Buffer

public class GLFWImage
extends Struct

GLFWImage relies on preview features of the Java platform:

• GLFWImage refers to one or more preview APIs: MemoryLayout, MemorySegment, SegmentAllocator, StructLayout.

Programs can only use GLFWImage when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

This describes a single 2D image. See the documentation for each related function what the expected pixel format is.

Layout

 struct GLFWimage {
     int width;
     int height;
     unsigned char* pixelsPREVIEW;
 }

Since:

0.1.0

Author:

squid233

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GLFWImage.Buffer	This describes 2D images.

Field Summary

Fields

Modifier and Type	Field	Description
static final StructLayoutPREVIEW	LAYOUT	The struct layout.

Fields inherited from class overrungl.Struct

layout

Fields inherited from class overrungl.Pointer

address, allocator, managedSegment

Constructor Summary

Constructors

Modifier	Constructor	Description
	GLFWImage(MemorySegmentPREVIEW address, SegmentAllocatorPREVIEW allocator)	Create a GLFWimage instance.
protected	GLFWImage(MemorySegmentPREVIEW address, SegmentAllocatorPREVIEW allocator, MemoryLayoutPREVIEW layout)	Creates a struct instance with the given memory layout.

Method Summary

Modifier and Type	Method	Description
static GLFWImage	create(SegmentAllocatorPREVIEW allocator)	Creates a GLFWImage instance with the given allocator.
static GLFWImage.Buffer	create(SegmentAllocatorPREVIEW allocator, long count)	Creates a GLFWImage.Buffer instance with the given allocator and count.
int	height()	Gets the image height.
GLFWImage	height(int height)	Sets the image height.
MemorySegmentPREVIEW	pixels()	Gets the image pixels address.
GLFWImage	pixels(MemorySegmentPREVIEW pixels)	Sets the image pixels address.
int	width()	Gets the image width.
GLFWImage	width(int width)	Sets the image width.

Methods inherited from class overrungl.Struct

layout, segment, sizeof

Methods inherited from class overrungl.Pointer

address, allocator, segment, segment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LAYOUT

public static final StructLayoutPREVIEW LAYOUT

The struct layout.

Constructor Details

GLFWImage

public GLFWImage(MemorySegmentPREVIEW address,
 SegmentAllocatorPREVIEW allocator)

Create a GLFWimage instance.

Parameters:

address - the address.

allocator - the allocator of this address.

GLFWImage

protected GLFWImage(MemorySegmentPREVIEW address,
 SegmentAllocatorPREVIEW allocator,
 MemoryLayoutPREVIEW layout)

Creates a struct instance with the given memory layout.

Parameters:

address - the address.

allocator - the allocator of this address.

layout - the memory layout of this struct.

Method Details

create

public static GLFWImage create(SegmentAllocatorPREVIEW allocator)

Creates a GLFWImage instance with the given allocator.

Parameters:

allocator - the allocator

Returns:

the instance

create

public static GLFWImage.Buffer create(SegmentAllocatorPREVIEW allocator,
 long count)

Creates a GLFWImage.Buffer instance with the given allocator and count.

Parameters:

allocator - the allocator

count - the count

Returns:

the instance

width

public GLFWImage width(int width)

Sets the image width.

Parameters:

width - The width, in pixels, of this image.

Returns:

this

height

public GLFWImage height(int height)

Sets the image height.

Parameters:

height - The height, in pixels, of this image.

Returns:

this

pixels

public GLFWImage pixels(MemorySegmentPREVIEW pixels)

Sets the image pixels address.

Parameters:

pixels - The pixel data address of this image, arranged left-to-right, top-to-bottom.

Returns:

this

width

public int width()

Gets the image width.

Returns:

The width, in pixels, of this image.

height

public int height()

Gets the image height.

Returns:

The height, in pixels, of this image.

pixels

public MemorySegmentPREVIEW pixels()

Gets the image pixels address.

Returns:

The pixel data address of this image, arranged left-to-right, top-to-bottom.