Package org.lwjgl.vulkan

Class VkExportMetalSharedEventInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExportMetalSharedEventInfoEXT>

org.lwjgl.vulkan.VkExportMetalSharedEventInfoEXT

All Implemented Interfaces:

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

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

Structure that identifies a VkSemaphore or VkEvent object and corresponding Metal MTLSharedEvent object.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_METAL_SHARED_EVENT_INFO_EXT
• If semaphore is not NULL_HANDLE, semaphore must be a valid VkSemaphore handle
• If event is not NULL_HANDLE, event must be a valid VkEvent handle
• Both of event, and semaphore that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice

Layout

 struct VkExportMetalSharedEventInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkSemaphore semaphore();
     VkEvent event();
     MTLSharedEvent_id mtlSharedEvent();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkExportMetalSharedEventInfoEXT.Buffer	An array of VkExportMetalSharedEventInfoEXT 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	EVENT	The struct member offsets.
static final int	MTLSHAREDEVENT	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SEMAPHORE	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
VkExportMetalSharedEventInfoEXT(ByteBuffer container)	Creates a VkExportMetalSharedEventInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkExportMetalSharedEventInfoEXT	calloc()	Returns a new VkExportMetalSharedEventInfoEXT instance allocated with memCalloc.
static VkExportMetalSharedEventInfoEXT.Buffer	calloc(int capacity)	Returns a new VkExportMetalSharedEventInfoEXT.Buffer instance allocated with memCalloc.
static VkExportMetalSharedEventInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMetalSharedEventInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExportMetalSharedEventInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMetalSharedEventInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExportMetalSharedEventInfoEXT	create()	Returns a new VkExportMetalSharedEventInfoEXT instance allocated with BufferUtils.
static VkExportMetalSharedEventInfoEXT.Buffer	create(int capacity)	Returns a new VkExportMetalSharedEventInfoEXT.Buffer instance allocated with BufferUtils.
static VkExportMetalSharedEventInfoEXT	create(long address)	Returns a new VkExportMetalSharedEventInfoEXT instance for the specified memory address.
static VkExportMetalSharedEventInfoEXT.Buffer	create(long address, int capacity)	Create a VkExportMetalSharedEventInfoEXT.Buffer instance at the specified memory.
static @Nullable VkExportMetalSharedEventInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkExportMetalSharedEventInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	event()	NULL_HANDLE or a VkEvent.
VkExportMetalSharedEventInfoEXT	event(long value)	Sets the specified value to the event() field.
static VkExportMetalSharedEventInfoEXT	malloc()	Returns a new VkExportMetalSharedEventInfoEXT instance allocated with memAlloc.
static VkExportMetalSharedEventInfoEXT.Buffer	malloc(int capacity)	Returns a new VkExportMetalSharedEventInfoEXT.Buffer instance allocated with memAlloc.
static VkExportMetalSharedEventInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMetalSharedEventInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkExportMetalSharedEventInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMetalSharedEventInfoEXT instance allocated on the specified MemoryStack.
long	mtlSharedEvent()	the Metal id<MTLSharedEvent> object underlying the VkSemaphore or VkEvent object in semaphore or event, respectively.
VkExportMetalSharedEventInfoEXT	mtlSharedEvent(long value)	Sets the specified value to the mtlSharedEvent() field.
static long	nevent(long struct)	Unsafe version of event().
static void	nevent(long struct, long value)	Unsafe version of event.
static long	nmtlSharedEvent(long struct)	Unsafe version of mtlSharedEvent().
static void	nmtlSharedEvent(long struct, long value)	Unsafe version of mtlSharedEvent.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static long	nsemaphore(long struct)	Unsafe version of semaphore().
static void	nsemaphore(long struct, long value)	Unsafe version of semaphore.
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.
VkExportMetalSharedEventInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
long	semaphore()	NULL_HANDLE or a VkSemaphore.
VkExportMetalSharedEventInfoEXT	semaphore(long value)	Sets the specified value to the semaphore() field.
VkExportMetalSharedEventInfoEXT	set(int sType, long pNext, long semaphore, long event, long mtlSharedEvent)	Initializes this struct with the specified values.
VkExportMetalSharedEventInfoEXT	set(VkExportMetalSharedEventInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkExportMetalSharedEventInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkExportMetalSharedEventInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_EXPORT_METAL_SHARED_EVENT_INFO_EXT value to the sType() field.
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, 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.

SEMAPHORE

public static final int SEMAPHORE

The struct member offsets.

EVENT

public static final int EVENT

The struct member offsets.

MTLSHAREDEVENT

public static final int MTLSHAREDEVENT

The struct member offsets.

Constructor Details

VkExportMetalSharedEventInfoEXT

public VkExportMetalSharedEventInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

semaphore

public long semaphore()

NULL_HANDLE or a VkSemaphore.

event

public long event()

NULL_HANDLE or a VkEvent.

mtlSharedEvent

public long mtlSharedEvent()

the Metal id<MTLSharedEvent> object underlying the VkSemaphore or VkEvent object in semaphore or event, respectively. The implementation will return the MTLSharedEvent in this member, or it will return NULL if no MTLSharedEvent could be found underlying the VkSemaphore or VkEvent object.

sType

public VkExportMetalSharedEventInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkExportMetalSharedEventInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_EXPORT_METAL_SHARED_EVENT_INFO_EXT value to the sType() field.

pNext

public VkExportMetalSharedEventInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

semaphore

public VkExportMetalSharedEventInfoEXT semaphore(long value)

Sets the specified value to the semaphore() field.

event

public VkExportMetalSharedEventInfoEXT event(long value)

Sets the specified value to the event() field.

mtlSharedEvent

public VkExportMetalSharedEventInfoEXT mtlSharedEvent(long value)

Sets the specified value to the mtlSharedEvent() field.

set

public VkExportMetalSharedEventInfoEXT set(int sType,
 long pNext,
 long semaphore,
 long event,
 long mtlSharedEvent)

Initializes this struct with the specified values.

set

public VkExportMetalSharedEventInfoEXT set(VkExportMetalSharedEventInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExportMetalSharedEventInfoEXT malloc()

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

calloc

public static VkExportMetalSharedEventInfoEXT calloc()

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

create

public static VkExportMetalSharedEventInfoEXT create()

Returns a new VkExportMetalSharedEventInfoEXT instance allocated with BufferUtils.

create

public static VkExportMetalSharedEventInfoEXT create(long address)

Returns a new VkExportMetalSharedEventInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkExportMetalSharedEventInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExportMetalSharedEventInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExportMetalSharedEventInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExportMetalSharedEventInfoEXT.Buffer create(int capacity)

Returns a new VkExportMetalSharedEventInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkExportMetalSharedEventInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkExportMetalSharedEventInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsemaphore

public static long nsemaphore(long struct)

Unsafe version of semaphore().

nevent

public static long nevent(long struct)

Unsafe version of event().

nmtlSharedEvent

public static long nmtlSharedEvent(long struct)

Unsafe version of mtlSharedEvent().

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.

nsemaphore

public static void nsemaphore(long struct,
 long value)

Unsafe version of semaphore.

nevent

public static void nevent(long struct,
 long value)

Unsafe version of event.

nmtlSharedEvent

public static void nmtlSharedEvent(long struct,
 long value)

Unsafe version of mtlSharedEvent.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate