EGLClientPixmapHI (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.egl.EGLClientPixmapHI

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class EGLClientPixmapHI
extends org.lwjgl.system.Struct
implements org.lwjgl.system.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;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EGLClientPixmapHI.Buffer
An array of EGLClientPixmapHI structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`EGLClientPixmapHI.Buffer` An array of `EGLClientPixmapHI` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`IHEIGHT` The struct member offsets.
`static int`	`ISTRIDE` The struct member offsets.
`static int`	`IWIDTH` The struct member offsets.
`static int`	`PDATA` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

EGLClientPixmapHI(java.nio.ByteBuffer container)
Creates a EGLClientPixmapHI instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`EGLClientPixmapHI(java.nio.ByteBuffer container)` Creates a `EGLClientPixmapHI` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EGLClientPixmapHI`	`calloc()` Returns a new `EGLClientPixmapHI` instance allocated with `memCalloc`.
`static EGLClientPixmapHI.Buffer`	`calloc(int capacity)` Returns a new `EGLClientPixmapHI.Buffer` instance allocated with `memCalloc`.
`static EGLClientPixmapHI`	`callocStack()` Returns a new `EGLClientPixmapHI` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static EGLClientPixmapHI.Buffer`	`callocStack(int capacity)` Returns a new `EGLClientPixmapHI.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static EGLClientPixmapHI.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `EGLClientPixmapHI.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static EGLClientPixmapHI`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `EGLClientPixmapHI` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static EGLClientPixmapHI`	`create()` Returns a new `EGLClientPixmapHI` instance allocated with `BufferUtils`.
`static EGLClientPixmapHI.Buffer`	`create(int capacity)` Returns a new `EGLClientPixmapHI.Buffer` instance allocated with `BufferUtils`.
`static EGLClientPixmapHI`	`create(long address)` Returns a new `EGLClientPixmapHI` instance for the specified memory address.
`static EGLClientPixmapHI.Buffer`	`create(long address, int capacity)` Create a `EGLClientPixmapHI.Buffer` instance at the specified memory.
`static EGLClientPixmapHI`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static EGLClientPixmapHI.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`iHeight()` Returns the value of the `iHeight` field.
`EGLClientPixmapHI`	`iHeight(int value)` Sets the specified value to the `iHeight` field.
`int`	`iStride()` Returns the value of the `iStride` field.
`EGLClientPixmapHI`	`iStride(int value)` Sets the specified value to the `iStride` field.
`int`	`iWidth()` Returns the value of the `iWidth` field.
`EGLClientPixmapHI`	`iWidth(int value)` Sets the specified value to the `iWidth` field.
`static EGLClientPixmapHI`	`malloc()` Returns a new `EGLClientPixmapHI` instance allocated with `memAlloc`.
`static EGLClientPixmapHI.Buffer`	`malloc(int capacity)` Returns a new `EGLClientPixmapHI.Buffer` instance allocated with `memAlloc`.
`static EGLClientPixmapHI`	`mallocStack()` Returns a new `EGLClientPixmapHI` instance allocated on the thread-local `MemoryStack`.
`static EGLClientPixmapHI.Buffer`	`mallocStack(int capacity)` Returns a new `EGLClientPixmapHI.Buffer` instance allocated on the thread-local `MemoryStack`.
`static EGLClientPixmapHI.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `EGLClientPixmapHI.Buffer` instance allocated on the specified `MemoryStack`.
`static EGLClientPixmapHI`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `EGLClientPixmapHI` instance allocated on the specified `MemoryStack`.
`static int`	`niHeight(long struct)` Unsafe version of `iHeight()`.
`static void`	`niHeight(long struct, int value)` Unsafe version of `iHeight`.
`static int`	`niStride(long struct)` Unsafe version of `iStride()`.
`static void`	`niStride(long struct, int value)` Unsafe version of `iStride`.
`static int`	`niWidth(long struct)` Unsafe version of `iWidth()`.
`static void`	`niWidth(long struct, int value)` Unsafe version of `iWidth`.
`static void`	`npData(long struct, java.nio.ByteBuffer value)` Unsafe version of `pData`.
`static java.nio.ByteBuffer`	`npData(long struct, int capacity)` Unsafe version of `pData`.
`EGLClientPixmapHI`	`pData(java.nio.ByteBuffer value)` Sets the address of the specified `ByteBuffer` to the `pData` field.
`java.nio.ByteBuffer`	`pData(int capacity)` Returns a `ByteBuffer` view of the data pointed to by the `pData` field.
`EGLClientPixmapHI`	`set(java.nio.ByteBuffer pData, int iWidth, int iHeight, int iStride)` Initializes this struct with the specified values.
`EGLClientPixmapHI`	`set(EGLClientPixmapHI src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - PDATA
```
public static final int PDATA
```
    The struct member offsets.
  - IWIDTH
```
public static final int IWIDTH
```
    The struct member offsets.
  - IHEIGHT
```
public static final int IHEIGHT
```
    The struct member offsets.
  - ISTRIDE
```
public static final int 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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.
  - set
```
public EGLClientPixmapHI set(EGLClientPixmapHI src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static EGLClientPixmapHI malloc()
```
    Returns a new EGLClientPixmapHI instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static EGLClientPixmapHI calloc()
```
    Returns a new EGLClientPixmapHI instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static EGLClientPixmapHI create()
```
    Returns a new EGLClientPixmapHI instance allocated with BufferUtils.
  - create
```
public static EGLClientPixmapHI create(long address)
```
    Returns a new EGLClientPixmapHI instance for the specified memory address.
  - createSafe
```
@Nullable
public static EGLClientPixmapHI createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static EGLClientPixmapHI.Buffer malloc(int capacity)
```
    Returns a new EGLClientPixmapHI.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static EGLClientPixmapHI.Buffer calloc(int capacity)
```
    Returns a new EGLClientPixmapHI.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static EGLClientPixmapHI.Buffer create(int capacity)
```
    Returns a new EGLClientPixmapHI.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static EGLClientPixmapHI.Buffer create(long address,
                                              int capacity)
```
    Create a EGLClientPixmapHI.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static EGLClientPixmapHI.Buffer createSafe(long address,
                                                            int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static EGLClientPixmapHI mallocStack()
```
    Returns a new EGLClientPixmapHI instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static EGLClientPixmapHI callocStack()
```
    Returns a new EGLClientPixmapHI instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static EGLClientPixmapHI mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new EGLClientPixmapHI instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static EGLClientPixmapHI callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new EGLClientPixmapHI instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static EGLClientPixmapHI.Buffer mallocStack(int capacity)
```
    Returns a new EGLClientPixmapHI.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static EGLClientPixmapHI.Buffer callocStack(int capacity)
```
    Returns a new EGLClientPixmapHI.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static EGLClientPixmapHI.Buffer mallocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new EGLClientPixmapHI.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static EGLClientPixmapHI.Buffer callocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new EGLClientPixmapHI.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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

Class EGLClientPixmapHI

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

PDATA

IWIDTH

IHEIGHT

ISTRIDE

Constructor Detail

EGLClientPixmapHI

Method Detail

sizeof

pData

iWidth

iHeight

iStride

pData

iWidth

iHeight

iStride

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

npData

niWidth

niHeight

niStride

npData

niWidth

niHeight

niStride

validate

validate