Package org.lwjgl.egl

Class EGLClientPixmapHI

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class EGLClientPixmapHI
    extends Struct
    implements NativeResource
    Specifies the width, height, stride, format and memory pointer of the pixmap to be used by the function CreatePixmapSurfaceHI to create the PixmapSurface.

    Member documentation

    • pData – pointer to a memory buffer allocated by the application that will contain the result of the drawing operations. It is up to the application to ensure that the buffer size corresponds to iHeight * iStride * sizeof(pixel).
    • iWidth – width of the buffer in pixels
    • iHeight – height of the buffer in pixels. The height of the buffer can be negative; in that case the result of the drawing operations will be vertically swapped. When positive, pData will point at the bottom-left corner of the image; when negative, to the top-left corner.
    • iStride – stride of the buffer, in pixels. It is important to note that each row of the buffer must start on 32-bit boundaries.

    Layout

    
     struct EGLClientPixmapHI {
         void * pData;
         EGLint iWidth;
         EGLint iHeight;
         EGLint iStride;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • PDATA, IWIDTH, IHEIGHT, ISTRIDE

        The struct member offsets.
    • Constructor Detail

      • EGLClientPixmapHI

        public EGLClientPixmapHI​(java.nio.ByteBuffer container)
        Creates a EGLClientPixmapHI 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

      • sizeof

        public int sizeof()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • pData

        public java.nio.ByteBuffer pData​(int capacity)
        Returns a ByteBuffer view of the data pointed to by the pData field.
        Parameters:
        capacity - the number of elements in the returned buffer
      • iWidth

        public int iWidth()
        Returns the value of the iWidth field.
      • iHeight

        public int iHeight()
        Returns the value of the iHeight field.
      • iStride

        public int iStride()
        Returns the value of the iStride field.
      • pData

        public EGLClientPixmapHI pData​(java.nio.ByteBuffer value)
        Sets the address of the specified ByteBuffer to the pData field.
      • iWidth

        public EGLClientPixmapHI iWidth​(int value)
        Sets the specified value to the iWidth field.
      • iHeight

        public EGLClientPixmapHI iHeight​(int value)
        Sets the specified value to the iHeight field.
      • iStride

        public EGLClientPixmapHI iStride​(int value)
        Sets the specified value to the iStride field.
      • set

        public EGLClientPixmapHI set​(java.nio.ByteBuffer pData,
                                     int iWidth,
                                     int iHeight,
                                     int iStride)
        Initializes this struct with the specified values.
      • createSafe

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

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

        public static java.nio.ByteBuffer npData​(long struct,
                                                 int capacity)
        Unsafe version of pData.
      • niWidth

        public static int niWidth​(long struct)
        Unsafe version of iWidth().
      • niHeight

        public static int niHeight​(long struct)
        Unsafe version of iHeight().
      • niStride

        public static int niStride​(long struct)
        Unsafe version of iStride().
      • npData

        public static void npData​(long struct,
                                  java.nio.ByteBuffer value)
        Unsafe version of pData.
      • niWidth

        public static void niWidth​(long struct,
                                   int value)
        Unsafe version of iWidth.
      • niHeight

        public static void niHeight​(long struct,
                                    int value)
        Unsafe version of iHeight.
      • niStride

        public static void niStride​(long struct,
                                    int value)
        Unsafe version of iStride.
      • validate

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

        public static void validate​(long array,
                                    int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array