Package org.lwjgl.vulkan

Class VkExportMetalCommandQueueInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExportMetalCommandQueueInfoEXT>

org.lwjgl.vulkan.VkExportMetalCommandQueueInfoEXT

All Implemented Interfaces:

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

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

Structure that identifies a VkQueue object and corresponding Metal MTLCommandQueue object.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_METAL_COMMAND_QUEUE_INFO_EXT
• queue must be a valid VkQueue handle

Layout

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

Nested Class Summary

Nested Classes

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

Method Summary

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

QUEUE

public static final int QUEUE

The struct member offsets.

MTLCOMMANDQUEUE

public static final int MTLCOMMANDQUEUE

The struct member offsets.

Constructor Details

VkExportMetalCommandQueueInfoEXT

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkExportMetalCommandQueueInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

queue

public long queue()

a VkQueue.

mtlCommandQueue

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.

sType

public VkExportMetalCommandQueueInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkExportMetalCommandQueueInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_EXPORT_METAL_COMMAND_QUEUE_INFO_EXT value to the sType() field.

pNext

public VkExportMetalCommandQueueInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

queue

public VkExportMetalCommandQueueInfoEXT queue(org.lwjgl.vulkan.VkQueue value)

Sets the specified value to the queue() field.

mtlCommandQueue

public VkExportMetalCommandQueueInfoEXT mtlCommandQueue(long value)

Sets the specified value to the mtlCommandQueue() field.

set

public VkExportMetalCommandQueueInfoEXT set(int sType,
 long pNext,
 org.lwjgl.vulkan.VkQueue queue,
 long mtlCommandQueue)

Initializes this struct with the specified values.

set

public VkExportMetalCommandQueueInfoEXT set(VkExportMetalCommandQueueInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExportMetalCommandQueueInfoEXT malloc()

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

calloc

public static VkExportMetalCommandQueueInfoEXT calloc()

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

create

public static VkExportMetalCommandQueueInfoEXT create()

Returns a new VkExportMetalCommandQueueInfoEXT instance allocated with BufferUtils.

create

public static VkExportMetalCommandQueueInfoEXT create(long address)

Returns a new VkExportMetalCommandQueueInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkExportMetalCommandQueueInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExportMetalCommandQueueInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExportMetalCommandQueueInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExportMetalCommandQueueInfoEXT.Buffer create(int capacity)

Returns a new VkExportMetalCommandQueueInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkExportMetalCommandQueueInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkExportMetalCommandQueueInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nqueue

public static long nqueue(long struct)

Unsafe version of queue().

nmtlCommandQueue

public static long nmtlCommandQueue(long struct)

Unsafe version of mtlCommandQueue().

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.

nqueue

public static void nqueue(long struct,
 org.lwjgl.vulkan.VkQueue value)

Unsafe version of queue.

nmtlCommandQueue

public static void nmtlCommandQueue(long struct,
 long value)

Unsafe version of mtlCommandQueue.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate