Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImportMetalSharedEventInfoEXT

extends Struct<VkImportMetalSharedEventInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 initialValue of VkSemaphoreTypeCreateInfo.

Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MTLSHAREDEVENT

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkImportMetalSharedEventInfoEXT(ByteBuffer container)

Creates a VkImportMetalSharedEventInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkImportMetalSharedEventInfoEXT
calloc()

Returns a new VkImportMetalSharedEventInfoEXT instance allocated with memCalloc.

public static VkImportMetalSharedEventInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkImportMetalSharedEventInfoEXT.Buffer instance allocated with memCalloc.

public static VkImportMetalSharedEventInfoEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkImportMetalSharedEventInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VkImportMetalSharedEventInfoEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkImportMetalSharedEventInfoEXT
create()

Returns a new VkImportMetalSharedEventInfoEXT instance allocated with BufferUtils.

public static VkImportMetalSharedEventInfoEXT
create(long address)

Returns a new VkImportMetalSharedEventInfoEXT instance for the specified memory address.

public static VkImportMetalSharedEventInfoEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkImportMetalSharedEventInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkImportMetalSharedEventInfoEXT.Buffer instance at the specified memory.

public static VkImportMetalSharedEventInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkImportMetalSharedEventInfoEXT
malloc()

Returns a new VkImportMetalSharedEventInfoEXT instance allocated with memAlloc.

public static VkImportMetalSharedEventInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkImportMetalSharedEventInfoEXT.Buffer instance allocated with memAlloc.

public static VkImportMetalSharedEventInfoEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkImportMetalSharedEventInfoEXT instance allocated on the specified MemoryStack.

public static VkImportMetalSharedEventInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public long
mtlSharedEvent()

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

public VkImportMetalSharedEventInfoEXT
mtlSharedEvent(long value)

Sets the specified value to the mtlSharedEvent field.

public static long
nmtlSharedEvent(long struct)

Unsafe version of mtlSharedEvent.

public static void
nmtlSharedEvent(long struct, long value)

Unsafe version of mtlSharedEvent.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImportMetalSharedEventInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkImportMetalSharedEventInfoEXT

Returns:

this struct
set
(VkImportMetalSharedEventInfoEXT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkImportMetalSharedEventInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkImportMetalSharedEventInfoEXT
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

MTLSHAREDEVENTback to summary
public static final int MTLSHAREDEVENT

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkImportMetalSharedEventInfoEXTback to summary
protected VkImportMetalSharedEventInfoEXT(long address, ByteBuffer container)
VkImportMetalSharedEventInfoEXTback to summary
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 Detail

callocback to summary
public static VkImportMetalSharedEventInfoEXT calloc()

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

callocback to summary
public static VkImportMetalSharedEventInfoEXT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImportMetalSharedEventInfoEXT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkImportMetalSharedEventInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkImportMetalSharedEventInfoEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkImportMetalSharedEventInfoEXT create()

Returns a new VkImportMetalSharedEventInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkImportMetalSharedEventInfoEXT create(long address)

Returns a new VkImportMetalSharedEventInfoEXT instance for the specified memory address.

createback to summary
public static VkImportMetalSharedEventInfoEXT.Buffer create(int capacity)

Returns a new VkImportMetalSharedEventInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImportMetalSharedEventInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImportMetalSharedEventInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkImportMetalSharedEventInfoEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkImportMetalSharedEventInfoEXT malloc()

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

mallocback to summary
public static VkImportMetalSharedEventInfoEXT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImportMetalSharedEventInfoEXT malloc(MemoryStack stack)

Returns a new VkImportMetalSharedEventInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkImportMetalSharedEventInfoEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mtlSharedEventback to summary
public long mtlSharedEvent()

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

Annotations
@NativeType:MTLSharedEvent_id
mtlSharedEventback to summary
public VkImportMetalSharedEventInfoEXT mtlSharedEvent(long value)

Sets the specified value to the mtlSharedEvent field.

nmtlSharedEventback to summary
public static long nmtlSharedEvent(long struct)

Unsafe version of mtlSharedEvent.

nmtlSharedEventback to summary
public static void nmtlSharedEvent(long struct, long value)

Unsafe version of mtlSharedEvent.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkImportMetalSharedEventInfoEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkImportMetalSharedEventInfoEXT set(int sType, long pNext, long mtlSharedEvent)

Initializes this struct with the specified values.

setback to summary
public VkImportMetalSharedEventInfoEXT set(VkImportMetalSharedEventInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImportMetalSharedEventInfoEXT

the source struct

Returns:VkImportMetalSharedEventInfoEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImportMetalSharedEventInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkImportMetalSharedEventInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_METAL_SHARED_EVENT_INFO_EXT value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkImportMetalSharedEventInfoEXT.Buffer

extends StructBuffer<VkImportMetalSharedEventInfoEXT, VkImportMetalSharedEventInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkImportMetalSharedEventInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImportMetalSharedEventInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkImportMetalSharedEventInfoEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkImportMetalSharedEventInfoEXT
public long
public VkImportMetalSharedEventInfoEXT.Buffer
mtlSharedEvent(long value)

Sets the specified value to the VkImportMetalSharedEventInfoEXT#mtlSharedEvent field.

public long

Returns:

the value of the VkImportMetalSharedEventInfoEXT#pNext field.
pNext
()

public VkImportMetalSharedEventInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkImportMetalSharedEventInfoEXT#pNext field.

protected VkImportMetalSharedEventInfoEXT.Buffer
public int

Returns:

the value of the VkImportMetalSharedEventInfoEXT#sType field.
sType
()

public VkImportMetalSharedEventInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkImportMetalSharedEventInfoEXT#sType field.

public VkImportMetalSharedEventInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImportMetalSharedEventInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkImportMetalSharedEventInfoEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkImportMetalSharedEventInfoEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkImportMetalSharedEventInfoEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
mtlSharedEventback to summary
public long mtlSharedEvent()
Returns:long

the value of the VkImportMetalSharedEventInfoEXT#mtlSharedEvent field.

Annotations
@NativeType:MTLSharedEvent_id
mtlSharedEventback to summary
public VkImportMetalSharedEventInfoEXT.Buffer mtlSharedEvent(long value)

Sets the specified value to the VkImportMetalSharedEventInfoEXT#mtlSharedEvent field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImportMetalSharedEventInfoEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkImportMetalSharedEventInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkImportMetalSharedEventInfoEXT#pNext field.

selfback to summary
protected VkImportMetalSharedEventInfoEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkImportMetalSharedEventInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkImportMetalSharedEventInfoEXT.Buffer sType(int value)

Sets the specified value to the VkImportMetalSharedEventInfoEXT#sType field.

sType$Defaultback to summary
public VkImportMetalSharedEventInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_METAL_SHARED_EVENT_INFO_EXT value to the VkImportMetalSharedEventInfoEXT#sType field.