Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExportMetalCommandQueueInfoEXT

extends Struct<VkExportMetalCommandQueueInfoEXT>
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 VkQueue object and corresponding Metal MTLCommandQueue object.
Valid Usage (Implicit)

Layout


struct VkExportMetalCommandQueueInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkQueue queue;
    MTLCommandQueue_id mtlCommandQueue;
}

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
MTLCOMMANDQUEUE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
QUEUE

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

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

Method Summary

Modifier and TypeMethod and Description
public static VkExportMetalCommandQueueInfoEXT
calloc()

Returns a new VkExportMetalCommandQueueInfoEXT instance allocated with memCalloc.

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

Returns a new VkExportMetalCommandQueueInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkExportMetalCommandQueueInfoEXT instance allocated with BufferUtils.

public static VkExportMetalCommandQueueInfoEXT
create(long address)

Returns a new VkExportMetalCommandQueueInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalCommandQueueInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkExportMetalCommandQueueInfoEXT.Buffer instance at the specified memory.

public static VkExportMetalCommandQueueInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkExportMetalCommandQueueInfoEXT
malloc()

Returns a new VkExportMetalCommandQueueInfoEXT instance allocated with memAlloc.

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

Returns a new VkExportMetalCommandQueueInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkExportMetalCommandQueueInfoEXT instance allocated on the specified MemoryStack.

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

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

public long
mtlCommandQueue()

the Metal id<MTLCommandQueue> object underlying the VkQueue object in queue.

public VkExportMetalCommandQueueInfoEXT
mtlCommandQueue(long value)

Sets the specified value to the mtlCommandQueue field.

public static long
nmtlCommandQueue(long struct)

Unsafe version of mtlCommandQueue.

public static void
nmtlCommandQueue(long struct, long value)

Unsafe version of mtlCommandQueue.

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

Unsafe version of queue.

public static void
nqueue(long struct, VkQueue value)

Unsafe version of queue.

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

Sets the specified value to the pNext field.

public long
queue()

a VkQueue.

public VkExportMetalCommandQueueInfoEXT
queue(VkQueue value)

Sets the specified value to the queue field.

public VkExportMetalCommandQueueInfoEXT
set(int sType, long pNext, VkQueue queue, long mtlCommandQueue)

Initializes this struct with the specified values.

public VkExportMetalCommandQueueInfoEXT

Returns:

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

Sets the specified value to the sType field.

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

MTLCOMMANDQUEUEback to summary
public static final int MTLCOMMANDQUEUE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

QUEUEback to summary
public static final int QUEUE

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

VkExportMetalCommandQueueInfoEXTback to summary
protected VkExportMetalCommandQueueInfoEXT(long address, ByteBuffer container)
VkExportMetalCommandQueueInfoEXTback to summary
public VkExportMetalCommandQueueInfoEXT(ByteBuffer container)

Creates a VkExportMetalCommandQueueInfoEXT 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 VkExportMetalCommandQueueInfoEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExportMetalCommandQueueInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkExportMetalCommandQueueInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkExportMetalCommandQueueInfoEXT create(long address)

Returns a new VkExportMetalCommandQueueInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalCommandQueueInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExportMetalCommandQueueInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExportMetalCommandQueueInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExportMetalCommandQueueInfoEXT malloc(MemoryStack stack)

Returns a new VkExportMetalCommandQueueInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mtlCommandQueueback to summary
public long mtlCommandQueue()

the Metal id<MTLCommandQueue> object underlying the VkQueue object in queue. The implementation will return the MTLCommandQueue in this member, or it will return NULL if no MTLCommandQueue could be found underlying the VkQueue object.

Annotations
@NativeType:MTLCommandQueue_id
mtlCommandQueueback to summary
public VkExportMetalCommandQueueInfoEXT mtlCommandQueue(long value)

Sets the specified value to the mtlCommandQueue field.

nmtlCommandQueueback to summary
public static long nmtlCommandQueue(long struct)

Unsafe version of mtlCommandQueue.

nmtlCommandQueueback to summary
public static void nmtlCommandQueue(long struct, long value)

Unsafe version of mtlCommandQueue.

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.

nqueueback to summary
public static long nqueue(long struct)

Unsafe version of queue.

nqueueback to summary
public static void nqueue(long struct, VkQueue value)

Unsafe version of queue.

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

Sets the specified value to the pNext field.

queueback to summary
public long queue()

a VkQueue.

Annotations
@NativeType:VkQueue
queueback to summary
public VkExportMetalCommandQueueInfoEXT queue(VkQueue value)

Sets the specified value to the queue field.

setback to summary
public VkExportMetalCommandQueueInfoEXT set(int sType, long pNext, VkQueue queue, long mtlCommandQueue)

Initializes this struct with the specified values.

setback to summary
public VkExportMetalCommandQueueInfoEXT set(VkExportMetalCommandQueueInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkExportMetalCommandQueueInfoEXT

the source struct

Returns:VkExportMetalCommandQueueInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_METAL_COMMAND_QUEUE_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 VkExportMetalCommandQueueInfoEXT.Buffer

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

An array of VkExportMetalCommandQueueInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkExportMetalCommandQueueInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExportMetalCommandQueueInfoEXT.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 VkExportMetalCommandQueueInfoEXT
public long
public VkExportMetalCommandQueueInfoEXT.Buffer
mtlCommandQueue(long value)

Sets the specified value to the VkExportMetalCommandQueueInfoEXT#mtlCommandQueue field.

public long

Returns:

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

public VkExportMetalCommandQueueInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkExportMetalCommandQueueInfoEXT#pNext field.

public long

Returns:

the value of the VkExportMetalCommandQueueInfoEXT#queue field.
queue
()

public VkExportMetalCommandQueueInfoEXT.Buffer
queue(VkQueue value)

Sets the specified value to the VkExportMetalCommandQueueInfoEXT#queue field.

protected VkExportMetalCommandQueueInfoEXT.Buffer
public int

Returns:

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

public VkExportMetalCommandQueueInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkExportMetalCommandQueueInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExportMetalCommandQueueInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkExportMetalCommandQueueInfoEXT.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 VkExportMetalCommandQueueInfoEXT#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 VkExportMetalCommandQueueInfoEXT getElementFactory()

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

Annotations
@Override
mtlCommandQueueback to summary
public long mtlCommandQueue()
Returns:long

the value of the VkExportMetalCommandQueueInfoEXT#mtlCommandQueue field.

Annotations
@NativeType:MTLCommandQueue_id
mtlCommandQueueback to summary
public VkExportMetalCommandQueueInfoEXT.Buffer mtlCommandQueue(long value)

Sets the specified value to the VkExportMetalCommandQueueInfoEXT#mtlCommandQueue field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkExportMetalCommandQueueInfoEXT#pNext field.

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

Sets the specified value to the VkExportMetalCommandQueueInfoEXT#pNext field.

queueback to summary
public long queue()
Returns:long

the value of the VkExportMetalCommandQueueInfoEXT#queue field.

Annotations
@NativeType:VkQueue
queueback to summary
public VkExportMetalCommandQueueInfoEXT.Buffer queue(VkQueue value)

Sets the specified value to the VkExportMetalCommandQueueInfoEXT#queue field.

selfback to summary
protected VkExportMetalCommandQueueInfoEXT.Buffer self()

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

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

the value of the VkExportMetalCommandQueueInfoEXT#sType field.

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

Sets the specified value to the VkExportMetalCommandQueueInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_METAL_COMMAND_QUEUE_INFO_EXT value to the VkExportMetalCommandQueueInfoEXT#sType field.