Package org.lwjgl.glfw
Class GLFWImage
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
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(int)
;
}
- Since:
- version 2.1
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionGLFWImage
(ByteBuffer container) Creates aGLFWImage
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic GLFWImage
calloc()
Returns a newGLFWImage
instance allocated withmemCalloc
.static GLFWImage.Buffer
calloc
(int capacity) Returns a newGLFWImage.Buffer
instance allocated withmemCalloc
.static GLFWImage.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newGLFWImage.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static GLFWImage
calloc
(MemoryStack stack) Returns a newGLFWImage
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static GLFWImage
Deprecated.static GLFWImage.Buffer
callocStack
(int capacity) Deprecated.static GLFWImage.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static GLFWImage
callocStack
(MemoryStack stack) Deprecated.static GLFWImage
create()
Returns a newGLFWImage
instance allocated withBufferUtils
.static GLFWImage.Buffer
create
(int capacity) Returns a newGLFWImage.Buffer
instance allocated withBufferUtils
.static GLFWImage
create
(long address) Returns a newGLFWImage
instance for the specified memory address.static GLFWImage.Buffer
create
(long address, int capacity) Create aGLFWImage.Buffer
instance at the specified memory.static GLFWImage
createSafe
(long address) static GLFWImage.Buffer
createSafe
(long address, int capacity) int
height()
the height, in pixels, of this imageheight
(int value) Sets the specified value to theheight()
field.static GLFWImage
malloc()
Returns a newGLFWImage
instance allocated withmemAlloc
.static GLFWImage.Buffer
malloc
(int capacity) Returns a newGLFWImage.Buffer
instance allocated withmemAlloc
.static GLFWImage.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newGLFWImage.Buffer
instance allocated on the specifiedMemoryStack
.static GLFWImage
malloc
(MemoryStack stack) Returns a newGLFWImage
instance allocated on the specifiedMemoryStack
.static GLFWImage
Deprecated.static GLFWImage.Buffer
mallocStack
(int capacity) Deprecated.static GLFWImage.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static GLFWImage
mallocStack
(MemoryStack stack) Deprecated.static int
nheight
(long struct) Unsafe version ofheight()
.static void
nheight
(long struct, int value) Unsafe version ofheight
.static ByteBuffer
npixels
(long struct, int capacity) Unsafe version ofpixels
.static void
npixels
(long struct, ByteBuffer value) Unsafe version ofpixels
.static int
nwidth
(long struct) Unsafe version ofwidth()
.static void
nwidth
(long struct, int value) Unsafe version ofwidth
.pixels
(int capacity) pixels
(ByteBuffer value) Sets the address of the specifiedByteBuffer
to thepixels(int)
field.set
(int width, int height, ByteBuffer pixels) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.static void
validate
(long struct) Validates pointer members that should not beNULL
.int
width()
the width, in pixels, of this imagewidth
(int value) Sets the specified value to thewidth()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
WIDTH
public static final int WIDTHThe struct member offsets. -
HEIGHT
public static final int HEIGHTThe struct member offsets. -
PIXELS
public static final int PIXELSThe struct member offsets.
-
-
Constructor Details
-
GLFWImage
Creates aGLFWImage
instance at the current position of the specifiedByteBuffer
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
. -
width
public int width()the width, in pixels, of this image -
height
public int height()the height, in pixels, of this image -
pixels
- Parameters:
capacity
- the number of elements in the returned buffer- Returns:
- the pixel data of this image, arranged left-to-right, top-to-bottom
-
width
Sets the specified value to thewidth()
field. -
height
Sets the specified value to theheight()
field. -
pixels
Sets the address of the specifiedByteBuffer
to thepixels(int)
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newGLFWImage
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newGLFWImage
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newGLFWImage
instance allocated withBufferUtils
. -
create
Returns a newGLFWImage
instance for the specified memory address. -
createSafe
-
malloc
Returns a newGLFWImage.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newGLFWImage.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newGLFWImage.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aGLFWImage.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newGLFWImage
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newGLFWImage
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newGLFWImage.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newGLFWImage.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nwidth
public static int nwidth(long struct) Unsafe version ofwidth()
. -
nheight
public static int nheight(long struct) Unsafe version ofheight()
. -
npixels
Unsafe version ofpixels
. -
nwidth
public static void nwidth(long struct, int value) Unsafe version ofwidth
. -
nheight
public static void nheight(long struct, int value) Unsafe version ofheight
. -
npixels
Unsafe version ofpixels
. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-