Top Description Inners Fields Constructors Methods
org.lwjgl.glfw

public Class GLFWImage

extends Struct<GLFWImage>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct GLFWimage
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Image data.

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

Layout


struct GLFWimage {
    int width;
    int height;
    unsigned char * pixels;
}
Since
version 2.1

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
GLFWImage.Buffer

An array of GLFWImage structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HEIGHT

The struct member offsets.

public static final int
PIXELS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
GLFWImage(long address, ByteBuffer container)

public
GLFWImage(ByteBuffer container)

Creates a GLFWImage instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static GLFWImage
calloc()

Returns a new GLFWImage instance allocated with memCalloc.

public static GLFWImage.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new GLFWImage.Buffer instance allocated with memCalloc.

public static GLFWImage
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new GLFWImage instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static GLFWImage.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new GLFWImage.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static GLFWImage
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static GLFWImage
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static GLFWImage.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static GLFWImage.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected GLFWImage
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static GLFWImage
create()

Returns a new GLFWImage instance allocated with BufferUtils.

public static GLFWImage
create(long address)

Returns a new GLFWImage instance for the specified memory address.

public static GLFWImage.Buffer
create(int
the buffer capacity
capacity
)

Returns a new GLFWImage.Buffer instance allocated with BufferUtils.

public static GLFWImage.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a GLFWImage.Buffer instance at the specified memory.

public static GLFWImage
createSafe(long address)

Like create, but returns null if address is NULL.

public static GLFWImage.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
height()

the height, in pixels, of this image

public GLFWImage
height(int value)

Sets the specified value to the height field.

public static GLFWImage
malloc()

Returns a new GLFWImage instance allocated with memAlloc.

public static GLFWImage.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new GLFWImage.Buffer instance allocated with memAlloc.

public static GLFWImage
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new GLFWImage instance allocated on the specified MemoryStack.

public static GLFWImage.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new GLFWImage.Buffer instance allocated on the specified MemoryStack.

public static GLFWImage
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static GLFWImage
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static GLFWImage.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static GLFWImage.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nheight(long struct)

Unsafe version of height.

public static void
nheight(long struct, int value)

Unsafe version of height.

public static ByteBuffer
npixels(long struct, int capacity)

Unsafe version of pixels.

public static void
npixels(long struct, ByteBuffer value)

Unsafe version of pixels.

public static int
nwidth(long struct)

Unsafe version of width.

public static void
nwidth(long struct, int value)

Unsafe version of width.

public ByteBuffer

Returns:

the pixel data of this image, arranged left-to-right, top-to-bottom
pixels
(int
the number of elements in the returned buffer
capacity
)

public GLFWImage
pixels(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pixels field.

public GLFWImage
set(int width, int height, ByteBuffer pixels)

Initializes this struct with the specified values.

public GLFWImage

Returns:

this struct
set
(GLFWImage
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

public int
width()

the width, in pixels, of this image

public GLFWImage
width(int value)

Sets the specified value to the width field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

HEIGHTback to summary
public static final int HEIGHT

The struct member offsets.

PIXELSback to summary
public static final int PIXELS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

WIDTHback to summary
public static final int WIDTH

The struct member offsets.

Constructor Detail

GLFWImageback to summary
protected GLFWImage(long address, ByteBuffer container)
GLFWImageback to summary
public GLFWImage(ByteBuffer container)

Creates a GLFWImage instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

callocback to summary
public static GLFWImage calloc()

Returns a new GLFWImage instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static GLFWImage.Buffer calloc(int capacity)

Returns a new GLFWImage.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static GLFWImage calloc(MemoryStack stack)

Returns a new GLFWImage instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static GLFWImage.Buffer calloc(int capacity, MemoryStack stack)

Returns a new GLFWImage.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static GLFWImage callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static GLFWImage callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static GLFWImage.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static GLFWImage.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected GLFWImage create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static GLFWImage create()

Returns a new GLFWImage instance allocated with BufferUtils.

createback to summary
public static GLFWImage create(long address)

Returns a new GLFWImage instance for the specified memory address.

createback to summary
public static GLFWImage.Buffer create(int capacity)

Returns a new GLFWImage.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static GLFWImage.Buffer create(long address, int capacity)

Create a GLFWImage.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static GLFWImage createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static GLFWImage.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
heightback to summary
public int height()

the height, in pixels, of this image

heightback to summary
public GLFWImage height(int value)

Sets the specified value to the height field.

mallocback to summary
public static GLFWImage malloc()

Returns a new GLFWImage instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static GLFWImage.Buffer malloc(int capacity)

Returns a new GLFWImage.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static GLFWImage malloc(MemoryStack stack)

Returns a new GLFWImage instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static GLFWImage.Buffer malloc(int capacity, MemoryStack stack)

Returns a new GLFWImage.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static GLFWImage mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static GLFWImage mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static GLFWImage.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static GLFWImage.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nheightback to summary
public static int nheight(long struct)

Unsafe version of height.

nheightback to summary
public static void nheight(long struct, int value)

Unsafe version of height.

npixelsback to summary
public static ByteBuffer npixels(long struct, int capacity)

Unsafe version of pixels.

npixelsback to summary
public static void npixels(long struct, ByteBuffer value)

Unsafe version of pixels.

nwidthback to summary
public static int nwidth(long struct)

Unsafe version of width.

nwidthback to summary
public static void nwidth(long struct, int value)

Unsafe version of width.

pixelsback to summary
public ByteBuffer pixels(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

the pixel data of this image, arranged left-to-right, top-to-bottom

Annotations
@NativeType:unsigned char *
pixelsback to summary
public GLFWImage pixels(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pixels field.

setback to summary
public GLFWImage set(int width, int height, ByteBuffer pixels)

Initializes this struct with the specified values.

setback to summary
public GLFWImage set(GLFWImage src)

Copies the specified struct data to this struct.

Parameters
src:GLFWImage

the source struct

Returns:GLFWImage

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

widthback to summary
public int width()

the width, in pixels, of this image

widthback to summary
public GLFWImage width(int value)

Sets the specified value to the width field.

org.lwjgl.glfw back to summary

public Class GLFWImage.Buffer

extends StructBuffer<GLFWImage, GLFWImage.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of GLFWImage structs.

Field Summary

Modifier and TypeField and Description
private static final GLFWImage

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new GLFWImage.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected GLFWImage
public int

Returns:

the value of the GLFWImage#height field.
height
()

public GLFWImage.Buffer
height(int value)

Sets the specified value to the GLFWImage#height field.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the GLFWImage#pixels field.
pixels
(int
the number of elements in the returned buffer
capacity
)

public GLFWImage.Buffer
pixels(ByteBuffer value)

Sets the address of the specified ByteBuffer to the GLFWImage#pixels field.

protected GLFWImage.Buffer
public int

Returns:

the value of the GLFWImage#width field.
width
()

public GLFWImage.Buffer
width(int value)

Sets the specified value to the GLFWImage#width field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final GLFWImage ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new GLFWImage.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by GLFWImage#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected GLFWImage getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
heightback to summary
public int height()
Returns:int

the value of the GLFWImage#height field.

heightback to summary
public GLFWImage.Buffer height(int value)

Sets the specified value to the GLFWImage#height field.

pixelsback to summary
public ByteBuffer pixels(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the GLFWImage#pixels field.

Annotations
@NativeType:unsigned char *
pixelsback to summary
public GLFWImage.Buffer pixels(ByteBuffer value)

Sets the address of the specified ByteBuffer to the GLFWImage#pixels field.

selfback to summary
protected GLFWImage.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
widthback to summary
public int width()
Returns:int

the value of the GLFWImage#width field.

widthback to summary
public GLFWImage.Buffer width(int value)

Sets the specified value to the GLFWImage#width field.