Package org.lwjgl.vulkan

Class VkMacOSSurfaceCreateInfoMVK

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMacOSSurfaceCreateInfoMVK>

org.lwjgl.vulkan.VkMacOSSurfaceCreateInfoMVK

All Implemented Interfaces:

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

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

Structure specifying parameters of a newly created macOS surface object.

Valid Usage

• If pView is a CAMetalLayer object, it must be a valid CAMetalLayer
• If pView is an NSView object, it must be a valid NSView, must be backed by a CALayer object of type CAMetalLayer, and CreateMacOSSurfaceMVK must be called on the main thread

Valid Usage (Implicit)

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

See Also

CreateMacOSSurfaceMVK

Layout

 struct VkMacOSSurfaceCreateInfoMVK {
     VkStructureType sType();
     void const * pNext();
     VkMacOSSurfaceCreateFlagsMVK flags();
     void const * pView();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

PVIEW

public static final int PVIEW

The struct member offsets.

Constructor Details

VkMacOSSurfaceCreateInfoMVK

public VkMacOSSurfaceCreateInfoMVK(ByteBuffer container)

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

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.

pView

public long pView()

a reference to either a CAMetalLayer object or an NSView object.

sType

public VkMacOSSurfaceCreateInfoMVK sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkMacOSSurfaceCreateInfoMVK sType$Default()

Sets the STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK value to the sType() field.

pNext

public VkMacOSSurfaceCreateInfoMVK pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkMacOSSurfaceCreateInfoMVK flags(int value)

Sets the specified value to the flags() field.

pView

public VkMacOSSurfaceCreateInfoMVK pView(long value)

Sets the specified value to the pView() field.

set

public VkMacOSSurfaceCreateInfoMVK set(int sType,
 long pNext,
 int flags,
 long pView)

Initializes this struct with the specified values.

set

public VkMacOSSurfaceCreateInfoMVK set(VkMacOSSurfaceCreateInfoMVK src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMacOSSurfaceCreateInfoMVK malloc()

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

calloc

public static VkMacOSSurfaceCreateInfoMVK calloc()

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

create

public static VkMacOSSurfaceCreateInfoMVK create()

Returns a new VkMacOSSurfaceCreateInfoMVK instance allocated with BufferUtils.

create

public static VkMacOSSurfaceCreateInfoMVK create(long address)

Returns a new VkMacOSSurfaceCreateInfoMVK instance for the specified memory address.

createSafe

public static @Nullable VkMacOSSurfaceCreateInfoMVK createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMacOSSurfaceCreateInfoMVK.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkMacOSSurfaceCreateInfoMVK.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkMacOSSurfaceCreateInfoMVK.Buffer create(int capacity)

Returns a new VkMacOSSurfaceCreateInfoMVK.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkMacOSSurfaceCreateInfoMVK.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkMacOSSurfaceCreateInfoMVK mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkMacOSSurfaceCreateInfoMVK callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkMacOSSurfaceCreateInfoMVK.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 VkMacOSSurfaceCreateInfoMVK.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 VkMacOSSurfaceCreateInfoMVK malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkMacOSSurfaceCreateInfoMVK instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npView

public static long npView(long struct)

Unsafe version of pView().

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.

npView

public static void npView(long struct,
 long value)

Unsafe version of pView.