Package org.lwjgl.vulkan

Class VkSwapchainPresentModeInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSwapchainPresentModeInfoEXT>

org.lwjgl.vulkan.VkSwapchainPresentModeInfoEXT

All Implemented Interfaces:

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

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

Presentation modes for a vkQueuePresentKHR operation.

Description

If the pNext chain of VkPresentInfoKHR includes a VkSwapchainPresentModeInfoEXT structure, then that structure defines the presentation modes used for the current and subsequent presentation operations.

When the application changes present modes with VkSwapchainPresentModeInfoEXT, images that have already been queued for presentation will continue to be presented according to the previous present mode. The current image being queued for presentation and subsequent images will be presented according to the new present mode. The behavior during the transition between the two modes is defined as follows.

• Transition from PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR to PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR: the presentation engine updates the shared presentable image according to the behavior of PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR.
• Transition from PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR to PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR: the presentation engine may update the shared presentable image or defer that to its regular refresh cycle, according to the behavior of PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR.
• Transition between PRESENT_MODE_FIFO_KHR and PRESENT_MODE_FIFO_RELAXED_KHR: Images continue to be appended to the same FIFO queue, and the behavior with respect to waiting for vertical blanking period will follow the new mode for current and subsequent images.
• Transition from PRESENT_MODE_IMMEDIATE_KHR to PRESENT_MODE_FIFO_KHR or PRESENT_MODE_FIFO_RELAXED_KHR or PRESENT_MODE_FIFO_LATEST_READY_EXT : As all prior present requests in the PRESENT_MODE_IMMEDIATE_KHR mode are applied immediately, there are no outstanding present operations in this mode, and current and subsequent images are appended to the FIFO queue and presented according to the new mode.
• Transition from PRESENT_MODE_MAILBOX_KHR to PRESENT_MODE_FIFO_KHR or PRESENT_MODE_FIFO_RELAXED_KHR or PRESENT_MODE_FIFO_LATEST_READY_EXT : Presentation in FIFO modes require waiting for the next vertical blanking period, with PRESENT_MODE_MAILBOX_KHR allowing the pending present operation to be replaced by a new one. In this case, the current present operation will replace the pending present operation and is applied according to the new mode.
• Transition from PRESENT_MODE_FIFO_KHR or PRESENT_MODE_FIFO_RELAXED_KHR or PRESENT_MODE_FIFO_LATEST_READY_EXT to PRESENT_MODE_IMMEDIATE_KHR or PRESENT_MODE_MAILBOX_KHR: If the FIFO queue is empty, presentation is done according to the behavior of the new mode. If there are present operations in the FIFO queue, once the last present operation is performed based on the respective vertical blanking period, the current and subsequent updates are applied according to the new mode.
• Transition between PRESENT_MODE_FIFO_KHR or PRESENT_MODE_FIFO_RELAXED_KHR, and PRESENT_MODE_FIFO_LATEST_READY_EXT: Images continue to be appended to the same FIFO queue, and the behavior with respect to waiting for vertical blanking period and dequeuing requests will follow the new mode for current and subsequent images.
• The behavior during transition between any other present modes, if possible, is implementation defined.

Valid Usage

• swapchainCount must be equal to VkPresentInfoKHR::swapchainCount
• Each entry in pPresentModes must be a presentation mode specified in VkSwapchainPresentModesCreateInfoEXT::pPresentModes when creating the entry’s corresponding swapchain

Valid Usage (Implicit)

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

