Graphics.Vulkan.Extensions.VK_KHR_incremental_present

Documentation

pattern VK_STRUCTURE_TYPE_PRESENT_REGIONS_KHR :: VkStructureType

pattern VK_KHR_INCREMENTAL_PRESENT_SPEC_VERSION :: Integral a => a

pattern VK_KHR_INCREMENTAL_PRESENT_EXTENSION_NAME :: (Eq a, IsString a) => a

data VkPresentRegionsKHR

VkPresentRegionsKHR - Structure hint of rectangular regions changed by vkQueuePresentKHR

Description

Valid Usage

• swapchainCount must be the same value as VkPresentInfoKHR::swapchainCount, where VkPresentInfoKHR is in the pNext-chain of this VkPresentRegionsKHR structure.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_PRESENT_REGIONS_KHR

• If pRegions is not NULL, pRegions must be a valid pointer to an array of swapchainCount valid VkPresentRegionKHR structures
• swapchainCount must be greater than 0

See Also

VkPresentRegionKHR, VkStructureType

Constructors

VkPresentRegionsKHR

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkSwapchainCount :: Word32

  swapchainCount is the number of swapchains being presented to by this command.

• vkPRegions :: Ptr VkPresentRegionKHR

  pRegions is NULL or a pointer to an array of VkPresentRegionKHR elements with swapchainCount entries. If not NULL, each element of pRegions contains the region that has changed since the last present to the swapchain in the corresponding entry in the VkPresentInfoKHR::pSwapchains array.

Instances

Eq VkPresentRegionsKHR

Methods

(==) :: VkPresentRegionsKHR -> VkPresentRegionsKHR -> Bool

(/=) :: VkPresentRegionsKHR -> VkPresentRegionsKHR -> Bool

Show VkPresentRegionsKHR

Methods

showsPrec :: Int -> VkPresentRegionsKHR -> ShowS

show :: VkPresentRegionsKHR -> String

showList :: [VkPresentRegionsKHR] -> ShowS

Storable VkPresentRegionsKHR

Methods

sizeOf :: VkPresentRegionsKHR -> Int

alignment :: VkPresentRegionsKHR -> Int

peekElemOff :: Ptr VkPresentRegionsKHR -> Int -> IO VkPresentRegionsKHR

pokeElemOff :: Ptr VkPresentRegionsKHR -> Int -> VkPresentRegionsKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkPresentRegionsKHR

pokeByteOff :: Ptr b -> Int -> VkPresentRegionsKHR -> IO ()

peek :: Ptr VkPresentRegionsKHR -> IO VkPresentRegionsKHR

poke :: Ptr VkPresentRegionsKHR -> VkPresentRegionsKHR -> IO ()

data VkPresentRegionKHR

VkPresentRegionKHR - Structure containing rectangular region changed by vkQueuePresentKHR for a given VkImage

Description

Valid Usage (Implicit)

• If rectangleCount is not 0, and pRectangles is not NULL, pRectangles must be a valid pointer to an array of rectangleCount VkRectLayerKHR structures

See Also

VkPresentRegionsKHR, VkRectLayerKHR

Constructors

VkPresentRegionKHR

Fields

• vkRectangleCount :: Word32

  rectangleCount is the number of rectangles in pRectangles, or zero if the entire image has changed and should be presented.

• vkPRectangles :: Ptr VkRectLayerKHR

  pRectangles is either NULL or a pointer to an array of VkRectLayerKHR structures. The VkRectLayerKHR structure is the framebuffer coordinates, plus layer, of a portion of a presentable image that has changed and must be presented. If non-NULL, each entry in pRectangles is a rectangle of the given image that has changed since the last image was presented to the given swapchain.

Instances

Eq VkPresentRegionKHR

Methods

(==) :: VkPresentRegionKHR -> VkPresentRegionKHR -> Bool

(/=) :: VkPresentRegionKHR -> VkPresentRegionKHR -> Bool

Show VkPresentRegionKHR

Methods

showsPrec :: Int -> VkPresentRegionKHR -> ShowS

show :: VkPresentRegionKHR -> String

showList :: [VkPresentRegionKHR] -> ShowS

Storable VkPresentRegionKHR

Methods

sizeOf :: VkPresentRegionKHR -> Int

alignment :: VkPresentRegionKHR -> Int

peekElemOff :: Ptr VkPresentRegionKHR -> Int -> IO VkPresentRegionKHR

pokeElemOff :: Ptr VkPresentRegionKHR -> Int -> VkPresentRegionKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkPresentRegionKHR

pokeByteOff :: Ptr b -> Int -> VkPresentRegionKHR -> IO ()

peek :: Ptr VkPresentRegionKHR -> IO VkPresentRegionKHR

poke :: Ptr VkPresentRegionKHR -> VkPresentRegionKHR -> IO ()

data VkRectLayerKHR

VkRectLayerKHR - Structure containing a rectangle, including layer, changed by vkQueuePresentKHR for a given VkImage

Description

Valid Usage

• The sum of offset and extent must be no greater than the imageExtent member of the VkSwapchainCreateInfoKHR structure given to vkCreateSwapchainKHR.

• layer must be less than imageArrayLayers member of the VkSwapchainCreateInfoKHR structure given to vkCreateSwapchainKHR.

Some platforms allow the size of a surface to change, and then scale the pixels of the image to fit the surface. VkRectLayerKHR specifies pixels of the swapchain’s image(s), which will be constant for the life of the swapchain.

See Also

VkExtent2D, VkOffset2D, VkPresentRegionKHR

Constructors

VkRectLayerKHR

Fields

• vkOffset :: VkOffset2D

  offset is the origin of the rectangle, in pixels.

• vkExtent :: VkExtent2D

  extent is the size of the rectangle, in pixels.

• vkLayer :: Word32

  layer is the layer of the image. For images with only one layer, the value of layer must be 0.

Instances

Eq VkRectLayerKHR

Methods

(==) :: VkRectLayerKHR -> VkRectLayerKHR -> Bool

(/=) :: VkRectLayerKHR -> VkRectLayerKHR -> Bool

Show VkRectLayerKHR

Methods

showsPrec :: Int -> VkRectLayerKHR -> ShowS

show :: VkRectLayerKHR -> String

showList :: [VkRectLayerKHR] -> ShowS

Storable VkRectLayerKHR

Methods

sizeOf :: VkRectLayerKHR -> Int

alignment :: VkRectLayerKHR -> Int

peekElemOff :: Ptr VkRectLayerKHR -> Int -> IO VkRectLayerKHR

pokeElemOff :: Ptr VkRectLayerKHR -> Int -> VkRectLayerKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkRectLayerKHR

pokeByteOff :: Ptr b -> Int -> VkRectLayerKHR -> IO ()

peek :: Ptr VkRectLayerKHR -> IO VkRectLayerKHR

poke :: Ptr VkRectLayerKHR -> VkRectLayerKHR -> IO ()