Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExportMetalSharedEventInfoEXT

extends Struct<VkExportMetalSharedEventInfoEXT>
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 MTLSharedEvent object.
Valid Usage (Implicit)

Layout


struct VkExportMetalSharedEventInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkSemaphore semaphore;
    VkEvent event;
    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
EVENT

The struct member offsets.

public static final int
MTLSHAREDEVENT

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SEMAPHORE

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
VkExportMetalSharedEventInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExportMetalSharedEventInfoEXT
calloc()

Returns a new VkExportMetalSharedEventInfoEXT instance allocated with memCalloc.

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

Returns a new VkExportMetalSharedEventInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkExportMetalSharedEventInfoEXT
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 VkExportMetalSharedEventInfoEXT
create()

Returns a new VkExportMetalSharedEventInfoEXT instance allocated with BufferUtils.

public static VkExportMetalSharedEventInfoEXT
create(long address)

Returns a new VkExportMetalSharedEventInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalSharedEventInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkExportMetalSharedEventInfoEXT.Buffer instance at the specified memory.

public static VkExportMetalSharedEventInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
event()

NULL_HANDLE or a VkEvent.

public VkExportMetalSharedEventInfoEXT
event(long value)

Sets the specified value to the event field.

public static VkExportMetalSharedEventInfoEXT
malloc()

Returns a new VkExportMetalSharedEventInfoEXT instance allocated with memAlloc.

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

Returns a new VkExportMetalSharedEventInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkExportMetalSharedEventInfoEXT instance allocated on the specified MemoryStack.

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

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

public long
mtlSharedEvent()

the Metal id<MTLSharedEvent> object underlying the VkSemaphore or VkEvent object in semaphore or event, respectively.

public VkExportMetalSharedEventInfoEXT
mtlSharedEvent(long value)

Sets the specified value to the mtlSharedEvent field.

public static long
nevent(long struct)

Unsafe version of event.

public static void
nevent(long struct, long value)

Unsafe version of event.

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 long
nsemaphore(long struct)

Unsafe version of semaphore.

public static void
nsemaphore(long struct, long value)

Unsafe version of semaphore.

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 VkExportMetalSharedEventInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public long
semaphore()

NULL_HANDLE or a VkSemaphore.

public VkExportMetalSharedEventInfoEXT
semaphore(long value)

Sets the specified value to the semaphore field.

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

Initializes this struct with the specified values.

public VkExportMetalSharedEventInfoEXT

Returns:

