Package org.lwjgl.vulkan

Class VkDeviceGroupSwapchainCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceGroupSwapchainCreateInfoKHR>

org.lwjgl.vulkan.VkDeviceGroupSwapchainCreateInfoKHR

All Implemented Interfaces:

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

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

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)

• sType must be STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR
• modes must be a valid combination of VkDeviceGroupPresentModeFlagBitsKHR values
• modes must not be 0

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDeviceGroupSwapchainCreateInfoKHR.Buffer	An array of VkDeviceGroupSwapchainCreateInfoKHR 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	MODES	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
VkDeviceGroupSwapchainCreateInfoKHR(ByteBuffer container)	Creates a VkDeviceGroupSwapchainCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

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

MODES

public static final int MODES

The struct member offsets.

Constructor Details

VkDeviceGroupSwapchainCreateInfoKHR

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkDeviceGroupSwapchainCreateInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

modes

public int modes()

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

sType

public VkDeviceGroupSwapchainCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDeviceGroupSwapchainCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_GROUP_SWAPCHAIN_CREATE_INFO_KHR value to the sType() field.

pNext

public VkDeviceGroupSwapchainCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

modes

public VkDeviceGroupSwapchainCreateInfoKHR modes(int value)

Sets the specified value to the modes() field.

set

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

Initializes this struct with the specified values.

set

public VkDeviceGroupSwapchainCreateInfoKHR set(VkDeviceGroupSwapchainCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDeviceGroupSwapchainCreateInfoKHR malloc()

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

calloc

public static VkDeviceGroupSwapchainCreateInfoKHR calloc()

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

create

public static VkDeviceGroupSwapchainCreateInfoKHR create()

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance allocated with BufferUtils.

create

public static VkDeviceGroupSwapchainCreateInfoKHR create(long address)

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkDeviceGroupSwapchainCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDeviceGroupSwapchainCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDeviceGroupSwapchainCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDeviceGroupSwapchainCreateInfoKHR.Buffer create(int capacity)

Returns a new VkDeviceGroupSwapchainCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDeviceGroupSwapchainCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDeviceGroupSwapchainCreateInfoKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceGroupSwapchainCreateInfoKHR callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Returns a new VkDeviceGroupSwapchainCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmodes

public static int nmodes(long struct)

Unsafe version of modes().

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.

nmodes

public static void nmodes(long struct,
 int value)

Unsafe version of modes.