Layout

 struct VkSwapchainPresentModeInfoEXT {
     VkStructureType sType();
     void const * pNext();
     uint32_t swapchainCount();
     VkPresentModeKHR const * pPresentModes();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSwapchainPresentModeInfoEXT.Buffer	An array of VkSwapchainPresentModeInfoEXT 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	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	SWAPCHAINCOUNT	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
VkSwapchainPresentModeInfoEXT(ByteBuffer container)	Creates a VkSwapchainPresentModeInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSwapchainPresentModeInfoEXT	calloc()	Returns a new VkSwapchainPresentModeInfoEXT instance allocated with memCalloc.
static VkSwapchainPresentModeInfoEXT.Buffer	calloc(int capacity)	Returns a new VkSwapchainPresentModeInfoEXT.Buffer instance allocated with memCalloc.
static VkSwapchainPresentModeInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentModeInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSwapchainPresentModeInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentModeInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSwapchainPresentModeInfoEXT	create()	Returns a new VkSwapchainPresentModeInfoEXT instance allocated with BufferUtils.
static VkSwapchainPresentModeInfoEXT.Buffer	create(int capacity)	Returns a new VkSwapchainPresentModeInfoEXT.Buffer instance allocated with BufferUtils.
static VkSwapchainPresentModeInfoEXT	create(long address)	Returns a new VkSwapchainPresentModeInfoEXT instance for the specified memory address.
static VkSwapchainPresentModeInfoEXT.Buffer	create(long address, int capacity)	Create a VkSwapchainPresentModeInfoEXT.Buffer instance at the specified memory.
static @Nullable VkSwapchainPresentModeInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSwapchainPresentModeInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSwapchainPresentModeInfoEXT	malloc()	Returns a new VkSwapchainPresentModeInfoEXT instance allocated with memAlloc.
static VkSwapchainPresentModeInfoEXT.Buffer	malloc(int capacity)	Returns a new VkSwapchainPresentModeInfoEXT.Buffer instance allocated with memAlloc.
static VkSwapchainPresentModeInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentModeInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkSwapchainPresentModeInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSwapchainPresentModeInfoEXT 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	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nswapchainCount(long struct)	Unsafe version of swapchainCount().
static void	nswapchainCount(long struct, int value)	Sets the specified value to the swapchainCount field of the specified struct.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkSwapchainPresentModeInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
IntBuffer	pPresentModes()	a list of presentation modes with swapchainCount entries.
VkSwapchainPresentModeInfoEXT	pPresentModes(IntBuffer value)	Sets the address of the specified IntBuffer to the pPresentModes() field.
VkSwapchainPresentModeInfoEXT	set(int sType, long pNext, IntBuffer pPresentModes)	Initializes this struct with the specified values.
VkSwapchainPresentModeInfoEXT	set(VkSwapchainPresentModeInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkSwapchainPresentModeInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkSwapchainPresentModeInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT value to the sType() field.
int	swapchainCount()	the number of swapchains being presented to by this command.
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.

SWAPCHAINCOUNT

public static final int SWAPCHAINCOUNT

The struct member offsets.

PPRESENTMODES

public static final int PPRESENTMODES

The struct member offsets.

Constructor Details

VkSwapchainPresentModeInfoEXT

public VkSwapchainPresentModeInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

swapchainCount

public int swapchainCount()

the number of swapchains being presented to by this command.

pPresentModes

public IntBuffer pPresentModes()

a list of presentation modes with swapchainCount entries.

sType

public VkSwapchainPresentModeInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSwapchainPresentModeInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT value to the sType() field.

pNext

public VkSwapchainPresentModeInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

pPresentModes

public VkSwapchainPresentModeInfoEXT pPresentModes(IntBuffer value)

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

set

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

Initializes this struct with the specified values.

set

public VkSwapchainPresentModeInfoEXT set(VkSwapchainPresentModeInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSwapchainPresentModeInfoEXT malloc()

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

calloc

public static VkSwapchainPresentModeInfoEXT calloc()

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

create

public static VkSwapchainPresentModeInfoEXT create()

Returns a new VkSwapchainPresentModeInfoEXT instance allocated with BufferUtils.

create

public static VkSwapchainPresentModeInfoEXT create(long address)

Returns a new VkSwapchainPresentModeInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkSwapchainPresentModeInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSwapchainPresentModeInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSwapchainPresentModeInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSwapchainPresentModeInfoEXT.Buffer create(int capacity)

Returns a new VkSwapchainPresentModeInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSwapchainPresentModeInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkSwapchainPresentModeInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nswapchainCount

public static int nswapchainCount(long struct)

Unsafe version of swapchainCount().

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.

nswapchainCount

public static void nswapchainCount(long struct,
 int value)

Sets the specified value to the swapchainCount 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