Package org.lwjgl.vulkan

Class VkSwapchainPresentModesCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSwapchainPresentModesCreateInfoEXT>

org.lwjgl.vulkan.VkSwapchainPresentModesCreateInfoEXT

All Implemented Interfaces:

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

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

All presentation modes usable by the swapchain.

Valid Usage

• Each entry in pPresentModes must be one of the VkPresentModeKHR values returned by vkGetPhysicalDeviceSurfacePresentModesKHR for the surface
• If the presentModeFifoLatestReady feature is not enabled, pPresentModes must not contain PRESENT_MODE_FIFO_LATEST_READY_EXT
• The entries in pPresentModes must be a subset of the present modes returned in VkSurfacePresentModeCompatibilityEXT::pPresentModes, given VkSwapchainCreateInfoKHR::presentMode in VkSurfacePresentModeEXT
• VkSwapchainCreateInfoKHR::presentMode must be included in pPresentModes

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT
• pPresentModes must be a valid pointer to an array of presentModeCount valid VkPresentModeKHR values
• presentModeCount must be greater than 0

Layout

 struct VkSwapchainPresentModesCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     uint32_t presentModeCount();
     VkPresentModeKHR const * pPresentModes();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkSwapchainPresentModesCreateInfoEXT	calloc()	Returns a new VkSwapchainPresentModesCreateInfoEXT instance allocated with memCalloc.
static VkSwapchainPresentModesCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkSwapchainPresentModesCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkSwapchainPresentModesCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentModesCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSwapchainPresentModesCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentModesCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSwapchainPresentModesCreateInfoEXT	create()	Returns a new VkSwapchainPresentModesCreateInfoEXT instance allocated with BufferUtils.
static VkSwapchainPresentModesCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkSwapchainPresentModesCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkSwapchainPresentModesCreateInfoEXT	create(long address)	Returns a new VkSwapchainPresentModesCreateInfoEXT instance for the specified memory address.
static VkSwapchainPresentModesCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkSwapchainPresentModesCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkSwapchainPresentModesCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSwapchainPresentModesCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSwapchainPresentModesCreateInfoEXT	malloc()	Returns a new VkSwapchainPresentModesCreateInfoEXT instance allocated with memAlloc.
static VkSwapchainPresentModesCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkSwapchainPresentModesCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkSwapchainPresentModesCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentModesCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkSwapchainPresentModesCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentModesCreateInfoEXT instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static IntBuffer	npPresentModes(long struct)	Unsafe version of pPresentModes.
static void	npPresentModes(long struct, IntBuffer value)	Unsafe version of pPresentModes.
static int	npresentModeCount(long struct)	Unsafe version of presentModeCount().
static void	npresentModeCount(long struct, int value)	Sets the specified value to the presentModeCount field of the specified struct.
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.
VkSwapchainPresentModesCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
IntBuffer	pPresentModes()	a list of presentation modes with presentModeCount entries
VkSwapchainPresentModesCreateInfoEXT	pPresentModes(IntBuffer value)	Sets the address of the specified IntBuffer to the pPresentModes() field.
int	presentModeCount()	the number of presentation modes provided.
VkSwapchainPresentModesCreateInfoEXT	set(int sType, long pNext, IntBuffer pPresentModes)	Initializes this struct with the specified values.
VkSwapchainPresentModesCreateInfoEXT	set(VkSwapchainPresentModesCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkSwapchainPresentModesCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkSwapchainPresentModesCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

PRESENTMODECOUNT

public static final int PRESENTMODECOUNT

The struct member offsets.

PPRESENTMODES

public static final int PPRESENTMODES

The struct member offsets.

Constructor Details

VkSwapchainPresentModesCreateInfoEXT

public VkSwapchainPresentModesCreateInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

presentModeCount

public int presentModeCount()

the number of presentation modes provided.

pPresentModes

public IntBuffer pPresentModes()

a list of presentation modes with presentModeCount entries

sType

public VkSwapchainPresentModesCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSwapchainPresentModesCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODES_CREATE_INFO_EXT value to the sType() field.

pNext

public VkSwapchainPresentModesCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

pPresentModes

public VkSwapchainPresentModesCreateInfoEXT pPresentModes(IntBuffer value)

Sets the address of the specified IntBuffer to the pPresentModes() field.

set

public VkSwapchainPresentModesCreateInfoEXT set(int sType,
 long pNext,
 IntBuffer pPresentModes)

Initializes this struct with the specified values.

set

public VkSwapchainPresentModesCreateInfoEXT set(VkSwapchainPresentModesCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSwapchainPresentModesCreateInfoEXT malloc()

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

calloc

public static VkSwapchainPresentModesCreateInfoEXT calloc()

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

create

public static VkSwapchainPresentModesCreateInfoEXT create()

Returns a new VkSwapchainPresentModesCreateInfoEXT instance allocated with BufferUtils.

create

public static VkSwapchainPresentModesCreateInfoEXT create(long address)

Returns a new VkSwapchainPresentModesCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkSwapchainPresentModesCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSwapchainPresentModesCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSwapchainPresentModesCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSwapchainPresentModesCreateInfoEXT.Buffer create(int capacity)

Returns a new VkSwapchainPresentModesCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSwapchainPresentModesCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkSwapchainPresentModesCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkSwapchainPresentModesCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npresentModeCount

public static int npresentModeCount(long struct)

Unsafe version of presentModeCount().

npPresentModes

public static IntBuffer npPresentModes(long struct)

Unsafe version of pPresentModes.

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.

npresentModeCount

public static void npresentModeCount(long struct,
 int value)

Sets the specified value to the presentModeCount field of the specified struct.

npPresentModes

public static void npPresentModes(long struct,
 IntBuffer value)

Unsafe version of pPresentModes.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate