Class VkSurfacePresentModeCompatibilityEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
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 point to a variable set by the application 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)
sTypemust beSTRUCTURE_TYPE_SURFACE_PRESENT_MODE_COMPATIBILITY_EXT- If
presentModeCountis not 0, andpPresentModesis notNULL,pPresentModesmust be a valid pointer to an array ofpresentModeCountVkPresentModeKHRvalues
Layout
struct VkSurfacePresentModeCompatibilityEXT {
VkStructureType sType();
void * pNext();
uint32_t presentModeCount();
VkPresentModeKHR * pPresentModes();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkSurfacePresentModeCompatibilityEXTstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkSurfacePresentModeCompatibilityEXT(ByteBuffer container) Creates aVkSurfacePresentModeCompatibilityEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkSurfacePresentModeCompatibilityEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkSurfacePresentModeCompatibilityEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSurfacePresentModeCompatibilityEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSurfacePresentModeCompatibilityEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkSurfacePresentModeCompatibilityEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkSurfacePresentModeCompatibilityEXT.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkSurfacePresentModeCompatibilityEXTinstance for the specified memory address.create(long address, int capacity) Create aVkSurfacePresentModeCompatibilityEXT.Bufferinstance at the specified memory.static @Nullable VkSurfacePresentModeCompatibilityEXTcreateSafe(long address) static @Nullable VkSurfacePresentModeCompatibilityEXT.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkSurfacePresentModeCompatibilityEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkSurfacePresentModeCompatibilityEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSurfacePresentModeCompatibilityEXT.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkSurfacePresentModeCompatibilityEXTinstance allocated on the specifiedMemoryStack.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable IntBuffernpPresentModes(long struct) Unsafe version ofpPresentModes.static voidnpPresentModes(long struct, @Nullable IntBuffer value) Unsafe version ofpPresentModes.static intnpresentModeCount(long struct) Unsafe version ofpresentModeCount().static voidnpresentModeCount(long struct, int value) Sets the specified value to thepresentModeCountfield of the specifiedstruct.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.@Nullable IntBuffera pointer to an array ofVkPresentModeKHRin which present modes compatible with a given present mode are returned.pPresentModes(@Nullable IntBuffer value) Sets the address of the specifiedIntBufferto thepPresentModes()field.intan integer related to the number of present modes available or queried, as described below.presentModeCount(int value) Sets the specified value to thepresentModeCount()field.Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_SURFACE_PRESENT_MODE_COMPATIBILITY_EXTvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
PRESENTMODECOUNT
public static final int PRESENTMODECOUNTThe struct member offsets. -
PPRESENTMODES
public static final int PPRESENTMODESThe struct member offsets.
-
-
Constructor Details
-
VkSurfacePresentModeCompatibilityEXT
Creates aVkSurfacePresentModeCompatibilityEXTinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkSurfacePresentModeCompatibilityEXT>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
presentModeCount
public int presentModeCount()an integer related to the number of present modes available or queried, as described below. -
pPresentModes
a pointer to an array ofVkPresentModeKHRin which present modes compatible with a given present mode are returned. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_SURFACE_PRESENT_MODE_COMPATIBILITY_EXTvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
presentModeCount
Sets the specified value to thepresentModeCount()field. -
pPresentModes
Sets the address of the specifiedIntBufferto thepPresentModes()field. -
set
public VkSurfacePresentModeCompatibilityEXT set(int sType, long pNext, int presentModeCount, @Nullable IntBuffer pPresentModes) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkSurfacePresentModeCompatibilityEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkSurfacePresentModeCompatibilityEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkSurfacePresentModeCompatibilityEXTinstance allocated withBufferUtils. -
create
Returns a newVkSurfacePresentModeCompatibilityEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSurfacePresentModeCompatibilityEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkSurfacePresentModeCompatibilityEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkSurfacePresentModeCompatibilityEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkSurfacePresentModeCompatibilityEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkSurfacePresentModeCompatibilityEXT.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkSurfacePresentModeCompatibilityEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkSurfacePresentModeCompatibilityEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkSurfacePresentModeCompatibilityEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSurfacePresentModeCompatibilityEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkSurfacePresentModeCompatibilityEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkSurfacePresentModeCompatibilityEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
npresentModeCount
public static int npresentModeCount(long struct) Unsafe version ofpresentModeCount(). -
npPresentModes
Unsafe version ofpPresentModes. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
npresentModeCount
public static void npresentModeCount(long struct, int value) Sets the specified value to thepresentModeCountfield of the specifiedstruct. -
npPresentModes
Unsafe version ofpPresentModes.
-