Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExportMetalBufferInfoEXT

extends Struct<VkExportMetalBufferInfoEXT>
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 VkDeviceMemory object and corresponding Metal MTLBuffer object.
Valid Usage (Implicit)

Layout


struct VkExportMetalBufferInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkDeviceMemory memory;
    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
MEMORY

The struct member offsets.

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

public
VkExportMetalBufferInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExportMetalBufferInfoEXT
calloc()

Returns a new VkExportMetalBufferInfoEXT instance allocated with memCalloc.

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

Returns a new VkExportMetalBufferInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkExportMetalBufferInfoEXT instance allocated with BufferUtils.

public static VkExportMetalBufferInfoEXT
create(long address)

Returns a new VkExportMetalBufferInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalBufferInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkExportMetalBufferInfoEXT.Buffer instance at the specified memory.

public static VkExportMetalBufferInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkExportMetalBufferInfoEXT
malloc()

Returns a new VkExportMetalBufferInfoEXT instance allocated with memAlloc.

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

Returns a new VkExportMetalBufferInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkExportMetalBufferInfoEXT instance allocated on the specified MemoryStack.

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

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

public long
memory()

a VkDeviceMemory.

public VkExportMetalBufferInfoEXT
memory(long value)

Sets the specified value to the memory field.

public long
mtlBuffer()

the Metal id<MTLBuffer> object underlying the VkDeviceMemory object in memory.

public VkExportMetalBufferInfoEXT
mtlBuffer(long value)

Sets the specified value to the mtlBuffer field.

public static long
nmemory(long struct)

Unsafe version of memory.

public static void
nmemory(long struct, long value)

Unsafe version of memory.

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

Sets the specified value to the pNext field.

public VkExportMetalBufferInfoEXT
set(int sType, long pNext, long memory, long mtlBuffer)

Initializes this struct with the specified values.

public VkExportMetalBufferInfoEXT

Returns:

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

Sets the specified value to the sType field.

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

MEMORYback to summary
public static final int MEMORY

The struct member offsets.

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

VkExportMetalBufferInfoEXTback to summary
protected VkExportMetalBufferInfoEXT(long address, ByteBuffer container)
VkExportMetalBufferInfoEXTback to summary
public VkExportMetalBufferInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExportMetalBufferInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkExportMetalBufferInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkExportMetalBufferInfoEXT create(long address)

Returns a new VkExportMetalBufferInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalBufferInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExportMetalBufferInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExportMetalBufferInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExportMetalBufferInfoEXT malloc(MemoryStack stack)

Returns a new VkExportMetalBufferInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

memoryback to summary
public long memory()

a VkDeviceMemory.

Annotations
@NativeType:VkDeviceMemory
memoryback to summary
public VkExportMetalBufferInfoEXT memory(long value)

Sets the specified value to the memory field.

mtlBufferback to summary
public long mtlBuffer()

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

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

Sets the specified value to the mtlBuffer field.

nmemoryback to summary
public static long nmemory(long struct)

Unsafe version of memory.

nmemoryback to summary
public static void nmemory(long struct, long value)

Unsafe version of memory.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkExportMetalBufferInfoEXT set(VkExportMetalBufferInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkExportMetalBufferInfoEXT

the source struct

Returns:VkExportMetalBufferInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_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 VkExportMetalBufferInfoEXT.Buffer

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

An array of VkExportMetalBufferInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkExportMetalBufferInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkExportMetalBufferInfoEXT#memory field.
memory
()

public VkExportMetalBufferInfoEXT.Buffer
memory(long value)

Sets the specified value to the VkExportMetalBufferInfoEXT#memory field.

public long

Returns:

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

public VkExportMetalBufferInfoEXT.Buffer
mtlBuffer(long value)

Sets the specified value to the VkExportMetalBufferInfoEXT#mtlBuffer field.

public long

Returns:

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

public VkExportMetalBufferInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkExportMetalBufferInfoEXT#pNext field.

protected VkExportMetalBufferInfoEXT.Buffer
public int

Returns:

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

public VkExportMetalBufferInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkExportMetalBufferInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExportMetalBufferInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
memoryback to summary
public long memory()
Returns:long

the value of the VkExportMetalBufferInfoEXT#memory field.

Annotations
@NativeType:VkDeviceMemory
memoryback to summary
public VkExportMetalBufferInfoEXT.Buffer memory(long value)

Sets the specified value to the VkExportMetalBufferInfoEXT#memory field.

mtlBufferback to summary
public long mtlBuffer()
Returns:long

the value of the VkExportMetalBufferInfoEXT#mtlBuffer field.

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

Sets the specified value to the VkExportMetalBufferInfoEXT#mtlBuffer field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkExportMetalBufferInfoEXT#pNext field.

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

Sets the specified value to the VkExportMetalBufferInfoEXT#pNext field.

selfback to summary
protected VkExportMetalBufferInfoEXT.Buffer self()

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

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

the value of the VkExportMetalBufferInfoEXT#sType field.

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

Sets the specified value to the VkExportMetalBufferInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_METAL_BUFFER_INFO_EXT value to the VkExportMetalBufferInfoEXT#sType field.