Top Description Inners Fields Constructors Methods
org.lwjgl.egl

public Class EGLClientPixmapHI

extends Struct<EGLClientPixmapHI>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct EGLClientPixmapHI
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Specifies the width, height, stride, format and memory pointer of the pixmap to be used by the function CreatePixmapSurfaceHI to create the PixmapSurface.

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
IHEIGHT

The struct member offsets.

public static final int
ISTRIDE

The struct member offsets.

public static final int
IWIDTH

The struct member offsets.

public static final int
PDATA

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
EGLClientPixmapHI(long address, ByteBuffer container)

public
EGLClientPixmapHI(ByteBuffer container)

Creates a EGLClientPixmapHI instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static EGLClientPixmapHI
calloc()

Returns a new EGLClientPixmapHI instance allocated with memCalloc.

public static EGLClientPixmapHI.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new EGLClientPixmapHI.Buffer instance allocated with memCalloc.

public static EGLClientPixmapHI
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new EGLClientPixmapHI instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static EGLClientPixmapHI.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new EGLClientPixmapHI.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static EGLClientPixmapHI
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static EGLClientPixmapHI
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static EGLClientPixmapHI.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static EGLClientPixmapHI.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected EGLClientPixmapHI
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static EGLClientPixmapHI
create()

Returns a new EGLClientPixmapHI instance allocated with BufferUtils.

public static EGLClientPixmapHI
create(long address)

Returns a new EGLClientPixmapHI instance for the specified memory address.

public static EGLClientPixmapHI.Buffer
create(int
the buffer capacity
capacity
)

Returns a new EGLClientPixmapHI.Buffer instance allocated with BufferUtils.

public static EGLClientPixmapHI.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a EGLClientPixmapHI.Buffer instance at the specified memory.

public static EGLClientPixmapHI
createSafe(long address)

Like create, but returns null if address is NULL.

public static EGLClientPixmapHI.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
iHeight()

height of the buffer in pixels.

public EGLClientPixmapHI
iHeight(int value)

Sets the specified value to the iHeight field.

public int
iStride()

stride of the buffer, in pixels.

public EGLClientPixmapHI
iStride(int value)

Sets the specified value to the iStride field.

public int
iWidth()

width of the buffer in pixels

public EGLClientPixmapHI
iWidth(int value)

Sets the specified value to the iWidth field.

public static EGLClientPixmapHI
malloc()

Returns a new EGLClientPixmapHI instance allocated with memAlloc.

public static EGLClientPixmapHI.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new EGLClientPixmapHI.Buffer instance allocated with memAlloc.

public static EGLClientPixmapHI
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new EGLClientPixmapHI instance allocated on the specified MemoryStack.

public static EGLClientPixmapHI.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new EGLClientPixmapHI.Buffer instance allocated on the specified MemoryStack.

public static EGLClientPixmapHI
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static EGLClientPixmapHI
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static EGLClientPixmapHI.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static EGLClientPixmapHI.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
niHeight(long struct)

Unsafe version of iHeight.

public static void
niHeight(long struct, int value)

Unsafe version of iHeight.

public static int
niStride(long struct)

Unsafe version of iStride.

public static void
niStride(long struct, int value)

Unsafe version of iStride.

public static int
niWidth(long struct)

Unsafe version of iWidth.

public static void
niWidth(long struct, int value)

Unsafe version of iWidth.

public static ByteBuffer
npData(long struct, int capacity)

Unsafe version of pData.

public static void
npData(long struct, ByteBuffer value)

Unsafe version of pData.

public ByteBuffer

Returns:

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).
pData
(int
the number of elements in the returned buffer
capacity
)

public EGLClientPixmapHI
pData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pData field.

public EGLClientPixmapHI
set(ByteBuffer pData, int iWidth, int iHeight, int iStride)

Initializes this struct with the specified values.

public EGLClientPixmapHI

Returns:

