Package org.lwjgl.glfw
Class GLFWImage
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.glfw.GLFWImage
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class GLFWImage extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
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()
; intheight()
; unsigned char *pixels(int)
; }- Since:
- version 2.1
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GLFWImage.Buffer
An array ofGLFWImage
structs.
-
Constructor Summary
Constructors Constructor Description GLFWImage(java.nio.ByteBuffer container)
Creates aGLFWImage
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static 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, org.lwjgl.system.MemoryStack stack)
Returns a newGLFWImage.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static GLFWImage
calloc(org.lwjgl.system.MemoryStack stack)
Returns a newGLFWImage
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static GLFWImage
callocStack()
Deprecated.static GLFWImage.Buffer
callocStack(int capacity)
Deprecated.static GLFWImage.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.static GLFWImage
callocStack(org.lwjgl.system.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 imageGLFWImage
height(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, org.lwjgl.system.MemoryStack stack)
Returns a newGLFWImage.Buffer
instance allocated on the specifiedMemoryStack
.static GLFWImage
malloc(org.lwjgl.system.MemoryStack stack)
Returns a newGLFWImage
instance allocated on the specifiedMemoryStack
.static GLFWImage
mallocStack()
Deprecated.static GLFWImage.Buffer
mallocStack(int capacity)
Deprecated.static GLFWImage.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.static GLFWImage
mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.static int
nheight(long struct)
Unsafe version ofheight()
.static void
nheight(long struct, int value)
Unsafe version ofheight
.static java.nio.ByteBuffer
npixels(long struct, int capacity)
Unsafe version ofpixels
.static void
npixels(long struct, java.nio.ByteBuffer value)
Unsafe version ofpixels
.static int
nwidth(long struct)
Unsafe version ofwidth()
.static void
nwidth(long struct, int value)
Unsafe version ofwidth
.java.nio.ByteBuffer
pixels(int capacity)
GLFWImage
pixels(java.nio.ByteBuffer value)
Sets the address of the specifiedByteBuffer
to thepixels(int)
field.GLFWImage
set(int width, int height, java.nio.ByteBuffer pixels)
Initializes this struct with the specified values.GLFWImage
set(GLFWImage src)
Copies the specified struct data to this struct.int
sizeof()
static void
validate(long struct)
Validates pointer members that should not beNULL
.int
width()
the width, in pixels, of this imageGLFWImage
width(int value)
Sets the specified value to thewidth()
field.
-
-
-
Constructor Detail
-
GLFWImage
public GLFWImage(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
width
public int width()
the width, in pixels, of this image
-
height
public int height()
the height, in pixels, of this image
-
pixels
public java.nio.ByteBuffer pixels(int capacity)
- Parameters:
capacity
- the number of elements in the returned buffer- Returns:
- the pixel data of this image, arranged left-to-right, top-to-bottom
-
pixels
public GLFWImage pixels(java.nio.ByteBuffer value)
Sets the address of the specifiedByteBuffer
to thepixels(int)
field.
-
set
public GLFWImage set(int width, int height, java.nio.ByteBuffer pixels)
Initializes this struct with the specified values.
-
set
public GLFWImage set(GLFWImage src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static GLFWImage malloc()
Returns a newGLFWImage
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static GLFWImage calloc()
Returns a newGLFWImage
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static GLFWImage create()
Returns a newGLFWImage
instance allocated withBufferUtils
.
-
create
public static GLFWImage create(long address)
Returns a newGLFWImage
instance for the specified memory address.
-
createSafe
@Nullable public static GLFWImage createSafe(long address)
-
malloc
public static GLFWImage.Buffer malloc(int capacity)
Returns a newGLFWImage.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static GLFWImage.Buffer calloc(int capacity)
Returns a newGLFWImage.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static GLFWImage.Buffer create(int capacity)
Returns a newGLFWImage.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static GLFWImage.Buffer create(long address, int capacity)
Create aGLFWImage.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static GLFWImage.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static GLFWImage mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead.
-
callocStack
@Deprecated public static GLFWImage callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead.
-
mallocStack
@Deprecated public static GLFWImage mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead.
-
callocStack
@Deprecated public static GLFWImage callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead.
-
mallocStack
@Deprecated public static GLFWImage.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead.
-
callocStack
@Deprecated public static GLFWImage.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead.
-
mallocStack
@Deprecated public static GLFWImage.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead.
-
callocStack
@Deprecated public static GLFWImage.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead.
-
malloc
public static GLFWImage malloc(org.lwjgl.system.MemoryStack stack)
Returns a newGLFWImage
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
public static GLFWImage calloc(org.lwjgl.system.MemoryStack stack)
Returns a newGLFWImage
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
public static GLFWImage.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newGLFWImage.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
calloc
public static GLFWImage.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newGLFWImage.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nwidth
public static int nwidth(long struct)
Unsafe version ofwidth()
.
-
nheight
public static int nheight(long struct)
Unsafe version ofheight()
.
-
npixels
public static java.nio.ByteBuffer npixels(long struct, int capacity)
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
public static void npixels(long struct, java.nio.ByteBuffer value)
Unsafe version ofpixels
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
-