Package org.lwjgl.egl

Class EGLClientPixmapHI

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<EGLClientPixmapHI>

org.lwjgl.egl.EGLClientPixmapHI

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class EGLClientPixmapHI
extends Struct<EGLClientPixmapHI>
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.

Layout

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	IHEIGHT	The struct member offsets.
static final int	ISTRIDE	The struct member offsets.
static final int	IWIDTH	The struct member offsets.
static final int	PDATA	The struct member offsets.
static final 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	Description
EGLClientPixmapHI(ByteBuffer container)	Creates a EGLClientPixmapHI instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new EGLClientPixmapHI.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static EGLClientPixmapHI	calloc(MemoryStack stack)	Returns a new EGLClientPixmapHI instance allocated on the specified MemoryStack and initializes all its bits to zero.
static EGLClientPixmapHI	callocStack()	Deprecated.
static EGLClientPixmapHI.Buffer	callocStack(int capacity)	Deprecated.
static EGLClientPixmapHI.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static EGLClientPixmapHI	callocStack(MemoryStack stack)	Deprecated.
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()	height of the buffer in pixels.
EGLClientPixmapHI	iHeight(int value)	Sets the specified value to the iHeight() field.
int	iStride()	stride of the buffer, in pixels.
EGLClientPixmapHI	iStride(int value)	Sets the specified value to the iStride() field.
int	iWidth()	width of the buffer in pixels
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new EGLClientPixmapHI.Buffer instance allocated on the specified MemoryStack.
static EGLClientPixmapHI	malloc(MemoryStack stack)	Returns a new EGLClientPixmapHI instance allocated on the specified MemoryStack.
static EGLClientPixmapHI	mallocStack()	Deprecated.
static EGLClientPixmapHI.Buffer	mallocStack(int capacity)	Deprecated.
static EGLClientPixmapHI.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static EGLClientPixmapHI	mallocStack(MemoryStack stack)	Deprecated.
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 ByteBuffer	npData(long struct, int capacity)	Unsafe version of pData.
static void	npData(long struct, ByteBuffer value)	Unsafe version of pData.
ByteBuffer	pData(int capacity)
EGLClientPixmapHI	pData(ByteBuffer value)	Sets the address of the specified ByteBuffer to the pData(int) field.
EGLClientPixmapHI	set(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()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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 Details

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 Details

EGLClientPixmapHI

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<EGLClientPixmapHI>

pData

public ByteBuffer pData(int capacity)

Parameters:

capacity - the number of elements in the returned buffer

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

iWidth

public int iWidth()

width of the buffer in pixels

iHeight

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.

iStride

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.

pData

public EGLClientPixmapHI pData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pData(int) 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(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

@Deprecated
public static EGLClientPixmapHI mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static EGLClientPixmapHI callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static EGLClientPixmapHI mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static EGLClientPixmapHI callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static EGLClientPixmapHI.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static EGLClientPixmapHI.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static EGLClientPixmapHI.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static EGLClientPixmapHI.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static EGLClientPixmapHI malloc(MemoryStack stack)

Returns a new EGLClientPixmapHI instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

npData

public static 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,
 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