Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSurfacePresentModeCompatibilityEXT

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

Structure describing the subset of compatible presentation modes for the purposes of switching without swapchain recreation.
Description

If pPresentModes is NULL, then the number of present modes that are compatible with the one specified in VkSurfacePresentModeEXT is returned in presentModeCount. Otherwise, presentModeCount must be set by the user to the number of elements in the pPresentModes array, and on return the variable is overwritten with the number of values actually written to pPresentModes. If the value of presentModeCount is less than the number of compatible present modes that are supported, at most presentModeCount values will be written to pPresentModes. The implementation must include the present mode passed to VkSurfacePresentModeEXT in pPresentModes, unless presentModeCount is zero.

Before creating a swapchain whose present modes can be modified through the use of VkSwapchainPresentModesCreateInfoEXT, obtain the set of present modes compatible with a given initial present mode by including a VkSurfacePresentModeEXT structure in the pNext chain of VkPhysicalDeviceSurfaceInfo2KHR when calling GetPhysicalDeviceSurfaceCapabilities2KHR.

Valid Usage (Implicit)

Layout


struct VkSurfacePresentModeCompatibilityEXT {
    VkStructureType sType;
    void * pNext;
    uint32_t presentModeCount;
    VkPresentModeKHR * 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
PRESENTMODECOUNT

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:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkSurfacePresentModeCompatibilityEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSurfacePresentModeCompatibilityEXT
calloc()

Returns a new VkSurfacePresentModeCompatibilityEXT instance allocated with memCalloc.

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

Returns a new VkSurfacePresentModeCompatibilityEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkSurfacePresentModeCompatibilityEXT instance allocated with BufferUtils.

public static VkSurfacePresentModeCompatibilityEXT
create(long address)

Returns a new VkSurfacePresentModeCompatibilityEXT instance for the specified memory address.

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

Returns a new VkSurfacePresentModeCompatibilityEXT.Buffer instance allocated with BufferUtils.

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

Create a VkSurfacePresentModeCompatibilityEXT.Buffer instance at the specified memory.

public static VkSurfacePresentModeCompatibilityEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSurfacePresentModeCompatibilityEXT
malloc()

Returns a new VkSurfacePresentModeCompatibilityEXT instance allocated with memAlloc.

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

Returns a new VkSurfacePresentModeCompatibilityEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkSurfacePresentModeCompatibilityEXT instance allocated on the specified MemoryStack.

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

Returns a new VkSurfacePresentModeCompatibilityEXT.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
npresentModeCount(long struct)

Unsafe version of presentModeCount.

public static void
npresentModeCount(long struct, int value)

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

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 VkSurfacePresentModeCompatibilityEXT
pNext(long value)

Sets the specified value to the pNext field.

public IntBuffer
pPresentModes()

a pointer to an array of VkPresentModeKHR in which present modes compatible with a given present mode are returned.

public VkSurfacePresentModeCompatibilityEXT
pPresentModes(IntBuffer value)

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

public int
presentModeCount()

an integer related to the number of present modes available or queried, as described below.

public VkSurfacePresentModeCompatibilityEXT
presentModeCount(int value)

Sets the specified value to the presentModeCount field.

public VkSurfacePresentModeCompatibilityEXT
set(int sType, long pNext, int presentModeCount, IntBuffer pPresentModes)

Initializes this struct with the specified values.

public VkSurfacePresentModeCompatibilityEXT

Returns:

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

Sets the specified value to the sType field.

public VkSurfacePresentModeCompatibilityEXT
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.

PRESENTMODECOUNTback to summary
public static final int PRESENTMODECOUNT

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.

Constructor Detail

VkSurfacePresentModeCompatibilityEXTback to summary
protected VkSurfacePresentModeCompatibilityEXT(long address, ByteBuffer container)
VkSurfacePresentModeCompatibilityEXTback to summary
public VkSurfacePresentModeCompatibilityEXT(ByteBuffer container)

Creates a VkSurfacePresentModeCompatibilityEXT 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 VkSurfacePresentModeCompatibilityEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSurfacePresentModeCompatibilityEXT calloc(MemoryStack stack)

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

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

Returns a new VkSurfacePresentModeCompatibilityEXT instance allocated with BufferUtils.

createback to summary
public static VkSurfacePresentModeCompatibilityEXT create(long address)

Returns a new VkSurfacePresentModeCompatibilityEXT instance for the specified memory address.

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

Returns a new VkSurfacePresentModeCompatibilityEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSurfacePresentModeCompatibilityEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSurfacePresentModeCompatibilityEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSurfacePresentModeCompatibilityEXT malloc(MemoryStack stack)

Returns a new VkSurfacePresentModeCompatibilityEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

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

Unsafe version of pPresentModes.

npresentModeCountback to summary
public static int npresentModeCount(long struct)

Unsafe version of presentModeCount.

npresentModeCountback to summary
public static void npresentModeCount(long struct, int value)

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

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

pPresentModesback to summary
public IntBuffer pPresentModes()

a pointer to an array of VkPresentModeKHR in which present modes compatible with a given present mode are returned.

Annotations
@Nullable
@NativeType:VkPresentModeKHR *
pPresentModesback to summary
public VkSurfacePresentModeCompatibilityEXT pPresentModes(IntBuffer value)

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

presentModeCountback to summary
public int presentModeCount()

an integer related to the number of present modes available or queried, as described below.

Annotations
@NativeType:uint32_t
presentModeCountback to summary
public VkSurfacePresentModeCompatibilityEXT presentModeCount(int value)

Sets the specified value to the presentModeCount field.

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

Initializes this struct with the specified values.

setback to summary
public VkSurfacePresentModeCompatibilityEXT set(VkSurfacePresentModeCompatibilityEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkSurfacePresentModeCompatibilityEXT

the source struct

Returns:VkSurfacePresentModeCompatibilityEXT

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SURFACE_PRESENT_MODE_COMPATIBILITY_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSurfacePresentModeCompatibilityEXT.Buffer

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

An array of VkSurfacePresentModeCompatibilityEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkSurfacePresentModeCompatibilityEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public VkSurfacePresentModeCompatibilityEXT.Buffer
pNext(long value)

Sets the specified value to the VkSurfacePresentModeCompatibilityEXT#pNext field.

public IntBuffer

Returns:

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

public VkSurfacePresentModeCompatibilityEXT.Buffer
pPresentModes(IntBuffer value)

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

public int
public VkSurfacePresentModeCompatibilityEXT.Buffer
presentModeCount(int value)

Sets the specified value to the VkSurfacePresentModeCompatibilityEXT#presentModeCount field.

protected VkSurfacePresentModeCompatibilityEXT.Buffer
public int

Returns:

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

public VkSurfacePresentModeCompatibilityEXT.Buffer
sType(int value)

Sets the specified value to the VkSurfacePresentModeCompatibilityEXT#sType field.

public VkSurfacePresentModeCompatibilityEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSurfacePresentModeCompatibilityEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the VkSurfacePresentModeCompatibilityEXT#pNext field.

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

Sets the specified value to the VkSurfacePresentModeCompatibilityEXT#pNext field.

pPresentModesback to summary
public IntBuffer pPresentModes()
Returns:IntBuffer

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

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

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

presentModeCountback to summary
public int presentModeCount()
Returns:int

the value of the VkSurfacePresentModeCompatibilityEXT#presentModeCount field.

Annotations
@NativeType:uint32_t
presentModeCountback to summary
public VkSurfacePresentModeCompatibilityEXT.Buffer presentModeCount(int value)

Sets the specified value to the VkSurfacePresentModeCompatibilityEXT#presentModeCount field.

selfback to summary
protected VkSurfacePresentModeCompatibilityEXT.Buffer self()

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

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

the value of the VkSurfacePresentModeCompatibilityEXT#sType field.

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

Sets the specified value to the VkSurfacePresentModeCompatibilityEXT#sType field.

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

Sets the STRUCTURE_TYPE_SURFACE_PRESENT_MODE_COMPATIBILITY_EXT value to the VkSurfacePresentModeCompatibilityEXT#sType field.