this struct
set
(VkExportMetalSharedEventInfoEXT
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 VkExportMetalSharedEventInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkExportMetalSharedEventInfoEXT
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.

EVENTback to summary
public static final int EVENT

The struct member offsets.

MTLSHAREDEVENTback to summary
public static final int MTLSHAREDEVENT

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SEMAPHOREback to summary
public static final int SEMAPHORE

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

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

callocback to summary
public static VkExportMetalSharedEventInfoEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExportMetalSharedEventInfoEXT calloc(MemoryStack stack)

Returns a new VkExportMetalSharedEventInfoEXT 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 VkExportMetalSharedEventInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new VkExportMetalSharedEventInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkExportMetalSharedEventInfoEXT create(long address)

Returns a new VkExportMetalSharedEventInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalSharedEventInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExportMetalSharedEventInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExportMetalSharedEventInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
eventback to summary
public long event()

NULL_HANDLE or a VkEvent.

Annotations
@NativeType:VkEvent
eventback to summary
public VkExportMetalSharedEventInfoEXT event(long value)

Sets the specified value to the event field.

mallocback to summary
public static VkExportMetalSharedEventInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExportMetalSharedEventInfoEXT malloc(MemoryStack stack)

Returns a new VkExportMetalSharedEventInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

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

Sets the specified value to the mtlSharedEvent field.

neventback to summary
public static long nevent(long struct)

Unsafe version of event.

neventback to summary
public static void nevent(long struct, long value)

Unsafe version of event.

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.

nsemaphoreback to summary
public static long nsemaphore(long struct)

Unsafe version of semaphore.

nsemaphoreback to summary
public static void nsemaphore(long struct, long value)

Unsafe version of semaphore.

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 VkExportMetalSharedEventInfoEXT pNext(long value)

Sets the specified value to the pNext field.

semaphoreback to summary
public long semaphore()

NULL_HANDLE or a VkSemaphore.

Annotations
@NativeType:VkSemaphore
semaphoreback to summary
public VkExportMetalSharedEventInfoEXT semaphore(long value)

Sets the specified value to the semaphore field.

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

Initializes this struct with the specified values.

setback to summary
public VkExportMetalSharedEventInfoEXT set(VkExportMetalSharedEventInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkExportMetalSharedEventInfoEXT

the source struct

Returns:VkExportMetalSharedEventInfoEXT

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 VkExportMetalSharedEventInfoEXT sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_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 VkExportMetalSharedEventInfoEXT.Buffer

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

An array of VkExportMetalSharedEventInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkExportMetalSharedEventInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExportMetalSharedEventInfoEXT.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
public long

Returns:

the value of the VkExportMetalSharedEventInfoEXT#event field.
event
()

public VkExportMetalSharedEventInfoEXT.Buffer
event(long value)

Sets the specified value to the VkExportMetalSharedEventInfoEXT#event field.

protected VkExportMetalSharedEventInfoEXT
public long
public VkExportMetalSharedEventInfoEXT.Buffer
mtlSharedEvent(long value)

Sets the specified value to the VkExportMetalSharedEventInfoEXT#mtlSharedEvent field.

public long

Returns:

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

public VkExportMetalSharedEventInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkExportMetalSharedEventInfoEXT#pNext field.

protected VkExportMetalSharedEventInfoEXT.Buffer
public long

Returns:

the value of the VkExportMetalSharedEventInfoEXT#semaphore field.
semaphore
()

public VkExportMetalSharedEventInfoEXT.Buffer
semaphore(long value)

Sets the specified value to the VkExportMetalSharedEventInfoEXT#semaphore field.

public int

Returns:

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

public VkExportMetalSharedEventInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkExportMetalSharedEventInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExportMetalSharedEventInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkExportMetalSharedEventInfoEXT.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 VkExportMetalSharedEventInfoEXT#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

eventback to summary
public long event()
Returns:long

the value of the VkExportMetalSharedEventInfoEXT#event field.

Annotations
@NativeType:VkEvent
eventback to summary
public VkExportMetalSharedEventInfoEXT.Buffer event(long value)

Sets the specified value to the VkExportMetalSharedEventInfoEXT#event field.

getElementFactoryback to summary
protected VkExportMetalSharedEventInfoEXT getElementFactory()

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

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

the value of the VkExportMetalSharedEventInfoEXT#mtlSharedEvent field.

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

Sets the specified value to the VkExportMetalSharedEventInfoEXT#mtlSharedEvent field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkExportMetalSharedEventInfoEXT#pNext field.

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

Sets the specified value to the VkExportMetalSharedEventInfoEXT#pNext field.

selfback to summary
protected VkExportMetalSharedEventInfoEXT.Buffer self()

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

Annotations
@Override
semaphoreback to summary
public long semaphore()
Returns:long

the value of the VkExportMetalSharedEventInfoEXT#semaphore field.

Annotations
@NativeType:VkSemaphore
semaphoreback to summary
public VkExportMetalSharedEventInfoEXT.Buffer semaphore(long value)

Sets the specified value to the VkExportMetalSharedEventInfoEXT#semaphore field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkExportMetalSharedEventInfoEXT#sType field.

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

Sets the specified value to the VkExportMetalSharedEventInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_METAL_SHARED_EVENT_INFO_EXT value to the VkExportMetalSharedEventInfoEXT#sType field.