Package org.lwjgl.vulkan
Class VkSurfaceCapabilities2EXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSurfaceCapabilities2EXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkSurfaceCapabilities2EXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure describing capabilities of a surface.Valid Usage
supportedSurfaceCountersmust not includeSURFACE_COUNTER_VBLANK_BIT_EXTunless the surface queried is a display surface
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_SURFACE_CAPABILITIES_2_EXTpNextmust beNULL
See Also
VkExtent2D,GetPhysicalDeviceSurfaceCapabilities2EXTLayout
struct VkSurfaceCapabilities2EXT { VkStructureTypesType(); void *pNext(); uint32_tminImageCount(); uint32_tmaxImageCount();VkExtent2DcurrentExtent();VkExtent2DminImageExtent();VkExtent2DmaxImageExtent(); uint32_tmaxImageArrayLayers(); VkSurfaceTransformFlagsKHRsupportedTransforms(); VkSurfaceTransformFlagBitsKHRcurrentTransform(); VkCompositeAlphaFlagsKHRsupportedCompositeAlpha(); VkImageUsageFlagssupportedUsageFlags(); VkSurfaceCounterFlagsEXTsupportedSurfaceCounters(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkSurfaceCapabilities2EXT.BufferAn array ofVkSurfaceCapabilities2EXTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intCURRENTEXTENT
CURRENTTRANSFORM
MAXIMAGEARRAYLAYERS
MAXIMAGECOUNT
MAXIMAGEEXTENT
MINIMAGECOUNT
MINIMAGEEXTENT
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
SUPPORTEDCOMPOSITEALPHA
SUPPORTEDSURFACECOUNTERS
SUPPORTEDTRANSFORMS
SUPPORTEDUSAGEFLAGSThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkSurfaceCapabilities2EXT(java.nio.ByteBuffer container)Creates aVkSurfaceCapabilities2EXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkSurfaceCapabilities2EXTcalloc()Returns a newVkSurfaceCapabilities2EXTinstance allocated withmemCalloc.static VkSurfaceCapabilities2EXT.Buffercalloc(int capacity)Returns a newVkSurfaceCapabilities2EXT.Bufferinstance allocated withmemCalloc.static VkSurfaceCapabilities2EXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSurfaceCapabilities2EXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSurfaceCapabilities2EXTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkSurfaceCapabilities2EXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkSurfaceCapabilities2EXTcallocStack()Deprecated.static VkSurfaceCapabilities2EXT.BuffercallocStack(int capacity)Deprecated.static VkSurfaceCapabilities2EXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkSurfaceCapabilities2EXTcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkSurfaceCapabilities2EXTcreate()Returns a newVkSurfaceCapabilities2EXTinstance allocated withBufferUtils.static VkSurfaceCapabilities2EXT.Buffercreate(int capacity)Returns a newVkSurfaceCapabilities2EXT.Bufferinstance allocated withBufferUtils.static VkSurfaceCapabilities2EXTcreate(long address)Returns a newVkSurfaceCapabilities2EXTinstance for the specified memory address.static VkSurfaceCapabilities2EXT.Buffercreate(long address, int capacity)Create aVkSurfaceCapabilities2EXT.Bufferinstance at the specified memory.static VkSurfaceCapabilities2EXTcreateSafe(long address)static VkSurfaceCapabilities2EXT.BuffercreateSafe(long address, int capacity)VkExtent2DcurrentExtent()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.intcurrentTransform()VkSurfaceTransformFlagBitsKHRvalue indicating the surface’s current transform relative to the presentation engine’s natural orientation.static VkSurfaceCapabilities2EXTmalloc()Returns a newVkSurfaceCapabilities2EXTinstance allocated withmemAlloc.static VkSurfaceCapabilities2EXT.Buffermalloc(int capacity)Returns a newVkSurfaceCapabilities2EXT.Bufferinstance allocated withmemAlloc.static VkSurfaceCapabilities2EXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkSurfaceCapabilities2EXT.Bufferinstance allocated on the specifiedMemoryStack.static VkSurfaceCapabilities2EXTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkSurfaceCapabilities2EXTinstance allocated on the specifiedMemoryStack.static VkSurfaceCapabilities2EXTmallocStack()Deprecated.static VkSurfaceCapabilities2EXT.BuffermallocStack(int capacity)Deprecated.static VkSurfaceCapabilities2EXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkSurfaceCapabilities2EXTmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.intmaxImageArrayLayers()the maximum number of layers presentable images can have for a swapchain created for this device and surface, and will be at least one.intmaxImageCount()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.VkExtent2DmaxImageExtent()contains the largest valid swapchain extent for the surface on the specified device.intminImageCount()the minimum number of images the specified device supports for a swapchain created for the surface, and will be at least one.VkExtent2DminImageExtent()contains the smallest valid swapchain extent for the surface on the specified device.static VkExtent2DncurrentExtent(long struct)Unsafe version ofcurrentExtent().static intncurrentTransform(long struct)Unsafe version ofcurrentTransform().static intnmaxImageArrayLayers(long struct)Unsafe version ofmaxImageArrayLayers().static intnmaxImageCount(long struct)Unsafe version ofmaxImageCount().static VkExtent2DnmaxImageExtent(long struct)Unsafe version ofmaxImageExtent().static intnminImageCount(long struct)Unsafe version ofminImageCount().static VkExtent2DnminImageExtent(long struct)Unsafe version ofminImageExtent().static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.static intnsupportedCompositeAlpha(long struct)Unsafe version ofsupportedCompositeAlpha().static intnsupportedSurfaceCounters(long struct)Unsafe version ofsupportedSurfaceCounters().static intnsupportedTransforms(long struct)Unsafe version ofsupportedTransforms().static intnsupportedUsageFlags(long struct)Unsafe version ofsupportedUsageFlags().longpNext()NULLor a pointer to a structure extending this structure.VkSurfaceCapabilities2EXTpNext(long value)Sets the specified value to thepNext()field.VkSurfaceCapabilities2EXTset(int sType, long pNext)Initializes this struct with the specified values.VkSurfaceCapabilities2EXTset(VkSurfaceCapabilities2EXT src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkSurfaceCapabilities2EXTsType(int value)Sets the specified value to thesType()field.VkSurfaceCapabilities2EXTsType$Default()Sets theSTRUCTURE_TYPE_SURFACE_CAPABILITIES_2_EXTvalue to thesType()field.intsupportedCompositeAlpha()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.intsupportedSurfaceCounters()a bitmask ofVkSurfaceCounterFlagBitsEXTindicating the supported surface counter types.intsupportedTransforms()a bitmask ofVkSurfaceTransformFlagBitsKHRindicating the presentation transforms supported for the surface on the specified device.intsupportedUsageFlags()a bitmask ofVkImageUsageFlagBitsrepresenting the ways the application can use the presentable images of a swapchain created withVkPresentModeKHRset toPRESENT_MODE_IMMEDIATE_KHR,PRESENT_MODE_MAILBOX_KHR,PRESENT_MODE_FIFO_KHRorPRESENT_MODE_FIFO_RELAXED_KHRfor the surface on the specified device.
-
-
-
Field Detail
-
SIZEOF
The struct size in bytes.
-
ALIGNOF
The struct alignment in bytes.
-
STYPE, PNEXT, MINIMAGECOUNT, MAXIMAGECOUNT, CURRENTEXTENT, MINIMAGEEXTENT, MAXIMAGEEXTENT, MAXIMAGEARRAYLAYERS, SUPPORTEDTRANSFORMS, CURRENTTRANSFORM, SUPPORTEDCOMPOSITEALPHA, SUPPORTEDUSAGEFLAGS, SUPPORTEDSURFACECOUNTERS
The struct member offsets.
-
-
Constructor Detail
-
VkSurfaceCapabilities2EXT
public VkSurfaceCapabilities2EXT(java.nio.ByteBuffer container)
Creates aVkSurfaceCapabilities2EXTinstance 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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor 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
public VkExtent2D 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
public VkExtent2D minImageExtent()
contains the smallest valid swapchain extent for the surface on the specified device. Thewidthandheightof the extent will each be less than or equal to the correspondingwidthandheightofcurrentExtent, unlesscurrentExtenthas the special value described above.
-
maxImageExtent
public VkExtent2D maxImageExtent()
contains the largest valid swapchain extent for the surface on the specified device. Thewidthandheightof the extent will each be greater than or equal to the correspondingwidthandheightofminImageExtent. Thewidthandheightof the extent will each be greater than or equal to the correspondingwidthandheightofcurrentExtent, unlesscurrentExtenthas 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 ofVkSurfaceTransformFlagBitsKHRindicating the presentation transforms supported for the surface on the specified device. At least one bit will be set.
-
currentTransform
public int currentTransform()
VkSurfaceTransformFlagBitsKHRvalue 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 ofVkImageUsageFlagBitsrepresenting the ways the application can use the presentable images of a swapchain created withVkPresentModeKHRset toPRESENT_MODE_IMMEDIATE_KHR,PRESENT_MODE_MAILBOX_KHR,PRESENT_MODE_FIFO_KHRorPRESENT_MODE_FIFO_RELAXED_KHRfor the surface on the specified device.IMAGE_USAGE_COLOR_ATTACHMENT_BITmust be included in the set. Implementations may support additional usages.
-
supportedSurfaceCounters
public int supportedSurfaceCounters()
a bitmask ofVkSurfaceCounterFlagBitsEXTindicating the supported surface counter types.
-
sType
public VkSurfaceCapabilities2EXT sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkSurfaceCapabilities2EXT sType$Default()
Sets theSTRUCTURE_TYPE_SURFACE_CAPABILITIES_2_EXTvalue to thesType()field.
-
pNext
public VkSurfaceCapabilities2EXT pNext(long value)
Sets the specified value to thepNext()field.
-
set
public VkSurfaceCapabilities2EXT set(int sType, long pNext)
Initializes this struct with the specified values.
-
set
public VkSurfaceCapabilities2EXT set(VkSurfaceCapabilities2EXT src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkSurfaceCapabilities2EXT malloc()
Returns a newVkSurfaceCapabilities2EXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkSurfaceCapabilities2EXT calloc()
Returns a newVkSurfaceCapabilities2EXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkSurfaceCapabilities2EXT create()
Returns a newVkSurfaceCapabilities2EXTinstance allocated withBufferUtils.
-
create
public static VkSurfaceCapabilities2EXT create(long address)
Returns a newVkSurfaceCapabilities2EXTinstance for the specified memory address.
-
createSafe
@Nullable public static VkSurfaceCapabilities2EXT createSafe(long address)
-
malloc
public static VkSurfaceCapabilities2EXT.Buffer malloc(int capacity)
Returns a newVkSurfaceCapabilities2EXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkSurfaceCapabilities2EXT.Buffer calloc(int capacity)
Returns a newVkSurfaceCapabilities2EXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkSurfaceCapabilities2EXT.Buffer create(int capacity)
Returns a newVkSurfaceCapabilities2EXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkSurfaceCapabilities2EXT.Buffer create(long address, int capacity)
Create aVkSurfaceCapabilities2EXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkSurfaceCapabilities2EXT.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkSurfaceCapabilities2EXT mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkSurfaceCapabilities2EXT callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkSurfaceCapabilities2EXT mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkSurfaceCapabilities2EXT callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkSurfaceCapabilities2EXT.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkSurfaceCapabilities2EXT.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkSurfaceCapabilities2EXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkSurfaceCapabilities2EXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkSurfaceCapabilities2EXT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilities2EXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkSurfaceCapabilities2EXT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilities2EXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkSurfaceCapabilities2EXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilities2EXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkSurfaceCapabilities2EXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSurfaceCapabilities2EXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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
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().
-
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.
-
-