Package org.lwjgl.glfw

Class GLFWImage

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<GLFWImage>
org.lwjgl.glfw.GLFWImage
All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer
public class GLFWImage extends Struct<GLFWImage> implements NativeResource

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

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • WIDTH

      public static final int WIDTH
      The struct member offsets.

    • HEIGHT

      public static final int HEIGHT
      The struct member offsets.

    • PIXELS

      public static final int PIXELS
      The struct member offsets.

  • Constructor Details

    • GLFWImage

      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 Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<GLFWImage>

    • width

      public int width()
      Returns:
      the value of the width field.

    • height

      public int height()
      Returns:
      the value of the height field.

    • pixels

      public ByteBuffer pixels(int capacity)
      Returns:
      a ByteBuffer view of the data pointed to by the pixels field.

    • width

      public GLFWImage width(int value)
      Sets the specified value to the width field.

    • height

      public GLFWImage height(int value)
      Sets the specified value to the height field.

    • pixels

      public GLFWImage pixels(ByteBuffer value)
      Sets the address of the specified ByteBuffer to the pixels field.

    • set

      public GLFWImage set(int width, int height, 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 new GLFWImage instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static GLFWImage calloc()
      Returns a new GLFWImage instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static GLFWImage create()
      Returns a new GLFWImage instance allocated with BufferUtils.

    • create

      public static GLFWImage create(long address)
      Returns a new GLFWImage instance for the specified memory address.

    • createSafe

      public static @Nullable GLFWImage createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static GLFWImage.Buffer malloc(int capacity)
      Returns a new GLFWImage.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static GLFWImage.Buffer calloc(int capacity)
      Returns a new GLFWImage.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static GLFWImage.Buffer create(int capacity)
      Returns a new GLFWImage.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static GLFWImage.Buffer create(long address, int capacity)
      Create a GLFWImage.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable GLFWImage.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static GLFWImage malloc(MemoryStack stack)
      Returns a new GLFWImage instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      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 - the stack from which to allocate

    • malloc

      public static GLFWImage.Buffer malloc(int capacity, MemoryStack stack)
      Returns a new GLFWImage.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      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 - the buffer capacity
      stack - the stack from which to allocate

    • nwidth

      public static int nwidth(long struct)
      Unsafe version of width().

    • nheight

      public static int nheight(long struct)
      Unsafe version of height().

    • npixels

      public static ByteBuffer npixels(long struct, int capacity)
      Unsafe version of pixels.

    • nwidth

      public static void nwidth(long struct, int value)
      Unsafe version of width.

    • nheight

      public static void nheight(long struct, int value)
      Unsafe version of height.

    • npixels

      public static void npixels(long struct, ByteBuffer value)
      Unsafe version of pixels.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate