Package org.lwjgl.vulkan
Class VkSurfaceCapabilitiesKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSurfaceCapabilitiesKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkSurfaceCapabilitiesKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure describing capabilities of a surface.Description
Note
Supported usage flags of a presentable image when using
PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR
orPRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR
presentation mode are provided byVkSharedPresentSurfaceCapabilitiesKHR
::sharedPresentSupportedUsageFlags
.Note
Formulas such as
min(N, maxImageCount)
are not correct, sincemaxImageCount
may be zero.See Also
VkExtent2D
,VkSurfaceCapabilities2KHR
,GetPhysicalDeviceSurfaceCapabilitiesKHR
Member documentation
minImageCount
– the minimum number of images the specified device supports for a swapchain created for the surface, and will be at least one.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
– 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
– a bitmask ofVkSurfaceTransformFlagBitsKHR
indicating the presentation transforms supported for the surface on the specified device. At least one bit will be set.currentTransform
–VkSurfaceTransformFlagBitsKHR
value indicating the surface’s current transform relative to the presentation engine’s natural orientation.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
– 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 but implementations may support additional usages.
Layout
struct VkSurfaceCapabilitiesKHR { uint32_t minImageCount; uint32_t maxImageCount;
VkExtent2D
currentExtent;VkExtent2D
minImageExtent;VkExtent2D
maxImageExtent; uint32_t maxImageArrayLayers; VkSurfaceTransformFlagsKHR supportedTransforms; VkSurfaceTransformFlagBitsKHR currentTransform; VkCompositeAlphaFlagsKHR supportedCompositeAlpha; VkImageUsageFlags supportedUsageFlags; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkSurfaceCapabilitiesKHR.Buffer
An array ofVkSurfaceCapabilitiesKHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
CURRENTEXTENT
CURRENTTRANSFORM
MAXIMAGEARRAYLAYERS
MAXIMAGECOUNT
MAXIMAGEEXTENT
MINIMAGECOUNT
MINIMAGEEXTENTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
SUPPORTEDCOMPOSITEALPHA
SUPPORTEDTRANSFORMS
SUPPORTEDUSAGEFLAGSThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkSurfaceCapabilitiesKHR(java.nio.ByteBuffer container)
Creates aVkSurfaceCapabilitiesKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkSurfaceCapabilitiesKHR
calloc()
Returns a newVkSurfaceCapabilitiesKHR
instance allocated withmemCalloc
.static VkSurfaceCapabilitiesKHR.Buffer
calloc(int capacity)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated withmemCalloc
.static VkSurfaceCapabilitiesKHR
callocStack()
Returns a newVkSurfaceCapabilitiesKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSurfaceCapabilitiesKHR.Buffer
callocStack(int capacity)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSurfaceCapabilitiesKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSurfaceCapabilitiesKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilitiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSurfaceCapabilitiesKHR
create()
Returns a newVkSurfaceCapabilitiesKHR
instance allocated withBufferUtils
.static VkSurfaceCapabilitiesKHR.Buffer
create(int capacity)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated withBufferUtils
.static VkSurfaceCapabilitiesKHR
create(long address)
Returns a newVkSurfaceCapabilitiesKHR
instance for the specified memory address.static VkSurfaceCapabilitiesKHR.Buffer
create(long address, int capacity)
Create aVkSurfaceCapabilitiesKHR.Buffer
instance at the specified memory.static VkSurfaceCapabilitiesKHR
createSafe(long address)
static VkSurfaceCapabilitiesKHR.Buffer
createSafe(long address, int capacity)
VkExtent2D
currentExtent()
Returns aVkExtent2D
view of thecurrentExtent
field.int
currentTransform()
Returns the value of thecurrentTransform
field.static VkSurfaceCapabilitiesKHR
malloc()
Returns a newVkSurfaceCapabilitiesKHR
instance allocated withmemAlloc
.static VkSurfaceCapabilitiesKHR.Buffer
malloc(int capacity)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated withmemAlloc
.static VkSurfaceCapabilitiesKHR
mallocStack()
Returns a newVkSurfaceCapabilitiesKHR
instance allocated on the thread-localMemoryStack
.static VkSurfaceCapabilitiesKHR.Buffer
mallocStack(int capacity)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkSurfaceCapabilitiesKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkSurfaceCapabilitiesKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilitiesKHR
instance allocated on the specifiedMemoryStack
.int
maxImageArrayLayers()
Returns the value of themaxImageArrayLayers
field.int
maxImageCount()
Returns the value of themaxImageCount
field.VkExtent2D
maxImageExtent()
Returns aVkExtent2D
view of themaxImageExtent
field.int
minImageCount()
Returns the value of theminImageCount
field.VkExtent2D
minImageExtent()
Returns aVkExtent2D
view of theminImageExtent
field.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 int
nsupportedCompositeAlpha(long struct)
Unsafe version ofsupportedCompositeAlpha()
.static int
nsupportedTransforms(long struct)
Unsafe version ofsupportedTransforms()
.static int
nsupportedUsageFlags(long struct)
Unsafe version ofsupportedUsageFlags()
.int
sizeof()
int
supportedCompositeAlpha()
Returns the value of thesupportedCompositeAlpha
field.int
supportedTransforms()
Returns the value of thesupportedTransforms
field.int
supportedUsageFlags()
Returns the value of thesupportedUsageFlags
field.
-
-
-
Constructor Detail
-
VkSurfaceCapabilitiesKHR
public VkSurfaceCapabilitiesKHR(java.nio.ByteBuffer container)
Creates aVkSurfaceCapabilitiesKHR
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
minImageCount
public int minImageCount()
Returns the value of theminImageCount
field.
-
maxImageCount
public int maxImageCount()
Returns the value of themaxImageCount
field.
-
currentExtent
public VkExtent2D currentExtent()
Returns aVkExtent2D
view of thecurrentExtent
field.
-
minImageExtent
public VkExtent2D minImageExtent()
Returns aVkExtent2D
view of theminImageExtent
field.
-
maxImageExtent
public VkExtent2D maxImageExtent()
Returns aVkExtent2D
view of themaxImageExtent
field.
-
maxImageArrayLayers
public int maxImageArrayLayers()
Returns the value of themaxImageArrayLayers
field.
-
supportedTransforms
public int supportedTransforms()
Returns the value of thesupportedTransforms
field.
-
currentTransform
public int currentTransform()
Returns the value of thecurrentTransform
field.
-
supportedCompositeAlpha
public int supportedCompositeAlpha()
Returns the value of thesupportedCompositeAlpha
field.
-
supportedUsageFlags
public int supportedUsageFlags()
Returns the value of thesupportedUsageFlags
field.
-
malloc
public static VkSurfaceCapabilitiesKHR malloc()
Returns a newVkSurfaceCapabilitiesKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkSurfaceCapabilitiesKHR calloc()
Returns a newVkSurfaceCapabilitiesKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkSurfaceCapabilitiesKHR create()
Returns a newVkSurfaceCapabilitiesKHR
instance allocated withBufferUtils
.
-
create
public static VkSurfaceCapabilitiesKHR create(long address)
Returns a newVkSurfaceCapabilitiesKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkSurfaceCapabilitiesKHR createSafe(long address)
-
malloc
public static VkSurfaceCapabilitiesKHR.Buffer malloc(int capacity)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkSurfaceCapabilitiesKHR.Buffer calloc(int capacity)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSurfaceCapabilitiesKHR.Buffer create(int capacity)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSurfaceCapabilitiesKHR.Buffer create(long address, int capacity)
Create aVkSurfaceCapabilitiesKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkSurfaceCapabilitiesKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkSurfaceCapabilitiesKHR mallocStack()
Returns a newVkSurfaceCapabilitiesKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkSurfaceCapabilitiesKHR callocStack()
Returns a newVkSurfaceCapabilitiesKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkSurfaceCapabilitiesKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilitiesKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSurfaceCapabilitiesKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilitiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkSurfaceCapabilitiesKHR.Buffer mallocStack(int capacity)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkSurfaceCapabilitiesKHR.Buffer callocStack(int capacity)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkSurfaceCapabilitiesKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkSurfaceCapabilitiesKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilitiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nminImageCount
public static int nminImageCount(long struct)
Unsafe version ofminImageCount()
.
-
nmaxImageCount
public static int nmaxImageCount(long struct)
Unsafe version ofmaxImageCount()
.
-
ncurrentExtent
public static VkExtent2D ncurrentExtent(long struct)
Unsafe version ofcurrentExtent()
.
-
nminImageExtent
public static VkExtent2D nminImageExtent(long struct)
Unsafe version ofminImageExtent()
.
-
nmaxImageExtent
public static VkExtent2D nmaxImageExtent(long struct)
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()
.
-
-