Package org.lwjgl.vulkan

Class VkImportMetalIOSurfaceInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImportMetalIOSurfaceInfoEXT>

org.lwjgl.vulkan.VkImportMetalIOSurfaceInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkImportMetalIOSurfaceInfoEXT
extends org.lwjgl.system.Struct<VkImportMetalIOSurfaceInfoEXT>
implements org.lwjgl.system.NativeResource

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 application 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)

• sType must be STRUCTURE_TYPE_IMPORT_METAL_IO_SURFACE_INFO_EXT

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImportMetalIOSurfaceInfoEXT.Buffer	An array of VkImportMetalIOSurfaceInfoEXT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	IOSURFACE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkImportMetalIOSurfaceInfoEXT(ByteBuffer container)	Creates a VkImportMetalIOSurfaceInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImportMetalIOSurfaceInfoEXT	calloc()	Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated with memCalloc.
static VkImportMetalIOSurfaceInfoEXT.Buffer	calloc(int capacity)	Returns a new VkImportMetalIOSurfaceInfoEXT.Buffer instance allocated with memCalloc.
static VkImportMetalIOSurfaceInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImportMetalIOSurfaceInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImportMetalIOSurfaceInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImportMetalIOSurfaceInfoEXT	create()	Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated with BufferUtils.
static VkImportMetalIOSurfaceInfoEXT.Buffer	create(int capacity)	Returns a new VkImportMetalIOSurfaceInfoEXT.Buffer instance allocated with BufferUtils.
static VkImportMetalIOSurfaceInfoEXT	create(long address)	Returns a new VkImportMetalIOSurfaceInfoEXT instance for the specified memory address.
static VkImportMetalIOSurfaceInfoEXT.Buffer	create(long address, int capacity)	Create a VkImportMetalIOSurfaceInfoEXT.Buffer instance at the specified memory.
static @Nullable VkImportMetalIOSurfaceInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImportMetalIOSurfaceInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	ioSurface()	NULL_HANDLE or the Metal IOSurfaceRef object that is to underlie the VkImage.
VkImportMetalIOSurfaceInfoEXT	ioSurface(long value)	Sets the specified value to the ioSurface() field.
static VkImportMetalIOSurfaceInfoEXT	malloc()	Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated with memAlloc.
static VkImportMetalIOSurfaceInfoEXT.Buffer	malloc(int capacity)	Returns a new VkImportMetalIOSurfaceInfoEXT.Buffer instance allocated with memAlloc.
static VkImportMetalIOSurfaceInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImportMetalIOSurfaceInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkImportMetalIOSurfaceInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated on the specified MemoryStack.
static long	nioSurface(long struct)	Unsafe version of ioSurface().
static void	nioSurface(long struct, long value)	Unsafe version of ioSurface.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImportMetalIOSurfaceInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkImportMetalIOSurfaceInfoEXT	set(int sType, long pNext, long ioSurface)	Initializes this struct with the specified values.
VkImportMetalIOSurfaceInfoEXT	set(VkImportMetalIOSurfaceInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImportMetalIOSurfaceInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkImportMetalIOSurfaceInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_IMPORT_METAL_IO_SURFACE_INFO_EXT value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

IOSURFACE

public static final int IOSURFACE

The struct member offsets.

Constructor Details

VkImportMetalIOSurfaceInfoEXT

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkImportMetalIOSurfaceInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

ioSurface

public long ioSurface()

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

sType

public VkImportMetalIOSurfaceInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImportMetalIOSurfaceInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_IMPORT_METAL_IO_SURFACE_INFO_EXT value to the sType() field.

pNext

public VkImportMetalIOSurfaceInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

ioSurface

public VkImportMetalIOSurfaceInfoEXT ioSurface(long value)

Sets the specified value to the ioSurface() field.

set

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

Initializes this struct with the specified values.

set

public VkImportMetalIOSurfaceInfoEXT set(VkImportMetalIOSurfaceInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImportMetalIOSurfaceInfoEXT malloc()

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

calloc

public static VkImportMetalIOSurfaceInfoEXT calloc()

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

create

public static VkImportMetalIOSurfaceInfoEXT create()

Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated with BufferUtils.

create

public static VkImportMetalIOSurfaceInfoEXT create(long address)

Returns a new VkImportMetalIOSurfaceInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkImportMetalIOSurfaceInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImportMetalIOSurfaceInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImportMetalIOSurfaceInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImportMetalIOSurfaceInfoEXT.Buffer create(int capacity)

Returns a new VkImportMetalIOSurfaceInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImportMetalIOSurfaceInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkImportMetalIOSurfaceInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImportMetalIOSurfaceInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImportMetalIOSurfaceInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkImportMetalIOSurfaceInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkImportMetalIOSurfaceInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nioSurface

public static long nioSurface(long struct)

Unsafe version of ioSurface().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nioSurface

public static void nioSurface(long struct,
 long value)

Unsafe version of ioSurface.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate