Package org.lwjgl.vulkan

Class VkEventCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkEventCreateInfo>

org.lwjgl.vulkan.VkEventCreateInfo

All Implemented Interfaces:

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

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

Structure specifying parameters of a newly created event.

Valid Usage

• If the pNext chain includes a VkExportMetalObjectCreateInfoEXT structure, its exportObjectType member must be EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EVENT_CREATE_INFO
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkExportMetalObjectCreateInfoEXT or VkImportMetalSharedEventInfoEXT
• The sType value of each struct in the pNext chain must be unique, with the exception of structures of type VkExportMetalObjectCreateInfoEXT
• flags must be a valid combination of VkEventCreateFlagBits values

See Also

CreateEvent

Layout

 struct VkEventCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkEventCreateFlags flags();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkEventCreateInfo.Buffer	An array of VkEventCreateInfo 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	FLAGS	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
VkEventCreateInfo(ByteBuffer container)	Creates a VkEventCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkEventCreateInfo	calloc()	Returns a new VkEventCreateInfo instance allocated with memCalloc.
static VkEventCreateInfo.Buffer	calloc(int capacity)	Returns a new VkEventCreateInfo.Buffer instance allocated with memCalloc.
static VkEventCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkEventCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkEventCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkEventCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkEventCreateInfo	callocStack()	Deprecated.
static VkEventCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkEventCreateInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkEventCreateInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkEventCreateInfo	create()	Returns a new VkEventCreateInfo instance allocated with BufferUtils.
static VkEventCreateInfo.Buffer	create(int capacity)	Returns a new VkEventCreateInfo.Buffer instance allocated with BufferUtils.
static VkEventCreateInfo	create(long address)	Returns a new VkEventCreateInfo instance for the specified memory address.
static VkEventCreateInfo.Buffer	create(long address, int capacity)	Create a VkEventCreateInfo.Buffer instance at the specified memory.
static @Nullable VkEventCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkEventCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	a bitmask of VkEventCreateFlagBits defining additional creation parameters.
VkEventCreateInfo	flags(int value)	Sets the specified value to the flags() field.
static VkEventCreateInfo	malloc()	Returns a new VkEventCreateInfo instance allocated with memAlloc.
static VkEventCreateInfo.Buffer	malloc(int capacity)	Returns a new VkEventCreateInfo.Buffer instance allocated with memAlloc.
static VkEventCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkEventCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkEventCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkEventCreateInfo instance allocated on the specified MemoryStack.
static VkEventCreateInfo	mallocStack()	Deprecated.
static VkEventCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkEventCreateInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkEventCreateInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
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.
VkEventCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkEventCreateInfo	pNext(VkExportMetalObjectCreateInfoEXT value)	Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.
VkEventCreateInfo	pNext(VkImportMetalSharedEventInfoEXT value)	Prepends the specified VkImportMetalSharedEventInfoEXT value to the pNext chain.
VkEventCreateInfo	set(int sType, long pNext, int flags)	Initializes this struct with the specified values.
VkEventCreateInfo	set(VkEventCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkEventCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkEventCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_EVENT_CREATE_INFO 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.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

VkEventCreateInfo

public VkEventCreateInfo(ByteBuffer container)

Creates a VkEventCreateInfo 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<VkEventCreateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

a bitmask of VkEventCreateFlagBits defining additional creation parameters.

sType

public VkEventCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkEventCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_EVENT_CREATE_INFO value to the sType() field.

pNext

public VkEventCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkEventCreateInfo pNext(VkExportMetalObjectCreateInfoEXT value)

Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.

pNext

public VkEventCreateInfo pNext(VkImportMetalSharedEventInfoEXT value)

Prepends the specified VkImportMetalSharedEventInfoEXT value to the pNext chain.

flags

public VkEventCreateInfo flags(int value)

Sets the specified value to the flags() field.

set

public VkEventCreateInfo set(int sType,
 long pNext,
 int flags)

Initializes this struct with the specified values.

set

public VkEventCreateInfo set(VkEventCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkEventCreateInfo malloc()

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

calloc

public static VkEventCreateInfo calloc()

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

create

public static VkEventCreateInfo create()

Returns a new VkEventCreateInfo instance allocated with BufferUtils.

create

public static VkEventCreateInfo create(long address)

Returns a new VkEventCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkEventCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkEventCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkEventCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkEventCreateInfo.Buffer create(int capacity)

Returns a new VkEventCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkEventCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkEventCreateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkEventCreateInfo callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkEventCreateInfo.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 VkEventCreateInfo.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 VkEventCreateInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkEventCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkEventCreateInfo.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().

nflags

public static int nflags(long struct)

Unsafe version of flags().

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.