Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImportMetalBufferInfoEXT

extends Struct<VkImportMetalBufferInfoEXT>
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 Metal MTLBuffer object to use when creating a VkDeviceMemory object.
Description

The app must ensure that the configuration of the id<MTLBuffer> object is compatible with the configuration of the VkDeviceMemory. Failure to do so results in undefined behavior.

Valid Usage (Implicit)

Layout


struct VkImportMetalBufferInfoEXT {
    VkStructureType sType;
    void const * pNext;
    MTLBuffer_id mtlBuffer;
}

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
MTLBUFFER

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

public
VkImportMetalBufferInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImportMetalBufferInfoEXT
calloc()

Returns a new VkImportMetalBufferInfoEXT instance allocated with memCalloc.

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

Returns a new VkImportMetalBufferInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkImportMetalBufferInfoEXT instance allocated with BufferUtils.

public static VkImportMetalBufferInfoEXT
create(long address)

Returns a new VkImportMetalBufferInfoEXT instance for the specified memory address.

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

Returns a new VkImportMetalBufferInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkImportMetalBufferInfoEXT.Buffer instance at the specified memory.

public static VkImportMetalBufferInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkImportMetalBufferInfoEXT
malloc()

Returns a new VkImportMetalBufferInfoEXT instance allocated with memAlloc.

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

Returns a new VkImportMetalBufferInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkImportMetalBufferInfoEXT instance allocated on the specified MemoryStack.

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

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

public long
mtlBuffer()

the Metal id<MTLBuffer> object that is to underlie the VkDeviceMemory.

public VkImportMetalBufferInfoEXT
mtlBuffer(long value)

Sets the specified value to the mtlBuffer field.

public static long
nmtlBuffer(long struct)

Unsafe version of mtlBuffer.

public static void
nmtlBuffer(long struct, long value)

Unsafe version of mtlBuffer.

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

Sets the specified value to the pNext field.

public VkImportMetalBufferInfoEXT
set(int sType, long pNext, long mtlBuffer)

Initializes this struct with the specified values.

public VkImportMetalBufferInfoEXT

Returns:

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

Sets the specified value to the sType field.

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

MTLBUFFERback to summary
public static final int MTLBUFFER

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

VkImportMetalBufferInfoEXTback to summary
protected VkImportMetalBufferInfoEXT(long address, ByteBuffer container)
VkImportMetalBufferInfoEXTback to summary
public VkImportMetalBufferInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImportMetalBufferInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkImportMetalBufferInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkImportMetalBufferInfoEXT create(long address)

Returns a new VkImportMetalBufferInfoEXT instance for the specified memory address.

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

Returns a new VkImportMetalBufferInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImportMetalBufferInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImportMetalBufferInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImportMetalBufferInfoEXT malloc(MemoryStack stack)

Returns a new VkImportMetalBufferInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mtlBufferback to summary
public long mtlBuffer()

the Metal id<MTLBuffer> object that is to underlie the VkDeviceMemory.

Annotations
@NativeType:MTLBuffer_id
mtlBufferback to summary
public VkImportMetalBufferInfoEXT mtlBuffer(long value)

Sets the specified value to the mtlBuffer field.

nmtlBufferback to summary
public static long nmtlBuffer(long struct)

Unsafe version of mtlBuffer.

nmtlBufferback to summary
public static void nmtlBuffer(long struct, long value)

Unsafe version of mtlBuffer.

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

Sets the specified value to the pNext field.

setback to summary
public VkImportMetalBufferInfoEXT set(int sType, long pNext, long mtlBuffer)

Initializes this struct with the specified values.

setback to summary
public VkImportMetalBufferInfoEXT set(VkImportMetalBufferInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImportMetalBufferInfoEXT

the source struct

Returns:VkImportMetalBufferInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_IMPORT_METAL_BUFFER_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 VkImportMetalBufferInfoEXT.Buffer

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

An array of VkImportMetalBufferInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImportMetalBufferInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkImportMetalBufferInfoEXT#mtlBuffer field.
mtlBuffer
()

public VkImportMetalBufferInfoEXT.Buffer
mtlBuffer(long value)

Sets the specified value to the VkImportMetalBufferInfoEXT#mtlBuffer field.

public long

Returns:

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

public VkImportMetalBufferInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkImportMetalBufferInfoEXT#pNext field.

protected VkImportMetalBufferInfoEXT.Buffer
public int

Returns:

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

public VkImportMetalBufferInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkImportMetalBufferInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImportMetalBufferInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
mtlBufferback to summary
public long mtlBuffer()
Returns:long

the value of the VkImportMetalBufferInfoEXT#mtlBuffer field.

Annotations
@NativeType:MTLBuffer_id
mtlBufferback to summary
public VkImportMetalBufferInfoEXT.Buffer mtlBuffer(long value)

Sets the specified value to the VkImportMetalBufferInfoEXT#mtlBuffer field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImportMetalBufferInfoEXT#pNext field.

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

Sets the specified value to the VkImportMetalBufferInfoEXT#pNext field.

selfback to summary
protected VkImportMetalBufferInfoEXT.Buffer self()

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

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

the value of the VkImportMetalBufferInfoEXT#sType field.

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

Sets the specified value to the VkImportMetalBufferInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_IMPORT_METAL_BUFFER_INFO_EXT value to the VkImportMetalBufferInfoEXT#sType field.