Safe Haskell	None
Language	Haskell2010

Graphics.Vulkan.Extensions.VK_KHR_get_surface_capabilities2

Synopsis

pattern VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR :: VkStructureType
pattern VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR :: VkStructureType
pattern VK_STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR :: VkStructureType
pattern VK_KHR_GET_SURFACE_CAPABILITIES_2_SPEC_VERSION :: Integral a => a
pattern VK_KHR_GET_SURFACE_CAPABILITIES_2_EXTENSION_NAME :: (Eq a, IsString a) => a
vkGetPhysicalDeviceSurfaceCapabilities2KHR :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pSurfaceInfo" ::: Ptr VkPhysicalDeviceSurfaceInfo2KHR) -> ("pSurfaceCapabilities" ::: Ptr VkSurfaceCapabilities2KHR) -> IO VkResult
vkGetPhysicalDeviceSurfaceFormats2KHR :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pSurfaceInfo" ::: Ptr VkPhysicalDeviceSurfaceInfo2KHR) -> ("pSurfaceFormatCount" ::: Ptr Word32) -> ("pSurfaceFormats" ::: Ptr VkSurfaceFormat2KHR) -> IO VkResult
data VkPhysicalDeviceSurfaceInfo2KHR = VkPhysicalDeviceSurfaceInfo2KHR {
- vkSType :: VkStructureType
- vkPNext :: Ptr ()
- vkSurface :: VkSurfaceKHR
}
data VkSurfaceCapabilities2KHR = VkSurfaceCapabilities2KHR {
- vkSType :: VkStructureType
- vkPNext :: Ptr ()
- vkSurfaceCapabilities :: VkSurfaceCapabilitiesKHR
}
data VkSurfaceFormat2KHR = VkSurfaceFormat2KHR {
- vkSType :: VkStructureType
- vkPNext :: Ptr ()
- vkSurfaceFormat :: VkSurfaceFormatKHR
}

Documentation

pattern VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR :: VkStructureType Source #

pattern VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_KHR :: VkStructureType Source #

pattern VK_STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR :: VkStructureType Source #

pattern VK_KHR_GET_SURFACE_CAPABILITIES_2_SPEC_VERSION :: Integral a => a Source #

pattern VK_KHR_GET_SURFACE_CAPABILITIES_2_EXTENSION_NAME :: (Eq a, IsString a) => a Source #

vkGetPhysicalDeviceSurfaceCapabilities2KHR :: ("physicalDevice" ::: VkPhysicalDevice) -> ("pSurfaceInfo" ::: Ptr VkPhysicalDeviceSurfaceInfo2KHR) -> ("pSurfaceCapabilities" ::: Ptr VkSurfaceCapabilities2KHR) -> IO VkResult Source #

vkGetPhysicalDeviceSurfaceCapabilities2KHR - Reports capabilities of a surface on a physical device

Parameters

physicalDevice is the physical device that will be associated with the swapchain to be created, as described for vkCreateSwapchainKHR.

pSurfaceInfo points to an instance of the VkPhysicalDeviceSurfaceInfo2KHR structure, describing the surface and other fixed parameters that would be consumed by vkCreateSwapchainKHR.
pSurfaceCapabilities points to an instance of the VkSurfaceCapabilities2KHR structure in which the capabilities are returned.

Description

vkGetPhysicalDeviceSurfaceCapabilities2KHR behaves similarly to vkGetPhysicalDeviceSurfaceCapabilitiesKHR, with the ability to specify extended inputs via chained input structures, and to return extended information via chained output structures.

Valid Usage (Implicit)

physicalDevice must be a valid VkPhysicalDevice handle

