Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkImportMetalIOSurfaceInfoEXT

extends Struct<VkImportMetalIOSurfaceInfoEXT>
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 object and corresponding Metal IOSurfaceRef object to use.
Description

If ioSurface is not NULL_HANDLE, it will be used to underlie the VkImage. If ioSurface is NULL_HANDLE, the implementation will create a new IOSurface to underlie the VkImage.

If provided, the app must ensure that the configuration of the IOSurfaceRef object is compatible with the configuration of the VkImage. Failure to do so results in undefined behavior.

Valid Usage (Implicit)

Layout


struct VkImportMetalIOSurfaceInfoEXT {
    VkStructureType sType;
    void const * pNext;
    IOSurfaceRef ioSurface;
}

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
IOSURFACE

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

public
VkImportMetalIOSurfaceInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkImportMetalIOSurfaceInfoEXT
calloc()

Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated with memCalloc.

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

Returns a new VkImportMetalIOSurfaceInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated with BufferUtils.

public static VkImportMetalIOSurfaceInfoEXT
create(long address)

Returns a new VkImportMetalIOSurfaceInfoEXT instance for the specified memory address.

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

Returns a new VkImportMetalIOSurfaceInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkImportMetalIOSurfaceInfoEXT.Buffer instance at the specified memory.

public static VkImportMetalIOSurfaceInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
ioSurface()

NULL_HANDLE or the Metal IOSurfaceRef object that is to underlie the VkImage.

public VkImportMetalIOSurfaceInfoEXT
ioSurface(long value)

Sets the specified value to the ioSurface field.

public static VkImportMetalIOSurfaceInfoEXT
malloc()

Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated with memAlloc.

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

Returns a new VkImportMetalIOSurfaceInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated on the specified MemoryStack.

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

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

public static long
nioSurface(long struct)

Unsafe version of ioSurface.

public static void
nioSurface(long struct, long value)

Unsafe version of ioSurface.

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

Sets the specified value to the pNext field.

public VkImportMetalIOSurfaceInfoEXT
set(int sType, long pNext, long ioSurface)

Initializes this struct with the specified values.

public VkImportMetalIOSurfaceInfoEXT

Returns:

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

Sets the specified value to the sType field.

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

IOSURFACEback to summary
public static final int IOSURFACE

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

VkImportMetalIOSurfaceInfoEXTback to summary
protected VkImportMetalIOSurfaceInfoEXT(long address, ByteBuffer container)
VkImportMetalIOSurfaceInfoEXTback to summary
public VkImportMetalIOSurfaceInfoEXT(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkImportMetalIOSurfaceInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkImportMetalIOSurfaceInfoEXT create(long address)

Returns a new VkImportMetalIOSurfaceInfoEXT instance for the specified memory address.

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

Returns a new VkImportMetalIOSurfaceInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkImportMetalIOSurfaceInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkImportMetalIOSurfaceInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
ioSurfaceback to summary
public long ioSurface()

NULL_HANDLE or the Metal IOSurfaceRef object that is to underlie the VkImage.

Annotations
@NativeType:IOSurfaceRef
ioSurfaceback to summary
public VkImportMetalIOSurfaceInfoEXT ioSurface(long value)

Sets the specified value to the ioSurface field.

mallocback to summary
public static VkImportMetalIOSurfaceInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkImportMetalIOSurfaceInfoEXT malloc(MemoryStack stack)

Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nioSurfaceback to summary
public static long nioSurface(long struct)

Unsafe version of ioSurface.

nioSurfaceback to summary
public static void nioSurface(long struct, long value)

Unsafe version of ioSurface.

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

Sets the specified value to the pNext field.

setback to summary
public VkImportMetalIOSurfaceInfoEXT set(int sType, long pNext, long ioSurface)

Initializes this struct with the specified values.

setback to summary
public VkImportMetalIOSurfaceInfoEXT set(VkImportMetalIOSurfaceInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkImportMetalIOSurfaceInfoEXT

the source struct

Returns:VkImportMetalIOSurfaceInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_IMPORT_METAL_IO_SURFACE_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 VkImportMetalIOSurfaceInfoEXT.Buffer

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

An array of VkImportMetalIOSurfaceInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkImportMetalIOSurfaceInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkImportMetalIOSurfaceInfoEXT#ioSurface field.
ioSurface
()

public VkImportMetalIOSurfaceInfoEXT.Buffer
ioSurface(long value)

Sets the specified value to the VkImportMetalIOSurfaceInfoEXT#ioSurface field.

public long

Returns:

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

public VkImportMetalIOSurfaceInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkImportMetalIOSurfaceInfoEXT#pNext field.

protected VkImportMetalIOSurfaceInfoEXT.Buffer
public int

Returns:

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

public VkImportMetalIOSurfaceInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkImportMetalIOSurfaceInfoEXT#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkImportMetalIOSurfaceInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
ioSurfaceback to summary
public long ioSurface()
Returns:long

the value of the VkImportMetalIOSurfaceInfoEXT#ioSurface field.

Annotations
@NativeType:IOSurfaceRef
ioSurfaceback to summary
public VkImportMetalIOSurfaceInfoEXT.Buffer ioSurface(long value)

Sets the specified value to the VkImportMetalIOSurfaceInfoEXT#ioSurface field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkImportMetalIOSurfaceInfoEXT#pNext field.

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

Sets the specified value to the VkImportMetalIOSurfaceInfoEXT#pNext field.

selfback to summary
protected VkImportMetalIOSurfaceInfoEXT.Buffer self()

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

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

the value of the VkImportMetalIOSurfaceInfoEXT#sType field.

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

Sets the specified value to the VkImportMetalIOSurfaceInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_IMPORT_METAL_IO_SURFACE_INFO_EXT value to the VkImportMetalIOSurfaceInfoEXT#sType field.