Vulkan.Extensions.VK_KHR_incremental_present

Documentation

data PresentRegionsKHR

VkPresentRegionsKHR - Structure hint of rectangular regions changed by vkQueuePresentKHR

Valid Usage

• swapchainCount must be the same value as PresentInfoKHR::swapchainCount, where PresentInfoKHR is included in the pNext chain of this PresentRegionsKHR structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PRESENT_REGIONS_KHR

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

See Also

PresentRegionKHR, StructureType

Constructors

PresentRegionsKHR

Fields

• swapchainCount :: Word32

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

• regions :: Vector PresentRegionKHR

  pRegions is NULL or a pointer to an array of PresentRegionKHR 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 PresentInfoKHR::pSwapchains array.

Instances

Show PresentRegionsKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

showsPrec :: Int -> PresentRegionsKHR -> ShowS

show :: PresentRegionsKHR -> String

showList :: [PresentRegionsKHR] -> ShowS

Generic PresentRegionsKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Associated Types

type Rep PresentRegionsKHR :: Type -> Type

Methods

from :: PresentRegionsKHR -> Rep PresentRegionsKHR x

to :: Rep PresentRegionsKHR x -> PresentRegionsKHR

FromCStruct PresentRegionsKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

peekCStruct :: Ptr PresentRegionsKHR -> IO PresentRegionsKHR

ToCStruct PresentRegionsKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

withCStruct :: PresentRegionsKHR -> (Ptr PresentRegionsKHR -> IO b) -> IO b

pokeCStruct :: Ptr PresentRegionsKHR -> PresentRegionsKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PresentRegionsKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PresentRegionsKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PresentRegionsKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

zero :: PresentRegionsKHR

type Rep PresentRegionsKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

type Rep PresentRegionsKHR = D1 ('MetaData "PresentRegionsKHR" "Vulkan.Extensions.VK_KHR_incremental_present" "vulkan-3.6.4-inplace" 'False) (C1 ('MetaCons "PresentRegionsKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "swapchainCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "regions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector PresentRegionKHR))))

data PresentRegionKHR

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

Valid Usage (Implicit)

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

See Also

PresentRegionsKHR, RectLayerKHR

Constructors

PresentRegionKHR

Fields

• rectangleCount :: Word32

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

• rectangles :: Vector RectLayerKHR

  pRectangles is either NULL or a pointer to an array of RectLayerKHR structures. The RectLayerKHR 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

Show PresentRegionKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

showsPrec :: Int -> PresentRegionKHR -> ShowS

show :: PresentRegionKHR -> String

showList :: [PresentRegionKHR] -> ShowS

Generic PresentRegionKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Associated Types

type Rep PresentRegionKHR :: Type -> Type

Methods

from :: PresentRegionKHR -> Rep PresentRegionKHR x

to :: Rep PresentRegionKHR x -> PresentRegionKHR

FromCStruct PresentRegionKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

peekCStruct :: Ptr PresentRegionKHR -> IO PresentRegionKHR

ToCStruct PresentRegionKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

withCStruct :: PresentRegionKHR -> (Ptr PresentRegionKHR -> IO b) -> IO b

pokeCStruct :: Ptr PresentRegionKHR -> PresentRegionKHR -> IO b -> IO b

withZeroCStruct :: (Ptr PresentRegionKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr PresentRegionKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PresentRegionKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

zero :: PresentRegionKHR

type Rep PresentRegionKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

type Rep PresentRegionKHR = D1 ('MetaData "PresentRegionKHR" "Vulkan.Extensions.VK_KHR_incremental_present" "vulkan-3.6.4-inplace" 'False) (C1 ('MetaCons "PresentRegionKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "rectangleCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "rectangles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector RectLayerKHR))))

data RectLayerKHR

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

Valid Usage

• The sum of offset and extent must be no greater than the imageExtent member of the SwapchainCreateInfoKHR structure passed to createSwapchainKHR

• layer must be less than the imageArrayLayers member of the SwapchainCreateInfoKHR structure passed to createSwapchainKHR

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

See Also

Extent2D, Offset2D, PresentRegionKHR

Constructors

RectLayerKHR

Fields

• offset :: Offset2D

  offset is the origin of the rectangle, in pixels.

• extent :: Extent2D

  extent is the size of the rectangle, in pixels.

• layer :: Word32

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

Instances

Show RectLayerKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

showsPrec :: Int -> RectLayerKHR -> ShowS

show :: RectLayerKHR -> String

showList :: [RectLayerKHR] -> ShowS

Generic RectLayerKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Associated Types

type Rep RectLayerKHR :: Type -> Type

Methods

from :: RectLayerKHR -> Rep RectLayerKHR x

to :: Rep RectLayerKHR x -> RectLayerKHR

FromCStruct RectLayerKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

peekCStruct :: Ptr RectLayerKHR -> IO RectLayerKHR

ToCStruct RectLayerKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

withCStruct :: RectLayerKHR -> (Ptr RectLayerKHR -> IO b) -> IO b

pokeCStruct :: Ptr RectLayerKHR -> RectLayerKHR -> IO b -> IO b

withZeroCStruct :: (Ptr RectLayerKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr RectLayerKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero RectLayerKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

Methods

zero :: RectLayerKHR

type Rep RectLayerKHR

Defined in Vulkan.Extensions.VK_KHR_incremental_present

type Rep RectLayerKHR = D1 ('MetaData "RectLayerKHR" "Vulkan.Extensions.VK_KHR_incremental_present" "vulkan-3.6.4-inplace" 'False) (C1 ('MetaCons "RectLayerKHR" 'PrefixI 'True) (S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Offset2D) :*: (S1 ('MetaSel ('Just "extent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Extent2D) :*: S1 ('MetaSel ('Just "layer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32))))

type KHR_INCREMENTAL_PRESENT_SPEC_VERSION = 1

pattern KHR_INCREMENTAL_PRESENT_SPEC_VERSION :: forall a. Integral a => a

type KHR_INCREMENTAL_PRESENT_EXTENSION_NAME = "VK_KHR_incremental_present"

pattern KHR_INCREMENTAL_PRESENT_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a