pSurfaceInfo must be a valid pointer to a valid VkPhysicalDeviceSurfaceInfo2KHR structure
pSurfaceCapabilities must be a valid pointer to a VkSurfaceCapabilities2KHR structure

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_SURFACE_LOST_KHR
```

Parameters

physicalDevice is the physical device that will be associated with the swapchain to be created, as described for vkCreateSwapchainKHR.

pSurfaceInfo points to an instance of the VkPhysicalDeviceSurfaceInfo2KHR structure, describing the surface and other fixed parameters that would be consumed by vkCreateSwapchainKHR.
pSurfaceFormatCount is a pointer to an integer related to the number of format tuples available or queried, as described below.
pSurfaceFormats is either NULL or a pointer to an array of VkSurfaceFormat2KHR structures.

Description

If pSurfaceFormats is NULL, then the number of format tuples supported for the given surface is returned in pSurfaceFormatCount. The number of format tuples supported will be greater than or equal to 1. Otherwise, pSurfaceFormatCount must point to a variable set by the user to the number of elements in the pSurfaceFormats array, and on return the variable is overwritten with the number of structures actually written to pSurfaceFormats. If the value of pSurfaceFormatCount is less than the number of format tuples supported, at most pSurfaceFormatCount structures will be written. If pSurfaceFormatCount is smaller than the number of format tuples supported for the surface parameters described in pSurfaceInfo, VK_INCOMPLETE will be returned instead of VK_SUCCESS to indicate that not all the available values were returned.

Valid Usage (Implicit)

physicalDevice must be a valid VkPhysicalDevice handle

pSurfaceInfo must be a valid pointer to a valid VkPhysicalDeviceSurfaceInfo2KHR structure
pSurfaceFormatCount must be a valid pointer to a uint32_t value
If the value referenced by pSurfaceFormatCount is not 0, and pSurfaceFormats is not NULL, pSurfaceFormats must be a valid pointer to an array of pSurfaceFormatCount VkSurfaceFormat2KHR structures

Return Codes

[Success] - VK_SUCCESS

```
VK_INCOMPLETE
```

[Failure] - VK_ERROR_OUT_OF_HOST_MEMORY

```
VK_ERROR_OUT_OF_DEVICE_MEMORY
```
```
VK_ERROR_SURFACE_LOST_KHR
```

Description

The members of VkPhysicalDeviceSurfaceInfo2KHR correspond to the arguments to vkGetPhysicalDeviceSurfaceCapabilitiesKHR, with sType and pNext added for extensibility.

Valid Usage (Implicit)

sType must be VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SURFACE_INFO_2_KHR

pNext must be NULL
surface must be a valid VkSurfaceKHR handle

Eq VkPhysicalDeviceSurfaceInfo2KHR Source #
Instance details Methods (==) :: VkPhysicalDeviceSurfaceInfo2KHR -> VkPhysicalDeviceSurfaceInfo2KHR -> Bool # (/=) :: VkPhysicalDeviceSurfaceInfo2KHR -> VkPhysicalDeviceSurfaceInfo2KHR -> Bool #
Show VkPhysicalDeviceSurfaceInfo2KHR Source #
Instance details Methods showsPrec :: Int -> VkPhysicalDeviceSurfaceInfo2KHR -> ShowS # show :: VkPhysicalDeviceSurfaceInfo2KHR -> String # showList :: [VkPhysicalDeviceSurfaceInfo2KHR] -> ShowS #
Storable VkPhysicalDeviceSurfaceInfo2KHR Source #
Instance details Methods sizeOf :: VkPhysicalDeviceSurfaceInfo2KHR -> Int # alignment :: VkPhysicalDeviceSurfaceInfo2KHR -> Int # peekElemOff :: Ptr VkPhysicalDeviceSurfaceInfo2KHR -> Int -> IO VkPhysicalDeviceSurfaceInfo2KHR # pokeElemOff :: Ptr VkPhysicalDeviceSurfaceInfo2KHR -> Int -> VkPhysicalDeviceSurfaceInfo2KHR -> IO () # peekByteOff :: Ptr b -> Int -> IO VkPhysicalDeviceSurfaceInfo2KHR # pokeByteOff :: Ptr b -> Int -> VkPhysicalDeviceSurfaceInfo2KHR -> IO () # peek :: Ptr VkPhysicalDeviceSurfaceInfo2KHR -> IO VkPhysicalDeviceSurfaceInfo2KHR # poke :: Ptr VkPhysicalDeviceSurfaceInfo2KHR -> VkPhysicalDeviceSurfaceInfo2KHR -> IO () #

Eq VkSurfaceCapabilities2KHR Source #
Instance details Methods (==) :: VkSurfaceCapabilities2KHR -> VkSurfaceCapabilities2KHR -> Bool # (/=) :: VkSurfaceCapabilities2KHR -> VkSurfaceCapabilities2KHR -> Bool #
Show VkSurfaceCapabilities2KHR Source #
Instance details Methods showsPrec :: Int -> VkSurfaceCapabilities2KHR -> ShowS # show :: VkSurfaceCapabilities2KHR -> String # showList :: [VkSurfaceCapabilities2KHR] -> ShowS #
Storable VkSurfaceCapabilities2KHR Source #
Instance details Methods sizeOf :: VkSurfaceCapabilities2KHR -> Int # alignment :: VkSurfaceCapabilities2KHR -> Int # peekElemOff :: Ptr VkSurfaceCapabilities2KHR -> Int -> IO VkSurfaceCapabilities2KHR # pokeElemOff :: Ptr VkSurfaceCapabilities2KHR -> Int -> VkSurfaceCapabilities2KHR -> IO () # peekByteOff :: Ptr b -> Int -> IO VkSurfaceCapabilities2KHR # pokeByteOff :: Ptr b -> Int -> VkSurfaceCapabilities2KHR -> IO () # peek :: Ptr VkSurfaceCapabilities2KHR -> IO VkSurfaceCapabilities2KHR # poke :: Ptr VkSurfaceCapabilities2KHR -> VkSurfaceCapabilities2KHR -> IO () #

Eq VkSurfaceFormat2KHR Source #
Instance details Methods (==) :: VkSurfaceFormat2KHR -> VkSurfaceFormat2KHR -> Bool # (/=) :: VkSurfaceFormat2KHR -> VkSurfaceFormat2KHR -> Bool #
Show VkSurfaceFormat2KHR Source #
Instance details Methods showsPrec :: Int -> VkSurfaceFormat2KHR -> ShowS # show :: VkSurfaceFormat2KHR -> String # showList :: [VkSurfaceFormat2KHR] -> ShowS #
Storable VkSurfaceFormat2KHR Source #
Instance details Methods sizeOf :: VkSurfaceFormat2KHR -> Int # alignment :: VkSurfaceFormat2KHR -> Int # peekElemOff :: Ptr VkSurfaceFormat2KHR -> Int -> IO VkSurfaceFormat2KHR # pokeElemOff :: Ptr VkSurfaceFormat2KHR -> Int -> VkSurfaceFormat2KHR -> IO () # peekByteOff :: Ptr b -> Int -> IO VkSurfaceFormat2KHR # pokeByteOff :: Ptr b -> Int -> VkSurfaceFormat2KHR -> IO () # peek :: Ptr VkSurfaceFormat2KHR -> IO VkSurfaceFormat2KHR # poke :: Ptr VkSurfaceFormat2KHR -> VkSurfaceFormat2KHR -> IO () #

Documentation

Parameters

Description

Valid Usage (Implicit)

Return Codes

See Also

Parameters

Description

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

See Also

VkPhysicalDeviceSurfaceInfo2KHR
Fields vkSType :: VkStructureType `sType` is the type of this structure. vkPNext :: Ptr () `pNext` is `NULL` or a pointer to an extension-specific structure. vkSurface :: VkSurfaceKHR `surface` is the surface that will be associated with the swapchain.

VkSurfaceCapabilities2KHR
Fields vkSType :: VkStructureType `sType` is the type of this structure. vkPNext :: Ptr () `pNext` is `NULL` or a pointer to an extension-specific structure. vkSurfaceCapabilities :: VkSurfaceCapabilitiesKHR `surfaceCapabilities` is a structure of type `VkSurfaceCapabilitiesKHR` describing the capabilities of the specified surface.

VkSurfaceFormat2KHR
Fields vkSType :: VkStructureType `sType` is the type of this structure. vkPNext :: Ptr () `pNext` is `NULL` or a pointer to an extension-specific structure. vkSurfaceFormat :: VkSurfaceFormatKHR `surfaceFormat` is an instance of `VkSurfaceFormatKHR` describing a format-color space pair that is compatible with the specified surface.