Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDeviceGroupSwapchainCreateInfoKHR

extends Struct<VkDeviceGroupSwapchainCreateInfoKHR>
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 swapchain object.
Description

If this structure is not present, modes is considered to be DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR.

Valid Usage (Implicit)

Layout


struct VkDeviceGroupSwapchainCreateInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkDeviceGroupPresentModeFlagsKHR modes;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkDeviceGroupSwapchainCreateInfoKHR.Buffer

An array of VkDeviceGroupSwapchainCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MODES

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

public
VkDeviceGroupSwapchainCreateInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDeviceGroupSwapchainCreateInfoKHR
calloc()

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance allocated with memCalloc.

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

Returns a new VkDeviceGroupSwapchainCreateInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDeviceGroupSwapchainCreateInfoKHR
callocStack()

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

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

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

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

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance allocated with BufferUtils.

public static VkDeviceGroupSwapchainCreateInfoKHR
create(long address)

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance for the specified memory address.

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

Returns a new VkDeviceGroupSwapchainCreateInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkDeviceGroupSwapchainCreateInfoKHR.Buffer instance at the specified memory.

public static VkDeviceGroupSwapchainCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkDeviceGroupSwapchainCreateInfoKHR
malloc()

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance allocated with memAlloc.

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

Returns a new VkDeviceGroupSwapchainCreateInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkDeviceGroupSwapchainCreateInfoKHR
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public int
modes()

a bitfield of modes that the swapchain can be used with.

public VkDeviceGroupSwapchainCreateInfoKHR
modes(int value)

Sets the specified value to the modes field.

public static int
nmodes(long struct)

Unsafe version of modes.

public static void
nmodes(long struct, int value)

Unsafe version of modes.

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

NULL or a pointer to a structure extending this structure.

public VkDeviceGroupSwapchainCreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkDeviceGroupSwapchainCreateInfoKHR
set(int sType, long pNext, int modes)

Initializes this struct with the specified values.

public VkDeviceGroupSwapchainCreateInfoKHR

Returns:

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

Sets the specified value to the sType field.

public VkDeviceGroupSwapchainCreateInfoKHR
sType$Default()

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

MODESback to summary
public static final int MODES

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

VkDeviceGroupSwapchainCreateInfoKHRback to summary
protected VkDeviceGroupSwapchainCreateInfoKHR(long address, ByteBuffer container)
VkDeviceGroupSwapchainCreateInfoKHRback to summary
public VkDeviceGroupSwapchainCreateInfoKHR(ByteBuffer container)

Creates a VkDeviceGroupSwapchainCreateInfoKHR 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 VkDeviceGroupSwapchainCreateInfoKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDeviceGroupSwapchainCreateInfoKHR calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkDeviceGroupSwapchainCreateInfoKHR create(long address)

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance for the specified memory address.

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

Returns a new VkDeviceGroupSwapchainCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDeviceGroupSwapchainCreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDeviceGroupSwapchainCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkDeviceGroupSwapchainCreateInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDeviceGroupSwapchainCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
modesback to summary
public int modes()

a bitfield of modes that the swapchain can be used with.

Annotations
@NativeType:VkDeviceGroupPresentModeFlagsKHR
modesback to summary
public VkDeviceGroupSwapchainCreateInfoKHR modes(int value)

Sets the specified value to the modes field.

nmodesback to summary
public static int nmodes(long struct)

Unsafe version of modes.

nmodesback to summary
public static void nmodes(long struct, int value)

Unsafe version of modes.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkDeviceGroupSwapchainCreateInfoKHR set(int sType, long pNext, int modes)

Initializes this struct with the specified values.

setback to summary
public VkDeviceGroupSwapchainCreateInfoKHR set(VkDeviceGroupSwapchainCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkDeviceGroupSwapchainCreateInfoKHR

the source struct

Returns:VkDeviceGroupSwapchainCreateInfoKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDeviceGroupSwapchainCreateInfoKHR.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkDeviceGroupSwapchainCreateInfoKHR
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDeviceGroupSwapchainCreateInfoKHR.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
protected VkDeviceGroupSwapchainCreateInfoKHR
getElementFactory()

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

public int

Returns:

the value of the VkDeviceGroupSwapchainCreateInfoKHR#modes field.
modes()

public VkDeviceGroupSwapchainCreateInfoKHR.Buffer
modes(int value)

Sets the specified value to the VkDeviceGroupSwapchainCreateInfoKHR#modes field.

public long

Returns:

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

public VkDeviceGroupSwapchainCreateInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkDeviceGroupSwapchainCreateInfoKHR#pNext field.

protected VkDeviceGroupSwapchainCreateInfoKHR.Buffer
self()

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

public int

Returns:

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

public VkDeviceGroupSwapchainCreateInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkDeviceGroupSwapchainCreateInfoKHR#sType field.

public VkDeviceGroupSwapchainCreateInfoKHR.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR value to the VkDeviceGroupSwapchainCreateInfoKHR#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDeviceGroupSwapchainCreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkDeviceGroupSwapchainCreateInfoKHR getElementFactory()

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

Annotations
@Override
modesback to summary
public int modes()
Returns:int

the value of the VkDeviceGroupSwapchainCreateInfoKHR#modes field.

Annotations
@NativeType:VkDeviceGroupPresentModeFlagsKHR
modesback to summary
public VkDeviceGroupSwapchainCreateInfoKHR.Buffer modes(int value)

Sets the specified value to the VkDeviceGroupSwapchainCreateInfoKHR#modes field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkDeviceGroupSwapchainCreateInfoKHR#pNext field.

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

Sets the specified value to the VkDeviceGroupSwapchainCreateInfoKHR#pNext field.

selfback to summary
protected VkDeviceGroupSwapchainCreateInfoKHR.Buffer self()

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

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

the value of the VkDeviceGroupSwapchainCreateInfoKHR#sType field.

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

Sets the specified value to the VkDeviceGroupSwapchainCreateInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR value to the VkDeviceGroupSwapchainCreateInfoKHR#sType field.