Package org.lwjgl.vulkan

Class VkImportMetalSharedEventInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImportMetalSharedEventInfoEXT>

org.lwjgl.vulkan.VkImportMetalSharedEventInfoEXT

All Implemented Interfaces:

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

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

Structure that identifies a VkSemaphore or VkEvent object and corresponding Metal Shared Event object to use.

Description

If the pNext chain of the VkSemaphoreCreateInfo structure includes both VkImportMetalSharedEventInfoEXT and VkSemaphoreTypeCreateInfo, the signaledValue property of the imported id<MTLSharedEvent> object will be set to VkSemaphoreTypeCreateInfo::initialValue.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMPORT_METAL_SHARED_EVENT_INFO_EXT

Layout

 struct VkImportMetalSharedEventInfoEXT {
     VkStructureType sType();
     void const * pNext();
     MTLSharedEvent_id mtlSharedEvent();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

MTLSHAREDEVENT

public static final int MTLSHAREDEVENT

The struct member offsets.

Constructor Details

VkImportMetalSharedEventInfoEXT

public VkImportMetalSharedEventInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

mtlSharedEvent

public long mtlSharedEvent()

the Metal id<MTLSharedEvent> object that is to underlie the VkSemaphore or VkEvent.

sType

public VkImportMetalSharedEventInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImportMetalSharedEventInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_METAL_SHARED_EVENT_INFO_EXT value to the sType() field.

pNext

public VkImportMetalSharedEventInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

mtlSharedEvent

public VkImportMetalSharedEventInfoEXT mtlSharedEvent(long value)

Sets the specified value to the mtlSharedEvent() field.

set

public VkImportMetalSharedEventInfoEXT set(int sType,
 long pNext,
 long mtlSharedEvent)

Initializes this struct with the specified values.

set

public VkImportMetalSharedEventInfoEXT set(VkImportMetalSharedEventInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImportMetalSharedEventInfoEXT malloc()

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

calloc

public static VkImportMetalSharedEventInfoEXT calloc()

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

create

public static VkImportMetalSharedEventInfoEXT create()

Returns a new VkImportMetalSharedEventInfoEXT instance allocated with BufferUtils.

create

public static VkImportMetalSharedEventInfoEXT create(long address)

Returns a new VkImportMetalSharedEventInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkImportMetalSharedEventInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImportMetalSharedEventInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImportMetalSharedEventInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImportMetalSharedEventInfoEXT.Buffer create(int capacity)

Returns a new VkImportMetalSharedEventInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImportMetalSharedEventInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkImportMetalSharedEventInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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.

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