Structure describing present mode of a surface.

Description

If the VkSurfacePresentModeEXT structure is included in the pNext chain of VkPhysicalDeviceSurfaceInfo2KHR, the values returned in VkSurfaceCapabilitiesKHR::minImageCount, VkSurfaceCapabilitiesKHR::maxImageCount, VkSurfacePresentScalingCapabilitiesEXT::minScaledImageExtent, and VkSurfacePresentScalingCapabilitiesEXT::maxScaledImageExtent are valid only for the specified presentMode. If presentMode is PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, the per-present mode image counts must both be one. The per-present mode image counts may be less-than or greater-than the image counts returned when VkSurfacePresentModeEXT is not provided.

Note

If VkSwapchainPresentModesCreateInfoEXT is provided to swapchain creation, the requirements for forward progress may be less strict. For example, a FIFO swapchain might only require 2 images to guarantee forward progress, but a MAILBOX one might require 4. Without the per-present image counts, such an implementation would have to return 4 in VkSurfaceCapabilitiesKHR::minImageCount, which pessimizes FIFO. Conversely, an implementation may return a low number for minImageCount, but internally bump the image count when application queries GetSwapchainImagesKHR, which can surprise applications, and is not discoverable until swapchain creation. Using VkSurfacePresentModeEXT and VkSwapchainPresentModesCreateInfoEXT together effectively removes this problem.

VkSwapchainPresentModesCreateInfoEXT is required for the specification to be backwards compatible with applications that do not know about, or make use of this feature.

Valid Usage

presentMode must be a value reported by GetPhysicalDeviceSurfacePresentModesKHR for the specified surface.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_SURFACE_PRESENT_MODE_EXT
presentMode must be a valid VkPresentModeKHR value

Layout


struct VkSurfacePresentModeEXT {
    VkStructureType sType;
    void * pNext;
    VkPresentModeKHR presentMode;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkSurfacePresentModeEXT.Buffer An array of `VkSurfacePresentModeEXT` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	PNEXT The struct member offsets.
public static final int	PRESENTMODE 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkSurfacePresentModeEXT(long address, ByteBuffer container)
public	VkSurfacePresentModeEXT(ByteBuffer container) Creates a `VkSurfacePresentModeEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkSurfacePresentModeEXT	calloc() Returns a new `VkSurfacePresentModeEXT` instance allocated with `memCalloc`.
public static VkSurfacePresentModeEXT.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkSurfacePresentModeEXT.Buffer` instance allocated with `memCalloc`.
public static VkSurfacePresentModeEXT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSurfacePresentModeEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSurfacePresentModeEXT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSurfacePresentModeEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkSurfacePresentModeEXT	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 VkSurfacePresentModeEXT	create() Returns a new `VkSurfacePresentModeEXT` instance allocated with `BufferUtils`.
public static VkSurfacePresentModeEXT	create(long address) Returns a new `VkSurfacePresentModeEXT` instance for the specified memory address.
public static VkSurfacePresentModeEXT.Buffer	create(int the buffer capacity capacity) Returns a new `VkSurfacePresentModeEXT.Buffer` instance allocated with `BufferUtils`.
public static VkSurfacePresentModeEXT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkSurfacePresentModeEXT.Buffer` instance at the specified memory.
public static VkSurfacePresentModeEXT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSurfacePresentModeEXT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSurfacePresentModeEXT	malloc() Returns a new `VkSurfacePresentModeEXT` instance allocated with `memAlloc`.
public static VkSurfacePresentModeEXT.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkSurfacePresentModeEXT.Buffer` instance allocated with `memAlloc`.
public static VkSurfacePresentModeEXT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSurfacePresentModeEXT` instance allocated on the specified `MemoryStack`.
public static VkSurfacePresentModeEXT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSurfacePresentModeEXT.Buffer` instance allocated on the specified `MemoryStack`.
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	npresentMode(long struct) Unsafe version of `presentMode`.
public static void	npresentMode(long struct, int value) Unsafe version of `presentMode`.
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 VkSurfacePresentModeEXT	pNext(long value) Sets the specified value to the `pNext` field.
public int	presentMode() the presentation mode the swapchain will use.
public VkSurfacePresentModeEXT	presentMode(int value) Sets the specified value to the `presentMode` field.
public VkSurfacePresentModeEXT	set(int sType, long pNext, int presentMode) Initializes this struct with the specified values.
public VkSurfacePresentModeEXT	Returns: this struct set(VkSurfacePresentModeEXT 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 VkSurfacePresentModeEXT	sType(int value) Sets the specified value to the `sType` field.
public VkSurfacePresentModeEXT	sType$Default() Sets the `STRUCTURE_TYPE_SURFACE_PRESENT_MODE_EXT` value to the `sType` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

PRESENTMODE	back to summary
public static final int PRESENTMODE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

Constructor Detail

VkSurfacePresentModeEXT	back to summary
protected VkSurfacePresentModeEXT(long address, ByteBuffer container)

VkSurfacePresentModeEXT back to summary

VkSurfacePresentModeEXT	back to summary
public VkSurfacePresentModeEXT(ByteBuffer container) Creates a `VkSurfacePresentModeEXT` 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.

public VkSurfacePresentModeEXT(ByteBuffer container)

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

calloc	back to summary
public static VkSurfacePresentModeEXT calloc() Returns a new `VkSurfacePresentModeEXT` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkSurfacePresentModeEXT.Buffer calloc(int capacity) Returns a new `VkSurfacePresentModeEXT.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkSurfacePresentModeEXT.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkSurfacePresentModeEXT calloc(MemoryStack stack) Returns a new `VkSurfacePresentModeEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkSurfacePresentModeEXT calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkSurfacePresentModeEXT.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkSurfacePresentModeEXT.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

public static VkSurfacePresentModeEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkSurfacePresentModeEXT.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

create back to summary

create	back to summary
protected VkSurfacePresentModeEXT 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

protected VkSurfacePresentModeEXT 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

create	back to summary
public static VkSurfacePresentModeEXT create() Returns a new `VkSurfacePresentModeEXT` instance allocated with `BufferUtils`.

create	back to summary
public static VkSurfacePresentModeEXT create(long address) Returns a new `VkSurfacePresentModeEXT` instance for the specified memory address.

create back to summary

create	back to summary
public static VkSurfacePresentModeEXT.Buffer create(int capacity) Returns a new `VkSurfacePresentModeEXT.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkSurfacePresentModeEXT.Buffer create(int capacity)

Returns a new VkSurfacePresentModeEXT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkSurfacePresentModeEXT.Buffer create(long address, int capacity) Create a `VkSurfacePresentModeEXT.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkSurfacePresentModeEXT.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkSurfacePresentModeEXT createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkSurfacePresentModeEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkSurfacePresentModeEXT.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static VkSurfacePresentModeEXT malloc() Returns a new `VkSurfacePresentModeEXT` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkSurfacePresentModeEXT.Buffer malloc(int capacity) Returns a new `VkSurfacePresentModeEXT.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkSurfacePresentModeEXT.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkSurfacePresentModeEXT malloc(MemoryStack stack) Returns a new `VkSurfacePresentModeEXT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkSurfacePresentModeEXT malloc(MemoryStack stack)

Returns a new VkSurfacePresentModeEXT instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkSurfacePresentModeEXT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkSurfacePresentModeEXT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkSurfacePresentModeEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

npresentMode	back to summary
public static int npresentMode(long struct) Unsafe version of `presentMode`.

npresentMode	back to summary
public static void npresentMode(long struct, int value) Unsafe version of `presentMode`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void *

pNext	back to summary
public VkSurfacePresentModeEXT pNext(long value) Sets the specified value to the `pNext` field.

presentMode	back to summary
public int presentMode() the presentation mode the swapchain will use. Annotations @NativeType:VkPresentModeKHR

presentMode

back to summary

public int presentMode()

the presentation mode the swapchain will use.

Annotations

@NativeType:VkPresentModeKHR

presentMode	back to summary
public VkSurfacePresentModeEXT presentMode(int value) Sets the specified value to the `presentMode` field.

set	back to summary
public VkSurfacePresentModeEXT set(int sType, long pNext, int presentMode) Initializes this struct with the specified values.

set	back to summary
public VkSurfacePresentModeEXT set(VkSurfacePresentModeEXT src) Copies the specified struct data to this struct. Parameters src:VkSurfacePresentModeEXT the source struct Returns:VkSurfacePresentModeEXT this struct

set

back to summary

public VkSurfacePresentModeEXT set(VkSurfacePresentModeEXT src)

Copies the specified struct data to this struct.

Parameters

src:VkSurfacePresentModeEXT: the source struct

Returns:VkSurfacePresentModeEXT

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

sType back to summary

sType	back to summary
public int sType() a `VkStructureType` value identifying this structure. Annotations @NativeType:VkStructureType

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkSurfacePresentModeEXT sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkSurfacePresentModeEXT sType$Default() Sets the `STRUCTURE_TYPE_SURFACE_PRESENT_MODE_EXT` value to the `sType` field.

org.lwjgl.vulkan back to summary

public Class VkSurfacePresentModeEXT.Buffer

Class Inheritance

extends StructBuffer<VkSurfacePresentModeEXT, VkSurfacePresentModeEXT.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkSurfacePresentModeEXT.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkSurfacePresentModeEXT structs.

Field Summary

Modifier and Type	Field and Description
private static final VkSurfacePresentModeEXT	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkSurfacePresentModeEXT.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 Type	Method and Description
protected VkSurfacePresentModeEXT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkSurfacePresentModeEXT#pNext` field. pNext()
public VkSurfacePresentModeEXT.Buffer	pNext(long value) Sets the specified value to the `VkSurfacePresentModeEXT#pNext` field.
public int	Returns: the value of the `VkSurfacePresentModeEXT#presentMode` field. presentMode()
public VkSurfacePresentModeEXT.Buffer	presentMode(int value) Sets the specified value to the `VkSurfacePresentModeEXT#presentMode` field.
protected VkSurfacePresentModeEXT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkSurfacePresentModeEXT#sType` field. sType()
public VkSurfacePresentModeEXT.Buffer	sType(int value) Sets the specified value to the `VkSurfacePresentModeEXT#sType` field.
public VkSurfacePresentModeEXT.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_SURFACE_PRESENT_MODE_EXT` value to the `VkSurfacePresentModeEXT#sType` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkSurfacePresentModeEXT ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkSurfacePresentModeEXT.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 `VkSurfacePresentModeEXT#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkSurfacePresentModeEXT.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 VkSurfacePresentModeEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory	back to summary
protected VkSurfacePresentModeEXT getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected VkSurfacePresentModeEXT getElementFactory()

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

Annotations

@Override

pNext	back to summary
public long pNext() Returns:long the value of the `VkSurfacePresentModeEXT#pNext` field. Annotations @NativeType:void *

pNext	back to summary
public VkSurfacePresentModeEXT.Buffer pNext(long value) Sets the specified value to the `VkSurfacePresentModeEXT#pNext` field.

presentMode	back to summary
public int presentMode() Returns:int the value of the `VkSurfacePresentModeEXT#presentMode` field. Annotations @NativeType:VkPresentModeKHR

presentMode	back to summary
public VkSurfacePresentModeEXT.Buffer presentMode(int value) Sets the specified value to the `VkSurfacePresentModeEXT#presentMode` field.

self

back to summary

protected VkSurfacePresentModeEXT.Buffer self()

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

Annotations

@Override

sType	back to summary
public int sType() Returns:int the value of the `VkSurfacePresentModeEXT#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkSurfacePresentModeEXT.Buffer sType(int value) Sets the specified value to the `VkSurfacePresentModeEXT#sType` field.

sType$Default	back to summary
public VkSurfacePresentModeEXT.Buffer sType$Default() Sets the `STRUCTURE_TYPE_SURFACE_PRESENT_MODE_EXT` value to the `VkSurfacePresentModeEXT#sType` field.