Package org.lwjgl.vulkan

Class VkMetalSurfaceCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMetalSurfaceCreateInfoEXT>

org.lwjgl.vulkan.VkMetalSurfaceCreateInfoEXT

All Implemented Interfaces:

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

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

Structure specifying parameters of a newly created Metal surface object.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_METAL_SURFACE_CREATE_INFO_EXT
• pNext must be NULL
• flags must be 0

See Also

CreateMetalSurfaceEXT

Layout

 struct VkMetalSurfaceCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkMetalSurfaceCreateFlagsEXT flags();
     CAMetalLayer const * pLayer(int);
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkMetalSurfaceCreateInfoEXT.Buffer	An array of VkMetalSurfaceCreateInfoEXT 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	FLAGS	The struct member offsets.
static final int	PLAYER	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
VkMetalSurfaceCreateInfoEXT(ByteBuffer container)	Creates a VkMetalSurfaceCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkMetalSurfaceCreateInfoEXT	calloc()	Returns a new VkMetalSurfaceCreateInfoEXT instance allocated with memCalloc.
static VkMetalSurfaceCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkMetalSurfaceCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkMetalSurfaceCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMetalSurfaceCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMetalSurfaceCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMetalSurfaceCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMetalSurfaceCreateInfoEXT	callocStack()	Deprecated.
static VkMetalSurfaceCreateInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkMetalSurfaceCreateInfoEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMetalSurfaceCreateInfoEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMetalSurfaceCreateInfoEXT	create()	Returns a new VkMetalSurfaceCreateInfoEXT instance allocated with BufferUtils.
static VkMetalSurfaceCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkMetalSurfaceCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkMetalSurfaceCreateInfoEXT	create(long address)	Returns a new VkMetalSurfaceCreateInfoEXT instance for the specified memory address.
static VkMetalSurfaceCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkMetalSurfaceCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkMetalSurfaceCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkMetalSurfaceCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	reserved for future use.
VkMetalSurfaceCreateInfoEXT	flags(int value)	Sets the specified value to the flags() field.
static VkMetalSurfaceCreateInfoEXT	malloc()	Returns a new VkMetalSurfaceCreateInfoEXT instance allocated with memAlloc.
static VkMetalSurfaceCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkMetalSurfaceCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkMetalSurfaceCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMetalSurfaceCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkMetalSurfaceCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMetalSurfaceCreateInfoEXT instance allocated on the specified MemoryStack.
static VkMetalSurfaceCreateInfoEXT	mallocStack()	Deprecated.
static VkMetalSurfaceCreateInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkMetalSurfaceCreateInfoEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMetalSurfaceCreateInfoEXT	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static @Nullable org.lwjgl.PointerBuffer	npLayer(long struct, int capacity)	Unsafe version of pLayer.
static void	npLayer(long struct, @Nullable org.lwjgl.PointerBuffer value)	Unsafe version of pLayer.
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.
@Nullable org.lwjgl.PointerBuffer	pLayer(int capacity)
VkMetalSurfaceCreateInfoEXT	pLayer(@Nullable org.lwjgl.PointerBuffer value)	Sets the address of the specified PointerBuffer to the pLayer(int) field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkMetalSurfaceCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkMetalSurfaceCreateInfoEXT	set(int sType, long pNext, int flags, @Nullable org.lwjgl.PointerBuffer pLayer)	Initializes this struct with the specified values.
VkMetalSurfaceCreateInfoEXT	set(VkMetalSurfaceCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkMetalSurfaceCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkMetalSurfaceCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_METAL_SURFACE_CREATE_INFO_EXT value to the sType() field.

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.

FLAGS

public static final int FLAGS

The struct member offsets.

PLAYER

public static final int PLAYER

The struct member offsets.

Constructor Details

VkMetalSurfaceCreateInfoEXT

public VkMetalSurfaceCreateInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

reserved for future use.

pLayer

public @Nullable org.lwjgl.PointerBuffer pLayer(int capacity)

Parameters:

capacity - the number of elements in the returned buffer

Returns:

a reference to a CAMetalLayer object representing a renderable surface.

sType

public VkMetalSurfaceCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkMetalSurfaceCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_METAL_SURFACE_CREATE_INFO_EXT value to the sType() field.

pNext

public VkMetalSurfaceCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkMetalSurfaceCreateInfoEXT flags(int value)

Sets the specified value to the flags() field.

pLayer

public VkMetalSurfaceCreateInfoEXT pLayer(@Nullable org.lwjgl.PointerBuffer value)

Sets the address of the specified PointerBuffer to the pLayer(int) field.

set

public VkMetalSurfaceCreateInfoEXT set(int sType,
 long pNext,
 int flags,
 @Nullable org.lwjgl.PointerBuffer pLayer)

Initializes this struct with the specified values.

set

public VkMetalSurfaceCreateInfoEXT set(VkMetalSurfaceCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMetalSurfaceCreateInfoEXT malloc()

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

calloc

public static VkMetalSurfaceCreateInfoEXT calloc()

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

create

public static VkMetalSurfaceCreateInfoEXT create()

Returns a new VkMetalSurfaceCreateInfoEXT instance allocated with BufferUtils.

create

public static VkMetalSurfaceCreateInfoEXT create(long address)

Returns a new VkMetalSurfaceCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkMetalSurfaceCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMetalSurfaceCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkMetalSurfaceCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkMetalSurfaceCreateInfoEXT.Buffer create(int capacity)

Returns a new VkMetalSurfaceCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkMetalSurfaceCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkMetalSurfaceCreateInfoEXT mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkMetalSurfaceCreateInfoEXT callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkMetalSurfaceCreateInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkMetalSurfaceCreateInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkMetalSurfaceCreateInfoEXT.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkMetalSurfaceCreateInfoEXT.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkMetalSurfaceCreateInfoEXT.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkMetalSurfaceCreateInfoEXT.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

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

Returns a new VkMetalSurfaceCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

npLayer

public static @Nullable org.lwjgl.PointerBuffer npLayer(long struct,
 int capacity)

Unsafe version of pLayer.

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

npLayer

public static void npLayer(long struct,
 @Nullable org.lwjgl.PointerBuffer value)

Unsafe version of pLayer.