Package org.lwjgl.vulkan

Class VkExportMetalObjectsInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkExportMetalObjectsInfoEXT>

org.lwjgl.vulkan.VkExportMetalObjectsInfoEXT

All Implemented Interfaces:

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

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

Structure whose pNext chain identifies Vulkan objects and corresponding Metal objects.

Valid Usage

• If the pNext chain includes a VkExportMetalDeviceInfoEXT structure, the VkInstance must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_DEVICE_BIT_EXT in the exportObjectType member of a VkExportMetalObjectCreateInfoEXT structure in the pNext chain of the VkInstanceCreateInfo structure in the CreateInstance command
• If the pNext chain includes a VkExportMetalCommandQueueInfoEXT structure, the VkInstance must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_COMMAND_QUEUE_BIT_EXT in the exportObjectType member of a VkExportMetalObjectCreateInfoEXT structure in the pNext chain of the VkInstanceCreateInfo structure in the CreateInstance command
• If the pNext chain includes a VkExportMetalBufferInfoEXT structure, the VkDeviceMemory in its memory member must have been allocated with EXPORT_METAL_OBJECT_TYPE_METAL_BUFFER_BIT_EXT in the exportObjectType member of a VkExportMetalObjectCreateInfoEXT structure in the pNext chain of the VkMemoryAllocateInfo structure in the AllocateMemory command
• If the pNext chain includes a VkExportMetalTextureInfoEXT structure, exactly one of its image, imageView, or bufferView members must not be NULL_HANDLE
• If the pNext chain includes a VkExportMetalTextureInfoEXT structure, and its image member is not NULL_HANDLE, the VkImage in its image member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT in the exportObjectType member of a VkExportMetalObjectCreateInfoEXT structure in the pNext chain of the VkImageCreateInfo structure in the CreateImage command
• If the pNext chain includes a VkExportMetalTextureInfoEXT structure, and its imageView member is not NULL_HANDLE, the VkImageView in its imageView member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT in the exportObjectType member of a VkExportMetalObjectCreateInfoEXT structure in the pNext chain of the VkImageViewCreateInfo structure in the CreateImageView command
• If the pNext chain includes a VkExportMetalTextureInfoEXT structure, and its bufferView member is not NULL_HANDLE, the VkBufferView in its bufferView member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_TEXTURE_BIT_EXT in the exportObjectType member of a VkExportMetalObjectCreateInfoEXT structure in the pNext chain of the VkBufferViewCreateInfo structure in the CreateBufferView command
• If the pNext chain includes a VkExportMetalTextureInfoEXT structure, and if either its image or imageView member is not NULL_HANDLE, then plane must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT
• If the pNext chain includes a VkExportMetalTextureInfoEXT structure, and if the VkImage in its image member does not have a multi-planar format, then its plane member must be IMAGE_ASPECT_PLANE_0_BIT
• If the pNext chain includes a VkExportMetalTextureInfoEXT structure, and if the VkImage in its image member has a multi-planar format with only two planes, then its plane member must not be IMAGE_ASPECT_PLANE_2_BIT
• If the pNext chain includes a VkExportMetalTextureInfoEXT structure, and if the VkImageView in its imageView member does not have a multi-planar format, then its plane member must be IMAGE_ASPECT_PLANE_0_BIT
• If the pNext chain includes a VkExportMetalTextureInfoEXT structure, and if the VkImageView in its imageView member has a multi-planar format with only two planes, then its plane member must not be IMAGE_ASPECT_PLANE_2_BIT
• If the pNext chain includes a VkExportMetalIOSurfaceInfoEXT structure, the VkImage in its image member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_IOSURFACE_BIT_EXT in the exportObjectType member of a VkExportMetalObjectCreateInfoEXT structure in the pNext chain of the VkImageCreateInfo structure in the CreateImage command
• If the pNext chain includes a VkExportMetalSharedEventInfoEXT structure, exactly one of its semaphore or event members must not be NULL_HANDLE
• If the pNext chain includes a VkExportMetalSharedEventInfoEXT structure, and its semaphore member is not NULL_HANDLE, the VkSemaphore in its semaphore member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT in the exportObjectType member of a VkExportMetalObjectCreateInfoEXT structure in the pNext chain of the VkSemaphoreCreateInfo structure in the CreateSemaphore command
• If the pNext chain includes a VkExportMetalSharedEventInfoEXT structure, and its event member is not NULL_HANDLE, the VkEvent in its event member must have been created with EXPORT_METAL_OBJECT_TYPE_METAL_SHARED_EVENT_BIT_EXT in the exportObjectType member of a VkExportMetalObjectCreateInfoEXT structure in the pNext chain of the VkEventCreateInfo structure in the CreateEvent command

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_METAL_OBJECTS_INFO_EXT
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkExportMetalBufferInfoEXT, VkExportMetalCommandQueueInfoEXT, VkExportMetalDeviceInfoEXT, VkExportMetalIOSurfaceInfoEXT, VkExportMetalSharedEventInfoEXT, or VkExportMetalTextureInfoEXT
• The sType value of each struct in the pNext chain must be unique, with the exception of structures of type VkExportMetalBufferInfoEXT, VkExportMetalCommandQueueInfoEXT, VkExportMetalIOSurfaceInfoEXT, VkExportMetalSharedEventInfoEXT, or VkExportMetalTextureInfoEXT

See Also

ExportMetalObjectsEXT

Layout

 struct VkExportMetalObjectsInfoEXT {
     VkStructureType sType();
     void const * pNext();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkExportMetalObjectsInfoEXT	calloc()	Returns a new VkExportMetalObjectsInfoEXT instance allocated with memCalloc.
static VkExportMetalObjectsInfoEXT.Buffer	calloc(int capacity)	Returns a new VkExportMetalObjectsInfoEXT.Buffer instance allocated with memCalloc.
static VkExportMetalObjectsInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMetalObjectsInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExportMetalObjectsInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMetalObjectsInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkExportMetalObjectsInfoEXT	create()	Returns a new VkExportMetalObjectsInfoEXT instance allocated with BufferUtils.
static VkExportMetalObjectsInfoEXT.Buffer	create(int capacity)	Returns a new VkExportMetalObjectsInfoEXT.Buffer instance allocated with BufferUtils.
static VkExportMetalObjectsInfoEXT	create(long address)	Returns a new VkExportMetalObjectsInfoEXT instance for the specified memory address.
static VkExportMetalObjectsInfoEXT.Buffer	create(long address, int capacity)	Create a VkExportMetalObjectsInfoEXT.Buffer instance at the specified memory.
static @Nullable VkExportMetalObjectsInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkExportMetalObjectsInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkExportMetalObjectsInfoEXT	malloc()	Returns a new VkExportMetalObjectsInfoEXT instance allocated with memAlloc.
static VkExportMetalObjectsInfoEXT.Buffer	malloc(int capacity)	Returns a new VkExportMetalObjectsInfoEXT.Buffer instance allocated with memAlloc.
static VkExportMetalObjectsInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMetalObjectsInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkExportMetalObjectsInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkExportMetalObjectsInfoEXT instance allocated on the specified MemoryStack.
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.
VkExportMetalObjectsInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkExportMetalObjectsInfoEXT	pNext(VkExportMetalBufferInfoEXT value)	Prepends the specified VkExportMetalBufferInfoEXT value to the pNext chain.
VkExportMetalObjectsInfoEXT	pNext(VkExportMetalCommandQueueInfoEXT value)	Prepends the specified VkExportMetalCommandQueueInfoEXT value to the pNext chain.
VkExportMetalObjectsInfoEXT	pNext(VkExportMetalDeviceInfoEXT value)	Prepends the specified VkExportMetalDeviceInfoEXT value to the pNext chain.
VkExportMetalObjectsInfoEXT	pNext(VkExportMetalIOSurfaceInfoEXT value)	Prepends the specified VkExportMetalIOSurfaceInfoEXT value to the pNext chain.
VkExportMetalObjectsInfoEXT	pNext(VkExportMetalSharedEventInfoEXT value)	Prepends the specified VkExportMetalSharedEventInfoEXT value to the pNext chain.
VkExportMetalObjectsInfoEXT	pNext(VkExportMetalTextureInfoEXT value)	Prepends the specified VkExportMetalTextureInfoEXT value to the pNext chain.
VkExportMetalObjectsInfoEXT	set(int sType, long pNext)	Initializes this struct with the specified values.
VkExportMetalObjectsInfoEXT	set(VkExportMetalObjectsInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkExportMetalObjectsInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkExportMetalObjectsInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_EXPORT_METAL_OBJECTS_INFO_EXT value to the sType() field.

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.

Constructor Details

VkExportMetalObjectsInfoEXT

public VkExportMetalObjectsInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

sType

public VkExportMetalObjectsInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkExportMetalObjectsInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_EXPORT_METAL_OBJECTS_INFO_EXT value to the sType() field.

pNext

public VkExportMetalObjectsInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkExportMetalObjectsInfoEXT pNext(VkExportMetalBufferInfoEXT value)

Prepends the specified VkExportMetalBufferInfoEXT value to the pNext chain.

pNext

public VkExportMetalObjectsInfoEXT pNext(VkExportMetalCommandQueueInfoEXT value)

Prepends the specified VkExportMetalCommandQueueInfoEXT value to the pNext chain.

pNext

public VkExportMetalObjectsInfoEXT pNext(VkExportMetalDeviceInfoEXT value)

Prepends the specified VkExportMetalDeviceInfoEXT value to the pNext chain.

pNext

public VkExportMetalObjectsInfoEXT pNext(VkExportMetalIOSurfaceInfoEXT value)

Prepends the specified VkExportMetalIOSurfaceInfoEXT value to the pNext chain.

pNext

public VkExportMetalObjectsInfoEXT pNext(VkExportMetalSharedEventInfoEXT value)

Prepends the specified VkExportMetalSharedEventInfoEXT value to the pNext chain.

pNext

public VkExportMetalObjectsInfoEXT pNext(VkExportMetalTextureInfoEXT value)

Prepends the specified VkExportMetalTextureInfoEXT value to the pNext chain.

set

public VkExportMetalObjectsInfoEXT set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkExportMetalObjectsInfoEXT set(VkExportMetalObjectsInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkExportMetalObjectsInfoEXT malloc()

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

calloc

public static VkExportMetalObjectsInfoEXT calloc()

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

create

public static VkExportMetalObjectsInfoEXT create()

Returns a new VkExportMetalObjectsInfoEXT instance allocated with BufferUtils.

create

public static VkExportMetalObjectsInfoEXT create(long address)

Returns a new VkExportMetalObjectsInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkExportMetalObjectsInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkExportMetalObjectsInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkExportMetalObjectsInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkExportMetalObjectsInfoEXT.Buffer create(int capacity)

Returns a new VkExportMetalObjectsInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkExportMetalObjectsInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkExportMetalObjectsInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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.