Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExportMetalDeviceInfoEXT

extends Struct<VkExportMetalDeviceInfoEXT>
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 VkDevice object and corresponding Metal MTLDevice object.
Valid Usage (Implicit)

Layout


struct VkExportMetalDeviceInfoEXT {
    VkStructureType sType;
    void const * pNext;
    MTLDevice_id mtlDevice;
}

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
MTLDEVICE

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
VkExportMetalDeviceInfoEXT(long address, ByteBuffer container)

public
VkExportMetalDeviceInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExportMetalDeviceInfoEXT
calloc()

Returns a new VkExportMetalDeviceInfoEXT instance allocated with memCalloc.

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

Returns a new VkExportMetalDeviceInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkExportMetalDeviceInfoEXT instance allocated with BufferUtils.

public static VkExportMetalDeviceInfoEXT
create(long address)

Returns a new VkExportMetalDeviceInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalDeviceInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkExportMetalDeviceInfoEXT.Buffer instance at the specified memory.

public static VkExportMetalDeviceInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkExportMetalDeviceInfoEXT
malloc()

Returns a new VkExportMetalDeviceInfoEXT instance allocated with memAlloc.

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

Returns a new VkExportMetalDeviceInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkExportMetalDeviceInfoEXT instance allocated on the specified MemoryStack.

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

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

public long
mtlDevice()

the Metal id<MTLDevice> object underlying the VkPhysicalDevice associated with the VkDevice object identified in the call.

public VkExportMetalDeviceInfoEXT
mtlDevice(long value)

Sets the specified value to the mtlDevice field.

public static long
nmtlDevice(long struct)

Unsafe version of mtlDevice.

public static void
nmtlDevice(long struct, long value)

Unsafe version of mtlDevice.

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

Sets the specified value to the pNext field.

public VkExportMetalDeviceInfoEXT
set(int sType, long pNext, long mtlDevice)

Initializes this struct with the specified values.

public VkExportMetalDeviceInfoEXT

Returns:

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

Sets the specified value to the sType field.

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

MTLDEVICEback to summary
public static final int MTLDEVICE

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

VkExportMetalDeviceInfoEXTback to summary
protected VkExportMetalDeviceInfoEXT(long address, ByteBuffer container)
VkExportMetalDeviceInfoEXTback to summary
public VkExportMetalDeviceInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExportMetalDeviceInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkExportMetalDeviceInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkExportMetalDeviceInfoEXT create(long address)

Returns a new VkExportMetalDeviceInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalDeviceInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExportMetalDeviceInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExportMetalDeviceInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExportMetalDeviceInfoEXT malloc(MemoryStack stack)

Returns a new VkExportMetalDeviceInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mtlDeviceback to summary
public long mtlDevice()

the Metal id<MTLDevice> object underlying the VkPhysicalDevice associated with the VkDevice object identified in the call. The implementation will return the MTLDevice in this member, or it will return NULL if no MTLDevice could be found underlying the VkPhysicalDevice object.

Annotations
@NativeType:MTLDevice_id
mtlDeviceback to summary
public VkExportMetalDeviceInfoEXT mtlDevice(long value)

Sets the specified value to the mtlDevice field.

nmtlDeviceback to summary
public static long nmtlDevice(long struct)

Unsafe version of mtlDevice.

nmtlDeviceback to summary
public static void nmtlDevice(long struct, long value)

Unsafe version of mtlDevice.

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

Sets the specified value to the pNext field.

setback to summary
public VkExportMetalDeviceInfoEXT set(int sType, long pNext, long mtlDevice)

Initializes this struct with the specified values.

setback to summary
public VkExportMetalDeviceInfoEXT set(VkExportMetalDeviceInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkExportMetalDeviceInfoEXT

the source struct

Returns:VkExportMetalDeviceInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_METAL_DEVICE_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 VkExportMetalDeviceInfoEXT.Buffer

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

An array of VkExportMetalDeviceInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkExportMetalDeviceInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkExportMetalDeviceInfoEXT#mtlDevice field.
mtlDevice
()

public VkExportMetalDeviceInfoEXT.Buffer
mtlDevice(long value)

Sets the specified value to the VkExportMetalDeviceInfoEXT#mtlDevice field.

public long

Returns:

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

public VkExportMetalDeviceInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkExportMetalDeviceInfoEXT#pNext field.

protected VkExportMetalDeviceInfoEXT.Buffer
public int

Returns:

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

public VkExportMetalDeviceInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkExportMetalDeviceInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExportMetalDeviceInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
mtlDeviceback to summary
public long mtlDevice()
Returns:long

the value of the VkExportMetalDeviceInfoEXT#mtlDevice field.

Annotations
@NativeType:MTLDevice_id
mtlDeviceback to summary
public VkExportMetalDeviceInfoEXT.Buffer mtlDevice(long value)

Sets the specified value to the VkExportMetalDeviceInfoEXT#mtlDevice field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkExportMetalDeviceInfoEXT#pNext field.

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

Sets the specified value to the VkExportMetalDeviceInfoEXT#pNext field.

selfback to summary
protected VkExportMetalDeviceInfoEXT.Buffer self()

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

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

the value of the VkExportMetalDeviceInfoEXT#sType field.

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

Sets the specified value to the VkExportMetalDeviceInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_METAL_DEVICE_INFO_EXT value to the VkExportMetalDeviceInfoEXT#sType field.