Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExportMetalObjectCreateInfoEXT

extends Struct<VkExportMetalObjectCreateInfoEXT>
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 the Metal objects that can be exported from Vulkan objects.
Valid Usage (Implicit)

Layout


struct VkExportMetalObjectCreateInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkExportMetalObjectTypeFlagBitsEXT exportObjectType;
}

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
EXPORTOBJECTTYPE

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
public
VkExportMetalObjectCreateInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkExportMetalObjectCreateInfoEXT
calloc()

Returns a new VkExportMetalObjectCreateInfoEXT instance allocated with memCalloc.

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

Returns a new VkExportMetalObjectCreateInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkExportMetalObjectCreateInfoEXT instance allocated with BufferUtils.

public static VkExportMetalObjectCreateInfoEXT
create(long address)

Returns a new VkExportMetalObjectCreateInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalObjectCreateInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkExportMetalObjectCreateInfoEXT.Buffer instance at the specified memory.

public static VkExportMetalObjectCreateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
exportObjectType()

a VkExportMetalObjectTypeFlagBitsEXT indicating the type of Metal object that the application may request to be exported from the Vulkan object.

public VkExportMetalObjectCreateInfoEXT
exportObjectType(int value)

Sets the specified value to the exportObjectType field.

public static VkExportMetalObjectCreateInfoEXT
malloc()

Returns a new VkExportMetalObjectCreateInfoEXT instance allocated with memAlloc.

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

Returns a new VkExportMetalObjectCreateInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkExportMetalObjectCreateInfoEXT instance allocated on the specified MemoryStack.

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

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

public static int
nexportObjectType(long struct)

Unsafe version of exportObjectType.

public static void
nexportObjectType(long struct, int value)

Unsafe version of exportObjectType.

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

Sets the specified value to the pNext field.

public VkExportMetalObjectCreateInfoEXT
set(int sType, long pNext, int exportObjectType)

Initializes this struct with the specified values.

public VkExportMetalObjectCreateInfoEXT

Returns:

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

Sets the specified value to the sType field.

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

EXPORTOBJECTTYPEback to summary
public static final int EXPORTOBJECTTYPE

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

VkExportMetalObjectCreateInfoEXTback to summary
protected VkExportMetalObjectCreateInfoEXT(long address, ByteBuffer container)
VkExportMetalObjectCreateInfoEXTback to summary
public VkExportMetalObjectCreateInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExportMetalObjectCreateInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkExportMetalObjectCreateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkExportMetalObjectCreateInfoEXT create(long address)

Returns a new VkExportMetalObjectCreateInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalObjectCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExportMetalObjectCreateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExportMetalObjectCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
exportObjectTypeback to summary
public int exportObjectType()

a VkExportMetalObjectTypeFlagBitsEXT indicating the type of Metal object that the application may request to be exported from the Vulkan object.

Annotations
@NativeType:VkExportMetalObjectTypeFlagBitsEXT
exportObjectTypeback to summary
public VkExportMetalObjectCreateInfoEXT exportObjectType(int value)

Sets the specified value to the exportObjectType field.

mallocback to summary
public static VkExportMetalObjectCreateInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExportMetalObjectCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkExportMetalObjectCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nexportObjectTypeback to summary
public static int nexportObjectType(long struct)

Unsafe version of exportObjectType.

nexportObjectTypeback to summary
public static void nexportObjectType(long struct, int value)

Unsafe version of exportObjectType.

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

Sets the specified value to the pNext field.

setback to summary
public VkExportMetalObjectCreateInfoEXT set(int sType, long pNext, int exportObjectType)

Initializes this struct with the specified values.

setback to summary
public VkExportMetalObjectCreateInfoEXT set(VkExportMetalObjectCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkExportMetalObjectCreateInfoEXT

the source struct

Returns:VkExportMetalObjectCreateInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_METAL_OBJECT_CREATE_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkExportMetalObjectCreateInfoEXT.Buffer

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

An array of VkExportMetalObjectCreateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkExportMetalObjectCreateInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExportMetalObjectCreateInfoEXT.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
public int
public VkExportMetalObjectCreateInfoEXT.Buffer
exportObjectType(int value)

Sets the specified value to the VkExportMetalObjectCreateInfoEXT#exportObjectType field.

protected VkExportMetalObjectCreateInfoEXT
public long

Returns:

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

public VkExportMetalObjectCreateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkExportMetalObjectCreateInfoEXT#pNext field.

protected VkExportMetalObjectCreateInfoEXT.Buffer
public int

Returns:

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

public VkExportMetalObjectCreateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkExportMetalObjectCreateInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExportMetalObjectCreateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkExportMetalObjectCreateInfoEXT.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 VkExportMetalObjectCreateInfoEXT#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

exportObjectTypeback to summary
public int exportObjectType()
Returns:int

the value of the VkExportMetalObjectCreateInfoEXT#exportObjectType field.

Annotations
@NativeType:VkExportMetalObjectTypeFlagBitsEXT
exportObjectTypeback to summary
public VkExportMetalObjectCreateInfoEXT.Buffer exportObjectType(int value)

Sets the specified value to the VkExportMetalObjectCreateInfoEXT#exportObjectType field.

getElementFactoryback to summary
protected VkExportMetalObjectCreateInfoEXT getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkExportMetalObjectCreateInfoEXT#pNext field.

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

Sets the specified value to the VkExportMetalObjectCreateInfoEXT#pNext field.

selfback to summary
protected VkExportMetalObjectCreateInfoEXT.Buffer self()

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

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

the value of the VkExportMetalObjectCreateInfoEXT#sType field.

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

Sets the specified value to the VkExportMetalObjectCreateInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_METAL_OBJECT_CREATE_INFO_EXT value to the VkExportMetalObjectCreateInfoEXT#sType field.