Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMacOSSurfaceCreateInfoMVK

extends Struct<VkMacOSSurfaceCreateInfoMVK>
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 specifying parameters of a newly created macOS surface object.
Valid Usage
Valid Usage (Implicit)
See Also

CreateMacOSSurfaceMVK

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkMacOSSurfaceCreateInfoMVK.Buffer

An array of VkMacOSSurfaceCreateInfoMVK structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PVIEW

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

public
VkMacOSSurfaceCreateInfoMVK(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkMacOSSurfaceCreateInfoMVK
calloc()

Returns a new VkMacOSSurfaceCreateInfoMVK instance allocated with memCalloc.

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

Returns a new VkMacOSSurfaceCreateInfoMVK.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkMacOSSurfaceCreateInfoMVK
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkMacOSSurfaceCreateInfoMVK
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMacOSSurfaceCreateInfoMVK.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMacOSSurfaceCreateInfoMVK.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkMacOSSurfaceCreateInfoMVK
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 VkMacOSSurfaceCreateInfoMVK
create()

Returns a new VkMacOSSurfaceCreateInfoMVK instance allocated with BufferUtils.

public static VkMacOSSurfaceCreateInfoMVK
create(long address)

Returns a new VkMacOSSurfaceCreateInfoMVK instance for the specified memory address.

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

Returns a new VkMacOSSurfaceCreateInfoMVK.Buffer instance allocated with BufferUtils.

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

Create a VkMacOSSurfaceCreateInfoMVK.Buffer instance at the specified memory.

public static VkMacOSSurfaceCreateInfoMVK
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

reserved for future use.

public VkMacOSSurfaceCreateInfoMVK
flags(int value)

Sets the specified value to the flags field.

public static VkMacOSSurfaceCreateInfoMVK
malloc()

Returns a new VkMacOSSurfaceCreateInfoMVK instance allocated with memAlloc.

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

Returns a new VkMacOSSurfaceCreateInfoMVK.Buffer instance allocated with memAlloc.

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

Returns a new VkMacOSSurfaceCreateInfoMVK instance allocated on the specified MemoryStack.

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

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

public static VkMacOSSurfaceCreateInfoMVK
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkMacOSSurfaceCreateInfoMVK
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMacOSSurfaceCreateInfoMVK.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMacOSSurfaceCreateInfoMVK.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static long
npView(long struct)

Unsafe version of pView.

public static void
npView(long struct, long value)

Unsafe version of pView.

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

Sets the specified value to the pNext field.

public long
pView()

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

public VkMacOSSurfaceCreateInfoMVK
pView(long value)

Sets the specified value to the pView field.

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

Initializes this struct with the specified values.

public VkMacOSSurfaceCreateInfoMVK

Returns:

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

Sets the specified value to the sType field.

public VkMacOSSurfaceCreateInfoMVK
sType$Default()

Sets the STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK value to the sType field.

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.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PVIEWback to summary
public static final int PVIEW

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

VkMacOSSurfaceCreateInfoMVKback to summary
protected VkMacOSSurfaceCreateInfoMVK(long address, ByteBuffer container)
VkMacOSSurfaceCreateInfoMVKback to summary
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 Detail

callocback to summary
public static VkMacOSSurfaceCreateInfoMVK calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMacOSSurfaceCreateInfoMVK calloc(MemoryStack stack)

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

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

callocStackback to summary
public static VkMacOSSurfaceCreateInfoMVK callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMacOSSurfaceCreateInfoMVK callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMacOSSurfaceCreateInfoMVK.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMacOSSurfaceCreateInfoMVK.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkMacOSSurfaceCreateInfoMVK 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 VkMacOSSurfaceCreateInfoMVK create()

Returns a new VkMacOSSurfaceCreateInfoMVK instance allocated with BufferUtils.

createback to summary
public static VkMacOSSurfaceCreateInfoMVK create(long address)

Returns a new VkMacOSSurfaceCreateInfoMVK instance for the specified memory address.

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

Returns a new VkMacOSSurfaceCreateInfoMVK.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMacOSSurfaceCreateInfoMVK.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMacOSSurfaceCreateInfoMVK createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

reserved for future use.

Annotations
@NativeType:VkMacOSSurfaceCreateFlagsMVK
flagsback to summary
public VkMacOSSurfaceCreateInfoMVK flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkMacOSSurfaceCreateInfoMVK malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMacOSSurfaceCreateInfoMVK malloc(MemoryStack stack)

Returns a new VkMacOSSurfaceCreateInfoMVK instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkMacOSSurfaceCreateInfoMVK mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMacOSSurfaceCreateInfoMVK mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMacOSSurfaceCreateInfoMVK.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMacOSSurfaceCreateInfoMVK.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

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.

npViewback to summary
public static long npView(long struct)

Unsafe version of pView.

npViewback to summary
public static void npView(long struct, long value)

Unsafe version of pView.

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

Sets the specified value to the pNext field.

pViewback to summary
public long pView()

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

Annotations
@NativeType:void const *
pViewback to summary
public VkMacOSSurfaceCreateInfoMVK pView(long value)

Sets the specified value to the pView field.

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

Initializes this struct with the specified values.

setback to summary
public VkMacOSSurfaceCreateInfoMVK set(VkMacOSSurfaceCreateInfoMVK src)

Copies the specified struct data to this struct.

Parameters
src:VkMacOSSurfaceCreateInfoMVK

the source struct

Returns:VkMacOSSurfaceCreateInfoMVK

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkMacOSSurfaceCreateInfoMVK.Buffer

extends StructBuffer<VkMacOSSurfaceCreateInfoMVK, VkMacOSSurfaceCreateInfoMVK.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkMacOSSurfaceCreateInfoMVK structs.

Field Summary

Modifier and TypeField and Description
private static final VkMacOSSurfaceCreateInfoMVK
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMacOSSurfaceCreateInfoMVK.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 int

Returns:

the value of the VkMacOSSurfaceCreateInfoMVK#flags field.
flags()

public VkMacOSSurfaceCreateInfoMVK.Buffer
flags(int value)

Sets the specified value to the VkMacOSSurfaceCreateInfoMVK#flags field.

protected VkMacOSSurfaceCreateInfoMVK
getElementFactory()

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

public long

Returns:

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

public VkMacOSSurfaceCreateInfoMVK.Buffer
pNext(long value)

Sets the specified value to the VkMacOSSurfaceCreateInfoMVK#pNext field.

public long

Returns:

the value of the VkMacOSSurfaceCreateInfoMVK#pView field.
pView()

public VkMacOSSurfaceCreateInfoMVK.Buffer
pView(long value)

Sets the specified value to the VkMacOSSurfaceCreateInfoMVK#pView field.

protected VkMacOSSurfaceCreateInfoMVK.Buffer
self()

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

public int

Returns:

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

public VkMacOSSurfaceCreateInfoMVK.Buffer
sType(int value)

Sets the specified value to the VkMacOSSurfaceCreateInfoMVK#sType field.

public VkMacOSSurfaceCreateInfoMVK.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK value to the VkMacOSSurfaceCreateInfoMVK#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMacOSSurfaceCreateInfoMVK ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public int flags()
Returns:int

the value of the VkMacOSSurfaceCreateInfoMVK#flags field.

Annotations
@NativeType:VkMacOSSurfaceCreateFlagsMVK
flagsback to summary
public VkMacOSSurfaceCreateInfoMVK.Buffer flags(int value)

Sets the specified value to the VkMacOSSurfaceCreateInfoMVK#flags field.

getElementFactoryback to summary
protected VkMacOSSurfaceCreateInfoMVK getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkMacOSSurfaceCreateInfoMVK#pNext field.

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

Sets the specified value to the VkMacOSSurfaceCreateInfoMVK#pNext field.

pViewback to summary
public long pView()
Returns:long

the value of the VkMacOSSurfaceCreateInfoMVK#pView field.

Annotations
@NativeType:void const *
pViewback to summary
public VkMacOSSurfaceCreateInfoMVK.Buffer pView(long value)

Sets the specified value to the VkMacOSSurfaceCreateInfoMVK#pView field.

selfback to summary
protected VkMacOSSurfaceCreateInfoMVK.Buffer self()

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

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

the value of the VkMacOSSurfaceCreateInfoMVK#sType field.

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

Sets the specified value to the VkMacOSSurfaceCreateInfoMVK#sType field.

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

Sets the STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK value to the VkMacOSSurfaceCreateInfoMVK#sType field.