this struct
set
(EGLClientPixmapHI
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

IHEIGHTback to summary
public static final int IHEIGHT

The struct member offsets.

ISTRIDEback to summary
public static final int ISTRIDE

The struct member offsets.

IWIDTHback to summary
public static final int IWIDTH

The struct member offsets.

PDATAback to summary
public static final int PDATA

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

EGLClientPixmapHIback to summary
protected EGLClientPixmapHI(long address, ByteBuffer container)
EGLClientPixmapHIback to summary
public EGLClientPixmapHI(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

callocback to summary
public static EGLClientPixmapHI calloc()

Returns a new EGLClientPixmapHI instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static EGLClientPixmapHI.Buffer calloc(int capacity)

Returns a new EGLClientPixmapHI.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static EGLClientPixmapHI calloc(MemoryStack stack)

Returns a new EGLClientPixmapHI instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static EGLClientPixmapHI.Buffer calloc(int capacity, MemoryStack stack)

Returns a new EGLClientPixmapHI.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static EGLClientPixmapHI callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static EGLClientPixmapHI callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static EGLClientPixmapHI.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static EGLClientPixmapHI.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected EGLClientPixmapHI create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static EGLClientPixmapHI create()

Returns a new EGLClientPixmapHI instance allocated with BufferUtils.

createback to summary
public static EGLClientPixmapHI create(long address)

Returns a new EGLClientPixmapHI instance for the specified memory address.

createback to summary
public static EGLClientPixmapHI.Buffer create(int capacity)

Returns a new EGLClientPixmapHI.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static EGLClientPixmapHI.Buffer create(long address, int capacity)

Create a EGLClientPixmapHI.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static EGLClientPixmapHI createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static EGLClientPixmapHI.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
iHeightback to summary
public int 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.

Annotations
@NativeType:EGLint
iHeightback to summary
public EGLClientPixmapHI iHeight(int value)

Sets the specified value to the iHeight field.

iStrideback to summary
public int iStride()

stride of the buffer, in pixels. It is important to note that each row of the buffer must start on 32-bit boundaries.

Annotations
@NativeType:EGLint
iStrideback to summary
public EGLClientPixmapHI iStride(int value)

Sets the specified value to the iStride field.

iWidthback to summary
public int iWidth()

width of the buffer in pixels

Annotations
@NativeType:EGLint
iWidthback to summary
public EGLClientPixmapHI iWidth(int value)

Sets the specified value to the iWidth field.

mallocback to summary
public static EGLClientPixmapHI malloc()

Returns a new EGLClientPixmapHI instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static EGLClientPixmapHI.Buffer malloc(int capacity)

Returns a new EGLClientPixmapHI.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static EGLClientPixmapHI malloc(MemoryStack stack)

Returns a new EGLClientPixmapHI instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static EGLClientPixmapHI.Buffer malloc(int capacity, MemoryStack stack)

Returns a new EGLClientPixmapHI.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static EGLClientPixmapHI mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static EGLClientPixmapHI mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static EGLClientPixmapHI.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static EGLClientPixmapHI.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
niHeightback to summary
public static int niHeight(long struct)

Unsafe version of iHeight.

niHeightback to summary
public static void niHeight(long struct, int value)

Unsafe version of iHeight.

niStrideback to summary
public static int niStride(long struct)

Unsafe version of iStride.

niStrideback to summary
public static void niStride(long struct, int value)

Unsafe version of iStride.

niWidthback to summary
public static int niWidth(long struct)

Unsafe version of iWidth.

niWidthback to summary
public static void niWidth(long struct, int value)

Unsafe version of iWidth.

npDataback to summary
public static ByteBuffer npData(long struct, int capacity)

Unsafe version of pData.

npDataback to summary
public static void npData(long struct, ByteBuffer value)

Unsafe version of pData.

pDataback to summary
public ByteBuffer pData(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

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).

Annotations
@NativeType:void *
pDataback to summary
public EGLClientPixmapHI pData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pData field.

setback to summary
public EGLClientPixmapHI set(ByteBuffer pData, int iWidth, int iHeight, int iStride)

Initializes this struct with the specified values.

setback to summary
public EGLClientPixmapHI set(EGLClientPixmapHI src)

Copies the specified struct data to this struct.

Parameters
src:EGLClientPixmapHI

the source struct

Returns:EGLClientPixmapHI

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.egl back to summary

public Class EGLClientPixmapHI.Buffer

extends StructBuffer<EGLClientPixmapHI, EGLClientPixmapHI.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of EGLClientPixmapHI structs.

Field Summary

Modifier and TypeField and Description
private static final EGLClientPixmapHI

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new EGLClientPixmapHI.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected EGLClientPixmapHI
public int

Returns:

the value of the EGLClientPixmapHI#iHeight field.
iHeight
()

public EGLClientPixmapHI.Buffer
iHeight(int value)

Sets the specified value to the EGLClientPixmapHI#iHeight field.

public int

Returns:

the value of the EGLClientPixmapHI#iStride field.
iStride
()

public EGLClientPixmapHI.Buffer
iStride(int value)

Sets the specified value to the EGLClientPixmapHI#iStride field.

public int

Returns:

the value of the EGLClientPixmapHI#iWidth field.
iWidth
()

public EGLClientPixmapHI.Buffer
iWidth(int value)

Sets the specified value to the EGLClientPixmapHI#iWidth field.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the EGLClientPixmapHI#pData field.
pData
(int
the number of elements in the returned buffer
capacity
)

public EGLClientPixmapHI.Buffer
pData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the EGLClientPixmapHI#pData field.

protected EGLClientPixmapHI.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final EGLClientPixmapHI ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new EGLClientPixmapHI.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by EGLClientPixmapHI#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected EGLClientPixmapHI getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
iHeightback to summary
public int iHeight()
Returns:int

the value of the EGLClientPixmapHI#iHeight field.

Annotations
@NativeType:EGLint
iHeightback to summary
public EGLClientPixmapHI.Buffer iHeight(int value)

Sets the specified value to the EGLClientPixmapHI#iHeight field.

iStrideback to summary
public int iStride()
Returns:int

the value of the EGLClientPixmapHI#iStride field.

Annotations
@NativeType:EGLint
iStrideback to summary
public EGLClientPixmapHI.Buffer iStride(int value)

Sets the specified value to the EGLClientPixmapHI#iStride field.

iWidthback to summary
public int iWidth()
Returns:int

the value of the EGLClientPixmapHI#iWidth field.

Annotations
@NativeType:EGLint
iWidthback to summary
public EGLClientPixmapHI.Buffer iWidth(int value)

Sets the specified value to the EGLClientPixmapHI#iWidth field.

pDataback to summary
public ByteBuffer pData(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the EGLClientPixmapHI#pData field.

Annotations
@NativeType:void *
pDataback to summary
public EGLClientPixmapHI.Buffer pData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the EGLClientPixmapHI#pData field.

selfback to summary
protected EGLClientPixmapHI.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override