Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExportMetalTextureInfoEXT

extends Struct<VkExportMetalTextureInfoEXT>
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 VkImage, VkImageView, or VkBufferView object and corresponding Metal MTLTexture object.
Valid Usage (Implicit)

Layout


struct VkExportMetalTextureInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkImage image;
    VkImageView imageView;
    VkBufferView bufferView;
    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
BUFFERVIEW

The struct member offsets.

public static final int
IMAGE

The struct member offsets.

public static final int
IMAGEVIEW

The struct member offsets.

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

public
VkExportMetalTextureInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
bufferView()

NULL_HANDLE or a VkBufferView.

public VkExportMetalTextureInfoEXT
bufferView(long value)

Sets the specified value to the bufferView field.

public static VkExportMetalTextureInfoEXT
calloc()

Returns a new VkExportMetalTextureInfoEXT instance allocated with memCalloc.

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

Returns a new VkExportMetalTextureInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkExportMetalTextureInfoEXT instance allocated with BufferUtils.

public static VkExportMetalTextureInfoEXT
create(long address)

Returns a new VkExportMetalTextureInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalTextureInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkExportMetalTextureInfoEXT.Buffer instance at the specified memory.

public static VkExportMetalTextureInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
image()

NULL_HANDLE or a VkImage.

public VkExportMetalTextureInfoEXT
image(long value)

Sets the specified value to the image field.

public long
imageView()

NULL_HANDLE or a VkImageView.

public VkExportMetalTextureInfoEXT
imageView(long value)

Sets the specified value to the imageView field.

public static VkExportMetalTextureInfoEXT
malloc()

Returns a new VkExportMetalTextureInfoEXT instance allocated with memAlloc.

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

Returns a new VkExportMetalTextureInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkExportMetalTextureInfoEXT instance allocated on the specified MemoryStack.

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

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

public long
mtlTexture()

the Metal id<MTLTexture> object underlying the VkImage, VkImageView, or VkBufferView object in image, imageView, or bufferView, respectively, at the plane indicated in aspectMask.

public VkExportMetalTextureInfoEXT
mtlTexture(long value)

Sets the specified value to the mtlTexture field.

public static long
nbufferView(long struct)

Unsafe version of bufferView.

public static void
nbufferView(long struct, long value)

Unsafe version of bufferView.

public static long
nimage(long struct)

Unsafe version of image.

public static void
nimage(long struct, long value)

Unsafe version of image.

public static long
nimageView(long struct)

Unsafe version of imageView.

public static void
nimageView(long struct, long value)

Unsafe version of imageView.

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 a multi-planar VkImage or VkImageView.

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

Sets the specified value to the pNext field.

public VkExportMetalTextureInfoEXT
set(int sType, long pNext, long image, long imageView, long bufferView, int plane, long mtlTexture)

Initializes this struct with the specified values.

public VkExportMetalTextureInfoEXT

Returns:

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

Sets the specified value to the sType field.

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

BUFFERVIEWback to summary
public static final int BUFFERVIEW

The struct member offsets.

IMAGEback to summary
public static final int IMAGE

The struct member offsets.

IMAGEVIEWback to summary
public static final int IMAGEVIEW

The struct member offsets.

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

VkExportMetalTextureInfoEXTback to summary
protected VkExportMetalTextureInfoEXT(long address, ByteBuffer container)
VkExportMetalTextureInfoEXTback to summary
public VkExportMetalTextureInfoEXT(ByteBuffer container)

Creates a VkExportMetalTextureInfoEXT 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

bufferViewback to summary
public long bufferView()

NULL_HANDLE or a VkBufferView.

Annotations
@NativeType:VkBufferView
bufferViewback to summary
public VkExportMetalTextureInfoEXT bufferView(long value)

Sets the specified value to the bufferView field.

callocback to summary
public static VkExportMetalTextureInfoEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExportMetalTextureInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkExportMetalTextureInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkExportMetalTextureInfoEXT create(long address)

Returns a new VkExportMetalTextureInfoEXT instance for the specified memory address.

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

Returns a new VkExportMetalTextureInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkExportMetalTextureInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExportMetalTextureInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageback to summary
public long image()

NULL_HANDLE or a VkImage.

Annotations
@NativeType:VkImage
imageback to summary
public VkExportMetalTextureInfoEXT image(long value)

Sets the specified value to the image field.

imageViewback to summary
public long imageView()

NULL_HANDLE or a VkImageView.

Annotations
@NativeType:VkImageView
imageViewback to summary
public VkExportMetalTextureInfoEXT imageView(long value)

Sets the specified value to the imageView field.

mallocback to summary
public static VkExportMetalTextureInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExportMetalTextureInfoEXT malloc(MemoryStack stack)

Returns a new VkExportMetalTextureInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

the Metal id<MTLTexture> object underlying the VkImage, VkImageView, or VkBufferView object in image, imageView, or bufferView, respectively, at the plane indicated in aspectMask. The implementation will return the MTLTexture in this member, or it will return NULL if no MTLTexture could be found underlying the VkImage, VkImageView, or VkBufferView object, at the plane indicated in aspectMask.

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

