Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImportMetalTextureInfoEXT

extends Struct<VkImportMetalTextureInfoEXT>
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 Metal MTLTexture objects to use when creating a VkImage.
Description

The pNext chain must include one VkImportMetalTextureInfoEXT structure for each plane in the VkImage. The app must ensure that the configuration of the Metal id<MTLTexture> objects are compatible with the configuration of the VkImage. Failure to do so results in undefined behavior.

Valid Usage (Implicit)

Layout


struct VkImportMetalTextureInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkImageAspectFlagBits plane;
    MTLTexture_id mtlTexture;
}

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
MTLTEXTURE

The struct member offsets.

public static final int
PLANE

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

public
VkImportMetalTextureInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImportMetalTextureInfoEXT
calloc()

Returns a new VkImportMetalTextureInfoEXT instance allocated with memCalloc.

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

Returns a new VkImportMetalTextureInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkImportMetalTextureInfoEXT instance allocated with BufferUtils.

public static VkImportMetalTextureInfoEXT
create(long address)

Returns a new VkImportMetalTextureInfoEXT instance for the specified memory address.

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

Returns a new VkImportMetalTextureInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkImportMetalTextureInfoEXT.Buffer instance at the specified memory.

public static VkImportMetalTextureInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkImportMetalTextureInfoEXT
malloc()

Returns a new VkImportMetalTextureInfoEXT instance allocated with memAlloc.

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

Returns a new VkImportMetalTextureInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkImportMetalTextureInfoEXT instance allocated on the specified MemoryStack.

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

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

public long
mtlTexture()

a the Metal id<MTLTexture> object that is to underlie the VkImage plane.

public VkImportMetalTextureInfoEXT
mtlTexture(long value)

Sets the specified value to the mtlTexture field.

public static long
nmtlTexture(long struct)

Unsafe version of mtlTexture.

public static void
nmtlTexture(long struct, long value)

Unsafe version of mtlTexture.

public static int
nplane(long struct)

Unsafe version of plane.

public static void
nplane(long struct, int value)

Unsafe version of plane.

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 int
plane()

indicates the plane of the VkImage that the id<MTLTexture> object should be attached to.

public VkImportMetalTextureInfoEXT
plane(int value)

Sets the specified value to the plane field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkImportMetalTextureInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkImportMetalTextureInfoEXT
set(int sType, long pNext, int plane, long mtlTexture)

Initializes this struct with the specified values.

public VkImportMetalTextureInfoEXT

Returns:

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

Sets the specified value to the sType field.

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

MTLTEXTUREback to summary
public static final int MTLTEXTURE

The struct member offsets.

PLANEback to summary
public static final int PLANE

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

VkImportMetalTextureInfoEXTback to summary
protected VkImportMetalTextureInfoEXT(long address, ByteBuffer container)
VkImportMetalTextureInfoEXTback to summary
public VkImportMetalTextureInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImportMetalTextureInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkImportMetalTextureInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkImportMetalTextureInfoEXT create(long address)

Returns a new VkImportMetalTextureInfoEXT instance for the specified memory address.

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

Returns a new VkImportMetalTextureInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImportMetalTextureInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImportMetalTextureInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImportMetalTextureInfoEXT malloc(MemoryStack stack)

Returns a new VkImportMetalTextureInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mtlTextureback to summary
public long mtlTexture()

a the Metal id<MTLTexture> object that is to underlie the VkImage plane.

Annotations
@NativeType:MTLTexture_id
mtlTextureback to summary
public VkImportMetalTextureInfoEXT mtlTexture(long value)

Sets the specified value to the mtlTexture field.

nmtlTextureback to summary
public static long nmtlTexture(long struct)

Unsafe version of mtlTexture.

nmtlTextureback to summary
public static void nmtlTexture(long struct, long value)

Unsafe version of mtlTexture.

nplaneback to summary
public static int nplane(long struct)

Unsafe version of plane.

nplaneback to summary
public static void nplane(long struct, int value)

Unsafe version of plane.

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.

planeback to summary
public int plane()

indicates the plane of the VkImage that the id<MTLTexture> object should be attached to.

Annotations
@NativeType:VkImageAspectFlagBits
planeback to summary
public VkImportMetalTextureInfoEXT plane(int value)

Sets the specified value to the plane field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkImportMetalTextureInfoEXT set(int sType, long pNext, int plane, long mtlTexture)

Initializes this struct with the specified values.

setback to summary
public VkImportMetalTextureInfoEXT set(VkImportMetalTextureInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImportMetalTextureInfoEXT

the source struct

Returns:VkImportMetalTextureInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_IMPORT_METAL_TEXTURE_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 VkImportMetalTextureInfoEXT.Buffer

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

An array of VkImportMetalTextureInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImportMetalTextureInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkImportMetalTextureInfoEXT#mtlTexture field.
mtlTexture
()

public VkImportMetalTextureInfoEXT.Buffer
mtlTexture(long value)

Sets the specified value to the VkImportMetalTextureInfoEXT#mtlTexture field.

public int

Returns:

the value of the VkImportMetalTextureInfoEXT#plane field.
plane
()

public VkImportMetalTextureInfoEXT.Buffer
plane(int value)

Sets the specified value to the VkImportMetalTextureInfoEXT#plane field.

public long

Returns:

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

public VkImportMetalTextureInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkImportMetalTextureInfoEXT#pNext field.

protected VkImportMetalTextureInfoEXT.Buffer
public int

Returns:

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

public VkImportMetalTextureInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkImportMetalTextureInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImportMetalTextureInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
mtlTextureback to summary
public long mtlTexture()
Returns:long

the value of the VkImportMetalTextureInfoEXT#mtlTexture field.

Annotations
@NativeType:MTLTexture_id
mtlTextureback to summary
public VkImportMetalTextureInfoEXT.Buffer mtlTexture(long value)

Sets the specified value to the VkImportMetalTextureInfoEXT#mtlTexture field.

planeback to summary
public int plane()
Returns:int

the value of the VkImportMetalTextureInfoEXT#plane field.

Annotations
@NativeType:VkImageAspectFlagBits
planeback to summary
public VkImportMetalTextureInfoEXT.Buffer plane(int value)

Sets the specified value to the VkImportMetalTextureInfoEXT#plane field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImportMetalTextureInfoEXT#pNext field.

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

Sets the specified value to the VkImportMetalTextureInfoEXT#pNext field.

selfback to summary
protected VkImportMetalTextureInfoEXT.Buffer self()

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

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

the value of the VkImportMetalTextureInfoEXT#sType field.

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

Sets the specified value to the VkImportMetalTextureInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_IMPORT_METAL_TEXTURE_INFO_EXT value to the VkImportMetalTextureInfoEXT#sType field.