Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSwapchainPresentModeInfoEXT

extends Struct<VkSwapchainPresentModeInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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.

Valid Usage
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField 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
PPRESENTMODES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
SWAPCHAINCOUNT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkSwapchainPresentModeInfoEXT(long address, ByteBuffer container)

public
VkSwapchainPresentModeInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSwapchainPresentModeInfoEXT
calloc()

Returns a new VkSwapchainPresentModeInfoEXT instance allocated with memCalloc.

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

Returns a new VkSwapchainPresentModeInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkSwapchainPresentModeInfoEXT
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 VkSwapchainPresentModeInfoEXT
create()

Returns a new VkSwapchainPresentModeInfoEXT instance allocated with BufferUtils.

public static VkSwapchainPresentModeInfoEXT
create(long address)

Returns a new VkSwapchainPresentModeInfoEXT instance for the specified memory address.

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

Returns a new VkSwapchainPresentModeInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkSwapchainPresentModeInfoEXT.Buffer instance at the specified memory.

public static VkSwapchainPresentModeInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSwapchainPresentModeInfoEXT
malloc()

Returns a new VkSwapchainPresentModeInfoEXT instance allocated with memAlloc.

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

Returns a new VkSwapchainPresentModeInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkSwapchainPresentModeInfoEXT instance allocated on the specified MemoryStack.

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

Returns a new VkSwapchainPresentModeInfoEXT.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 IntBuffer
npPresentModes(long struct)

Unsafe version of pPresentModes.

public static void
npPresentModes(long struct, IntBuffer value)

Unsafe version of pPresentModes.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nswapchainCount(long struct)

Unsafe version of swapchainCount.

public static void
nswapchainCount(long struct, int value)

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

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSwapchainPresentModeInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public IntBuffer
pPresentModes()

a list of presentation modes with swapchainCount entries.

public VkSwapchainPresentModeInfoEXT
pPresentModes(IntBuffer value)

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

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

Initializes this struct with the specified values.

public VkSwapchainPresentModeInfoEXT

Returns:

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

Sets the specified value to the sType field.

public VkSwapchainPresentModeInfoEXT
public int
swapchainCount()

the number of swapchains being presented to by this command.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PPRESENTMODESback to summary
public static final int PPRESENTMODES

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.

SWAPCHAINCOUNTback to summary
public static final int SWAPCHAINCOUNT

The struct member offsets.

Constructor Detail

VkSwapchainPresentModeInfoEXTback to summary
protected VkSwapchainPresentModeInfoEXT(long address, ByteBuffer container)
VkSwapchainPresentModeInfoEXTback to summary
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 Detail

callocback to summary
public static VkSwapchainPresentModeInfoEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSwapchainPresentModeInfoEXT calloc(MemoryStack stack)

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

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

createback to summary
protected VkSwapchainPresentModeInfoEXT 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 VkSwapchainPresentModeInfoEXT create()

Returns a new VkSwapchainPresentModeInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkSwapchainPresentModeInfoEXT create(long address)

Returns a new VkSwapchainPresentModeInfoEXT instance for the specified memory address.

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

Returns a new VkSwapchainPresentModeInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSwapchainPresentModeInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSwapchainPresentModeInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSwapchainPresentModeInfoEXT malloc(MemoryStack stack)

Returns a new VkSwapchainPresentModeInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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.

npPresentModesback to summary
public static IntBuffer npPresentModes(long struct)

Unsafe version of pPresentModes.

npPresentModesback to summary
public static void npPresentModes(long struct, IntBuffer value)

Unsafe version of pPresentModes.

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.

nswapchainCountback to summary
public static int nswapchainCount(long struct)

Unsafe version of swapchainCount.

nswapchainCountback to summary
public static void nswapchainCount(long struct, int value)

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

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

pPresentModesback to summary
public IntBuffer pPresentModes()

a list of presentation modes with swapchainCount entries.

Annotations
@NativeType:VkPresentModeKHR const *
pPresentModesback to summary
public VkSwapchainPresentModeInfoEXT pPresentModes(IntBuffer value)

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

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

Initializes this struct with the specified values.

setback to summary
public VkSwapchainPresentModeInfoEXT set(VkSwapchainPresentModeInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkSwapchainPresentModeInfoEXT

the source struct

Returns:VkSwapchainPresentModeInfoEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT value to the sType field.

swapchainCountback to summary
public int swapchainCount()

the number of swapchains being presented to by this command.

Annotations
@NativeType:uint32_t
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkSwapchainPresentModeInfoEXT.Buffer

extends StructBuffer<VkSwapchainPresentModeInfoEXT, VkSwapchainPresentModeInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkSwapchainPresentModeInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkSwapchainPresentModeInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSwapchainPresentModeInfoEXT.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 VkSwapchainPresentModeInfoEXT
public long

Returns:

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

public VkSwapchainPresentModeInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkSwapchainPresentModeInfoEXT#pNext field.

public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the VkSwapchainPresentModeInfoEXT#pPresentModes field.
pPresentModes
()

public VkSwapchainPresentModeInfoEXT.Buffer
pPresentModes(IntBuffer value)

Sets the address of the specified IntBuffer to the VkSwapchainPresentModeInfoEXT#pPresentModes field.

protected VkSwapchainPresentModeInfoEXT.Buffer
public int

Returns:

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

public VkSwapchainPresentModeInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkSwapchainPresentModeInfoEXT#sType field.

public VkSwapchainPresentModeInfoEXT.Buffer
public int
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSwapchainPresentModeInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSwapchainPresentModeInfoEXT.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 VkSwapchainPresentModeInfoEXT#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 VkSwapchainPresentModeInfoEXT getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkSwapchainPresentModeInfoEXT#pNext field.

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

Sets the specified value to the VkSwapchainPresentModeInfoEXT#pNext field.

pPresentModesback to summary
public IntBuffer pPresentModes()
Returns:IntBuffer

a IntBuffer view of the data pointed to by the VkSwapchainPresentModeInfoEXT#pPresentModes field.

Annotations
@NativeType:VkPresentModeKHR const *
pPresentModesback to summary
public VkSwapchainPresentModeInfoEXT.Buffer pPresentModes(IntBuffer value)

Sets the address of the specified IntBuffer to the VkSwapchainPresentModeInfoEXT#pPresentModes field.

selfback to summary
protected VkSwapchainPresentModeInfoEXT.Buffer self()

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

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

the value of the VkSwapchainPresentModeInfoEXT#sType field.

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

Sets the specified value to the VkSwapchainPresentModeInfoEXT#sType field.

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

Sets the STRUCTURE_TYPE_SWAPCHAIN_PRESENT_MODE_INFO_EXT value to the VkSwapchainPresentModeInfoEXT#sType field.

swapchainCountback to summary
public int swapchainCount()
Returns:int

the value of the VkSwapchainPresentModeInfoEXT#swapchainCount field.

Annotations
@NativeType:uint32_t