Sets the specified value to the mtlTexture field.

nbufferViewback to summary
public static long nbufferView(long struct)

Unsafe version of bufferView.

nbufferViewback to summary
public static void nbufferView(long struct, long value)

Unsafe version of bufferView.

nimageback to summary
public static long nimage(long struct)

Unsafe version of image.

nimageback to summary
public static void nimage(long struct, long value)

Unsafe version of image.

nimageViewback to summary
public static long nimageView(long struct)

Unsafe version of imageView.

nimageViewback to summary
public static void nimageView(long struct, long value)

Unsafe version of imageView.

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 a multi-planar VkImage or VkImageView.

Annotations
@NativeType:VkImageAspectFlagBits
planeback to summary
public VkExportMetalTextureInfoEXT 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 VkExportMetalTextureInfoEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkExportMetalTextureInfoEXT set(int sType, long pNext, long image, long imageView, long bufferView, int plane, long mtlTexture)

Initializes this struct with the specified values.

setback to summary
public VkExportMetalTextureInfoEXT set(VkExportMetalTextureInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkExportMetalTextureInfoEXT

the source struct

Returns:VkExportMetalTextureInfoEXT

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

Sets the specified value to the sType field.

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

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

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

An array of VkExportMetalTextureInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkExportMetalTextureInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkExportMetalTextureInfoEXT#bufferView field.
bufferView
()

public VkExportMetalTextureInfoEXT.Buffer
bufferView(long value)

Sets the specified value to the VkExportMetalTextureInfoEXT#bufferView field.

protected VkExportMetalTextureInfoEXT
public long

Returns:

the value of the VkExportMetalTextureInfoEXT#image field.
image
()

public VkExportMetalTextureInfoEXT.Buffer
image(long value)

Sets the specified value to the VkExportMetalTextureInfoEXT#image field.

public long

Returns:

the value of the VkExportMetalTextureInfoEXT#imageView field.
imageView
()

public VkExportMetalTextureInfoEXT.Buffer
imageView(long value)

Sets the specified value to the VkExportMetalTextureInfoEXT#imageView field.

public long

Returns:

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

public VkExportMetalTextureInfoEXT.Buffer
mtlTexture(long value)

Sets the specified value to the VkExportMetalTextureInfoEXT#mtlTexture field.

public int

Returns:

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

public VkExportMetalTextureInfoEXT.Buffer
plane(int value)

Sets the specified value to the VkExportMetalTextureInfoEXT#plane field.

public long

Returns:

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

public VkExportMetalTextureInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkExportMetalTextureInfoEXT#pNext field.

protected VkExportMetalTextureInfoEXT.Buffer
public int

Returns:

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

public VkExportMetalTextureInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkExportMetalTextureInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExportMetalTextureInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

bufferViewback to summary
public long bufferView()
Returns:long

the value of the VkExportMetalTextureInfoEXT#bufferView field.

Annotations
@NativeType:VkBufferView
bufferViewback to summary
public VkExportMetalTextureInfoEXT.Buffer bufferView(long value)

Sets the specified value to the VkExportMetalTextureInfoEXT#bufferView field.

getElementFactoryback to summary
protected VkExportMetalTextureInfoEXT getElementFactory()

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

Annotations
@Override
imageback to summary
public long image()
Returns:long

the value of the VkExportMetalTextureInfoEXT#image field.

Annotations
@NativeType:VkImage
imageback to summary
public VkExportMetalTextureInfoEXT.Buffer image(long value)

Sets the specified value to the VkExportMetalTextureInfoEXT#image field.

imageViewback to summary
public long imageView()
Returns:long

the value of the VkExportMetalTextureInfoEXT#imageView field.

Annotations
@NativeType:VkImageView
imageViewback to summary
public VkExportMetalTextureInfoEXT.Buffer imageView(long value)

Sets the specified value to the VkExportMetalTextureInfoEXT#imageView field.

mtlTextureback to summary
public long mtlTexture()
Returns:long

the value of the VkExportMetalTextureInfoEXT#mtlTexture field.

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

Sets the specified value to the VkExportMetalTextureInfoEXT#mtlTexture field.

planeback to summary
public int plane()
Returns:int

the value of the VkExportMetalTextureInfoEXT#plane field.

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

Sets the specified value to the VkExportMetalTextureInfoEXT#plane field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkExportMetalTextureInfoEXT#pNext field.

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

Sets the specified value to the VkExportMetalTextureInfoEXT#pNext field.

selfback to summary
protected VkExportMetalTextureInfoEXT.Buffer self()

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

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

the value of the VkExportMetalTextureInfoEXT#sType field.

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

Sets the specified value to the VkExportMetalTextureInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_EXPORT_METAL_TEXTURE_INFO_EXT value to the VkExportMetalTextureInfoEXT#sType field.