Package org.lwjgl.vulkan
Class VkSurfaceCapabilities2EXT
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkSurfaceCapabilities2EXT
extends Struct<VkSurfaceCapabilities2EXT>
implements NativeResource
Structure describing capabilities of a surface.
Valid Usage
supportedSurfaceCounters
must not includeSURFACE_COUNTER_VBLANK_BIT_EXT
unless the surface queried is a display surface
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_SURFACE_CAPABILITIES_2_EXT
pNext
must beNULL
See Also
VkExtent2D
, GetPhysicalDeviceSurfaceCapabilities2EXT
Layout
struct VkSurfaceCapabilities2EXT {
VkStructureType sType()
;
void * pNext()
;
uint32_t minImageCount()
;
uint32_t maxImageCount()
;
VkExtent2D
currentExtent()
;
VkExtent2D
minImageExtent()
;
VkExtent2D
maxImageExtent()
;
uint32_t maxImageArrayLayers()
;
VkSurfaceTransformFlagsKHR supportedTransforms()
;
VkSurfaceTransformFlagBitsKHR currentTransform()
;
VkCompositeAlphaFlagsKHR supportedCompositeAlpha()
;
VkImageUsageFlags supportedUsageFlags()
;
VkSurfaceCounterFlagsEXT supportedSurfaceCounters()
;
}
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkSurfaceCapabilities2EXT
(ByteBuffer container) Creates aVkSurfaceCapabilities2EXT
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkSurfaceCapabilities2EXT
calloc()
Returns a newVkSurfaceCapabilities2EXT
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkSurfaceCapabilities2EXT.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkSurfaceCapabilities2EXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSurfaceCapabilities2EXT
calloc
(MemoryStack stack) Returns a newVkSurfaceCapabilities2EXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSurfaceCapabilities2EXT
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VkSurfaceCapabilities2EXT
callocStack
(MemoryStack stack) Deprecated.static VkSurfaceCapabilities2EXT
create()
Returns a newVkSurfaceCapabilities2EXT
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkSurfaceCapabilities2EXT.Buffer
instance allocated withBufferUtils
.static VkSurfaceCapabilities2EXT
create
(long address) Returns a newVkSurfaceCapabilities2EXT
instance for the specified memory address.create
(long address, int capacity) Create aVkSurfaceCapabilities2EXT.Buffer
instance at the specified memory.static VkSurfaceCapabilities2EXT
createSafe
(long address) createSafe
(long address, int capacity) the current width and height of the surface, or the special value(0xFFFFFFFF, 0xFFFFFFFF)
indicating that the surface size will be determined by the extent of a swapchain targeting the surface.int
VkSurfaceTransformFlagBitsKHR
value indicating the surface’s current transform relative to the presentation engine’s natural orientation.static VkSurfaceCapabilities2EXT
malloc()
Returns a newVkSurfaceCapabilities2EXT
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkSurfaceCapabilities2EXT.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkSurfaceCapabilities2EXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkSurfaceCapabilities2EXT
malloc
(MemoryStack stack) Returns a newVkSurfaceCapabilities2EXT
instance allocated on the specifiedMemoryStack
.static VkSurfaceCapabilities2EXT
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkSurfaceCapabilities2EXT
mallocStack
(MemoryStack stack) Deprecated.int
the maximum number of layers presentable images can have for a swapchain created for this device and surface, and will be at least one.int
the maximum number of images the specified device supports for a swapchain created for the surface, and will be either 0, or greater than or equal tominImageCount
.contains the largest valid swapchain extent for the surface on the specified device.int
the minimum number of images the specified device supports for a swapchain created for the surface, and will be at least one.contains the smallest valid swapchain extent for the surface on the specified device.static VkExtent2D
ncurrentExtent
(long struct) Unsafe version ofcurrentExtent()
.static int
ncurrentTransform
(long struct) Unsafe version ofcurrentTransform()
.static int
nmaxImageArrayLayers
(long struct) Unsafe version ofmaxImageArrayLayers()
.static int
nmaxImageCount
(long struct) Unsafe version ofmaxImageCount()
.static VkExtent2D
nmaxImageExtent
(long struct) Unsafe version ofmaxImageExtent()
.static int
nminImageCount
(long struct) Unsafe version ofminImageCount()
.static VkExtent2D
nminImageExtent
(long struct) Unsafe version ofminImageExtent()
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.static int
nsupportedCompositeAlpha
(long struct) Unsafe version ofsupportedCompositeAlpha()
.static int
nsupportedSurfaceCounters
(long struct) Unsafe version ofsupportedSurfaceCounters()
.static int
nsupportedTransforms
(long struct) Unsafe version ofsupportedTransforms()
.static int
nsupportedUsageFlags
(long struct) Unsafe version ofsupportedUsageFlags()
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_SURFACE_CAPABILITIES_2_EXT
value to thesType()
field.int
a bitmask ofVkCompositeAlphaFlagBitsKHR
, representing the alpha compositing modes supported by the presentation engine for the surface on the specified device, and at least one bit will be set.int
a bitmask ofVkSurfaceCounterFlagBitsEXT
indicating the supported surface counter types.int
a bitmask ofVkSurfaceTransformFlagBitsKHR
indicating the presentation transforms supported for the surface on the specified device.int
a bitmask ofVkImageUsageFlagBits
representing the ways the application can use the presentable images of a swapchain created withVkPresentModeKHR
set toPRESENT_MODE_IMMEDIATE_KHR
,PRESENT_MODE_MAILBOX_KHR
,PRESENT_MODE_FIFO_KHR
orPRESENT_MODE_FIFO_RELAXED_KHR
for the surface on the specified device.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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. -
MINIMAGECOUNT
public static final int MINIMAGECOUNTThe struct member offsets. -
MAXIMAGECOUNT
public static final int MAXIMAGECOUNTThe struct member offsets. -
CURRENTEXTENT
public static final int CURRENTEXTENTThe struct member offsets. -
MINIMAGEEXTENT
public static final int MINIMAGEEXTENTThe struct member offsets. -
MAXIMAGEEXTENT
public static final int MAXIMAGEEXTENTThe struct member offsets. -
MAXIMAGEARRAYLAYERS
public static final int MAXIMAGEARRAYLAYERSThe struct member offsets. -
SUPPORTEDTRANSFORMS
public static final int SUPPORTEDTRANSFORMSThe struct member offsets. -
CURRENTTRANSFORM
public static final int CURRENTTRANSFORMThe struct member offsets. -
SUPPORTEDCOMPOSITEALPHA
public static final int SUPPORTEDCOMPOSITEALPHAThe struct member offsets. -
SUPPORTEDUSAGEFLAGS
public static final int SUPPORTEDUSAGEFLAGSThe struct member offsets. -
SUPPORTEDSURFACECOUNTERS
public static final int SUPPORTEDSURFACECOUNTERSThe struct member offsets.
-
-
Constructor Details
-
VkSurfaceCapabilities2EXT
Creates aVkSurfaceCapabilities2EXT
instance at the current position of the specifiedByteBuffer
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()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkSurfaceCapabilities2EXT>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
minImageCount
public int minImageCount()the minimum number of images the specified device supports for a swapchain created for the surface, and will be at least one. -
maxImageCount
public int maxImageCount()the maximum number of images the specified device supports for a swapchain created for the surface, and will be either 0, or greater than or equal tominImageCount
. A value of 0 means that there is no limit on the number of images, though there may be limits related to the total amount of memory used by presentable images. -
currentExtent
the current width and height of the surface, or the special value(0xFFFFFFFF, 0xFFFFFFFF)
indicating that the surface size will be determined by the extent of a swapchain targeting the surface. -
minImageExtent
contains the smallest valid swapchain extent for the surface on the specified device. Thewidth
andheight
of the extent will each be less than or equal to the correspondingwidth
andheight
ofcurrentExtent
, unlesscurrentExtent
has the special value described above. -
maxImageExtent
contains the largest valid swapchain extent for the surface on the specified device. Thewidth
andheight
of the extent will each be greater than or equal to the correspondingwidth
andheight
ofminImageExtent
. Thewidth
andheight
of the extent will each be greater than or equal to the correspondingwidth
andheight
ofcurrentExtent
, unlesscurrentExtent
has the special value described above. -
maxImageArrayLayers
public int maxImageArrayLayers()the maximum number of layers presentable images can have for a swapchain created for this device and surface, and will be at least one. -
supportedTransforms
public int supportedTransforms()a bitmask ofVkSurfaceTransformFlagBitsKHR
indicating the presentation transforms supported for the surface on the specified device. At least one bit will be set. -
currentTransform
public int currentTransform()VkSurfaceTransformFlagBitsKHR
value indicating the surface’s current transform relative to the presentation engine’s natural orientation. -
supportedCompositeAlpha
public int supportedCompositeAlpha()a bitmask ofVkCompositeAlphaFlagBitsKHR
, representing the alpha compositing modes supported by the presentation engine for the surface on the specified device, and at least one bit will be set. Opaque composition can be achieved in any alpha compositing mode by either using an image format that has no alpha component, or by ensuring that all pixels in the presentable images have an alpha value of 1.0. -
supportedUsageFlags
public int supportedUsageFlags()a bitmask ofVkImageUsageFlagBits
representing the ways the application can use the presentable images of a swapchain created withVkPresentModeKHR
set toPRESENT_MODE_IMMEDIATE_KHR
,PRESENT_MODE_MAILBOX_KHR
,PRESENT_MODE_FIFO_KHR
orPRESENT_MODE_FIFO_RELAXED_KHR
for the surface on the specified device.IMAGE_USAGE_COLOR_ATTACHMENT_BIT
must be included in the set. Implementations may support additional usages. -
supportedSurfaceCounters
public int supportedSurfaceCounters()a bitmask ofVkSurfaceCounterFlagBitsEXT
indicating the supported surface counter types. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_SURFACE_CAPABILITIES_2_EXT
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
set
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 newVkSurfaceCapabilities2EXT
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkSurfaceCapabilities2EXT
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkSurfaceCapabilities2EXT
instance allocated withBufferUtils
. -
create
Returns a newVkSurfaceCapabilities2EXT
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkSurfaceCapabilities2EXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkSurfaceCapabilities2EXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkSurfaceCapabilities2EXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkSurfaceCapabilities2EXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkSurfaceCapabilities2EXT.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkSurfaceCapabilities2EXT.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkSurfaceCapabilities2EXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkSurfaceCapabilities2EXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkSurfaceCapabilities2EXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkSurfaceCapabilities2EXT.Buffer
instance allocated on the specifiedMemoryStack
and 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()
. -
nminImageCount
public static int nminImageCount(long struct) Unsafe version ofminImageCount()
. -
nmaxImageCount
public static int nmaxImageCount(long struct) Unsafe version ofmaxImageCount()
. -
ncurrentExtent
Unsafe version ofcurrentExtent()
. -
nminImageExtent
Unsafe version ofminImageExtent()
. -
nmaxImageExtent
Unsafe version ofmaxImageExtent()
. -
nmaxImageArrayLayers
public static int nmaxImageArrayLayers(long struct) Unsafe version ofmaxImageArrayLayers()
. -
nsupportedTransforms
public static int nsupportedTransforms(long struct) Unsafe version ofsupportedTransforms()
. -
ncurrentTransform
public static int ncurrentTransform(long struct) Unsafe version ofcurrentTransform()
. -
nsupportedCompositeAlpha
public static int nsupportedCompositeAlpha(long struct) Unsafe version ofsupportedCompositeAlpha()
. -
nsupportedUsageFlags
public static int nsupportedUsageFlags(long struct) Unsafe version ofsupportedUsageFlags()
. -
nsupportedSurfaceCounters
public static int nsupportedSurfaceCounters(long struct) Unsafe version ofsupportedSurfaceCounters()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
.
-