Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMetalSurfaceCreateInfoEXT

extends Struct<VkMetalSurfaceCreateInfoEXT>
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 Metal surface object.
Valid Usage (Implicit)
See Also

CreateMetalSurfaceEXT

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkMetalSurfaceCreateInfoEXT.Buffer

An array of VkMetalSurfaceCreateInfoEXT 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
PLAYER

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

public
VkMetalSurfaceCreateInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkMetalSurfaceCreateInfoEXT
calloc()

Returns a new VkMetalSurfaceCreateInfoEXT instance allocated with memCalloc.

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

Returns a new VkMetalSurfaceCreateInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkMetalSurfaceCreateInfoEXT
callocStack()

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

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

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

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

Returns a new VkMetalSurfaceCreateInfoEXT instance allocated with BufferUtils.

public static VkMetalSurfaceCreateInfoEXT
create(long address)

Returns a new VkMetalSurfaceCreateInfoEXT instance for the specified memory address.

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

Returns a new VkMetalSurfaceCreateInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkMetalSurfaceCreateInfoEXT.Buffer instance at the specified memory.

public static VkMetalSurfaceCreateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

reserved for future use.

public VkMetalSurfaceCreateInfoEXT
flags(int value)

Sets the specified value to the flags field.

public static VkMetalSurfaceCreateInfoEXT
malloc()

Returns a new VkMetalSurfaceCreateInfoEXT instance allocated with memAlloc.

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

Returns a new VkMetalSurfaceCreateInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkMetalSurfaceCreateInfoEXT instance allocated on the specified MemoryStack.

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

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

public static VkMetalSurfaceCreateInfoEXT
mallocStack()

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static VkMetalSurfaceCreateInfoEXT.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 PointerBuffer
npLayer(long struct, int capacity)

Unsafe version of pLayer.

public static void
npLayer(long struct, PointerBuffer value)

Unsafe version of pLayer.

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 PointerBuffer

Returns:

a reference to a CAMetalLayer object representing a renderable surface.
pLayer(int
the number of elements in the returned buffer
capacity)

public VkMetalSurfaceCreateInfoEXT
pLayer(PointerBuffer value)

Sets the address of the specified PointerBuffer to the pLayer field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkMetalSurfaceCreateInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkMetalSurfaceCreateInfoEXT
set(int sType, long pNext, int flags, PointerBuffer pLayer)

Initializes this struct with the specified values.

public VkMetalSurfaceCreateInfoEXT

Returns:

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

Sets the specified value to the sType field.

public VkMetalSurfaceCreateInfoEXT
sType$Default()

Sets the STRUCTURE_TYPE_METAL_SURFACE_CREATE_INFO_EXT 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.

PLAYERback to summary
public static final int PLAYER

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

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

callocback to summary
public static VkMetalSurfaceCreateInfoEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMetalSurfaceCreateInfoEXT calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMetalSurfaceCreateInfoEXT.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 VkMetalSurfaceCreateInfoEXT 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 VkMetalSurfaceCreateInfoEXT create()

Returns a new VkMetalSurfaceCreateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkMetalSurfaceCreateInfoEXT create(long address)

Returns a new VkMetalSurfaceCreateInfoEXT instance for the specified memory address.

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

Returns a new VkMetalSurfaceCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMetalSurfaceCreateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMetalSurfaceCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkMetalSurfaceCreateInfoEXT.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:VkMetalSurfaceCreateFlagsEXT
flagsback to summary
public VkMetalSurfaceCreateInfoEXT flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkMetalSurfaceCreateInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMetalSurfaceCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkMetalSurfaceCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMetalSurfaceCreateInfoEXT.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.

npLayerback to summary
public static PointerBuffer npLayer(long struct, int capacity)

Unsafe version of pLayer.

Annotations
@Nullable
npLayerback to summary
public static void npLayer(long struct, PointerBuffer value)

Unsafe version of pLayer.

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.

pLayerback to summary
public PointerBuffer pLayer(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:PointerBuffer

a reference to a CAMetalLayer object representing a renderable surface.

Annotations
@Nullable
@NativeType:CAMetalLayer const *
pLayerback to summary
public VkMetalSurfaceCreateInfoEXT pLayer(PointerBuffer value)

Sets the address of the specified PointerBuffer to the pLayer field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkMetalSurfaceCreateInfoEXT set(int sType, long pNext, int flags, PointerBuffer pLayer)

Initializes this struct with the specified values.

setback to summary
public VkMetalSurfaceCreateInfoEXT set(VkMetalSurfaceCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkMetalSurfaceCreateInfoEXT

the source struct

Returns:VkMetalSurfaceCreateInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_METAL_SURFACE_CREATE_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkMetalSurfaceCreateInfoEXT.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkMetalSurfaceCreateInfoEXT
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMetalSurfaceCreateInfoEXT.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 VkMetalSurfaceCreateInfoEXT#flags field.
flags()

public VkMetalSurfaceCreateInfoEXT.Buffer
flags(int value)

Sets the specified value to the VkMetalSurfaceCreateInfoEXT#flags field.

protected VkMetalSurfaceCreateInfoEXT
getElementFactory()

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

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the VkMetalSurfaceCreateInfoEXT#pLayer field.
pLayer(int
the number of elements in the returned buffer
capacity)

public VkMetalSurfaceCreateInfoEXT.Buffer
pLayer(PointerBuffer value)

Sets the address of the specified PointerBuffer to the VkMetalSurfaceCreateInfoEXT#pLayer field.

public long

Returns:

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

public VkMetalSurfaceCreateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkMetalSurfaceCreateInfoEXT#pNext field.

protected VkMetalSurfaceCreateInfoEXT.Buffer
self()

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

public int

Returns:

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

public VkMetalSurfaceCreateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkMetalSurfaceCreateInfoEXT#sType field.

public VkMetalSurfaceCreateInfoEXT.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_METAL_SURFACE_CREATE_INFO_EXT value to the VkMetalSurfaceCreateInfoEXT#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMetalSurfaceCreateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkMetalSurfaceCreateInfoEXT.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 VkMetalSurfaceCreateInfoEXT#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 VkMetalSurfaceCreateInfoEXT#flags field.

Annotations
@NativeType:VkMetalSurfaceCreateFlagsEXT
flagsback to summary
public VkMetalSurfaceCreateInfoEXT.Buffer flags(int value)

Sets the specified value to the VkMetalSurfaceCreateInfoEXT#flags field.

getElementFactoryback to summary
protected VkMetalSurfaceCreateInfoEXT getElementFactory()

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

Annotations
@Override
pLayerback to summary
public PointerBuffer pLayer(int capacity)
Parameters
capacity:int

the number of elements in the returned buffer

Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the VkMetalSurfaceCreateInfoEXT#pLayer field.

Annotations
@Nullable
@NativeType:CAMetalLayer const *
pLayerback to summary
public VkMetalSurfaceCreateInfoEXT.Buffer pLayer(PointerBuffer value)

Sets the address of the specified PointerBuffer to the VkMetalSurfaceCreateInfoEXT#pLayer field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkMetalSurfaceCreateInfoEXT#pNext field.

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

Sets the specified value to the VkMetalSurfaceCreateInfoEXT#pNext field.

selfback to summary
protected VkMetalSurfaceCreateInfoEXT.Buffer self()

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

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

the value of the VkMetalSurfaceCreateInfoEXT#sType field.

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

Sets the specified value to the VkMetalSurfaceCreateInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_METAL_SURFACE_CREATE_INFO_EXT value to the VkMetalSurfaceCreateInfoEXT#sType field.