Package org.lwjgl.vulkan

Class VkDisplayEventInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDisplayEventInfoEXT>

org.lwjgl.vulkan.VkDisplayEventInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkDisplayEventInfoEXT
extends org.lwjgl.system.Struct<VkDisplayEventInfoEXT>
implements org.lwjgl.system.NativeResource

Describe a display event to create.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT
• pNext must be NULL
• displayEvent must be a valid VkDisplayEventTypeEXT value

See Also

RegisterDisplayEventEXT

Layout

 struct VkDisplayEventInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkDisplayEventTypeEXT displayEvent();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DISPLAYEVENT	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDisplayEventInfoEXT(ByteBuffer container)	Creates a VkDisplayEventInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDisplayEventInfoEXT	calloc()	Returns a new VkDisplayEventInfoEXT instance allocated with memCalloc.
static VkDisplayEventInfoEXT.Buffer	calloc(int capacity)	Returns a new VkDisplayEventInfoEXT.Buffer instance allocated with memCalloc.
static VkDisplayEventInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayEventInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayEventInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayEventInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayEventInfoEXT	callocStack()	Deprecated.
static VkDisplayEventInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkDisplayEventInfoEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayEventInfoEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayEventInfoEXT	create()	Returns a new VkDisplayEventInfoEXT instance allocated with BufferUtils.
static VkDisplayEventInfoEXT.Buffer	create(int capacity)	Returns a new VkDisplayEventInfoEXT.Buffer instance allocated with BufferUtils.
static VkDisplayEventInfoEXT	create(long address)	Returns a new VkDisplayEventInfoEXT instance for the specified memory address.
static VkDisplayEventInfoEXT.Buffer	create(long address, int capacity)	Create a VkDisplayEventInfoEXT.Buffer instance at the specified memory.
static @Nullable VkDisplayEventInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDisplayEventInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	displayEvent()	a VkDisplayEventTypeEXT specifying when the fence will be signaled.
VkDisplayEventInfoEXT	displayEvent(int value)	Sets the specified value to the displayEvent() field.
static VkDisplayEventInfoEXT	malloc()	Returns a new VkDisplayEventInfoEXT instance allocated with memAlloc.
static VkDisplayEventInfoEXT.Buffer	malloc(int capacity)	Returns a new VkDisplayEventInfoEXT.Buffer instance allocated with memAlloc.
static VkDisplayEventInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayEventInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkDisplayEventInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayEventInfoEXT instance allocated on the specified MemoryStack.
static VkDisplayEventInfoEXT	mallocStack()	Deprecated.
static VkDisplayEventInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkDisplayEventInfoEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayEventInfoEXT	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	ndisplayEvent(long struct)	Unsafe version of displayEvent().
static void	ndisplayEvent(long struct, int value)	Unsafe version of displayEvent.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDisplayEventInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkDisplayEventInfoEXT	set(int sType, long pNext, int displayEvent)	Initializes this struct with the specified values.
VkDisplayEventInfoEXT	set(VkDisplayEventInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDisplayEventInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkDisplayEventInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

DISPLAYEVENT

public static final int DISPLAYEVENT

The struct member offsets.

Constructor Details

VkDisplayEventInfoEXT

public VkDisplayEventInfoEXT(ByteBuffer container)

Creates a VkDisplayEventInfoEXT 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkDisplayEventInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

displayEvent

public int displayEvent()

a VkDisplayEventTypeEXT specifying when the fence will be signaled.

sType

public VkDisplayEventInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDisplayEventInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_EVENT_INFO_EXT value to the sType() field.

pNext

public VkDisplayEventInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

displayEvent

public VkDisplayEventInfoEXT displayEvent(int value)

Sets the specified value to the displayEvent() field.

set

public VkDisplayEventInfoEXT set(int sType,
 long pNext,
 int displayEvent)

Initializes this struct with the specified values.

set

public VkDisplayEventInfoEXT set(VkDisplayEventInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDisplayEventInfoEXT malloc()

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

calloc

public static VkDisplayEventInfoEXT calloc()

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

create

public static VkDisplayEventInfoEXT create()

Returns a new VkDisplayEventInfoEXT instance allocated with BufferUtils.

create

public static VkDisplayEventInfoEXT create(long address)

Returns a new VkDisplayEventInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkDisplayEventInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplayEventInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplayEventInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplayEventInfoEXT.Buffer create(int capacity)

Returns a new VkDisplayEventInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkDisplayEventInfoEXT.Buffer create(long address,
 int capacity)

Create a VkDisplayEventInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkDisplayEventInfoEXT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDisplayEventInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayEventInfoEXT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayEventInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayEventInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayEventInfoEXT.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayEventInfoEXT.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkDisplayEventInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDisplayEventInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDisplayEventInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDisplayEventInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDisplayEventInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkDisplayEventInfoEXT.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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

ndisplayEvent

public static int ndisplayEvent(long struct)

Unsafe version of displayEvent().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

ndisplayEvent

public static void ndisplayEvent(long struct,
 int value)

Unsafe version of displayEvent.