Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_ARM_render_pass_striped

Description

Name

VK_ARM_render_pass_striped - device extension

VK_ARM_render_pass_striped

Name String: VK_ARM_render_pass_striped

Extension Type: Device extension
Registered Extension Number: 425
Revision: 1
Ratification Status: Not ratified
Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or

Vulkan Version 1.1 and

VK_KHR_synchronization2 or Vulkan Version 1.3

Contact

Jan-Harald Fredriksen @janharaldfredriksen-arm%0A*Here describe the issue or question you have about the VK_ARM_render_pass_striped extension*

Extension Proposal

VK_ARM_render_pass_striped

Other Extension Metadata

Last Modified Date: 2023-11-21

IP Status

No known IP claims.

Contributors

Jan-Harald Fredriksen, Arm
Lisa Wu, Arm
Torbjorn Nilsson, Arm
Ying-Chieh Chen, Mediatek
Jim Chiu, Mediatek

Description

This extension adds the ability to split a render pass instance into stripes, and to get a notification when rendering has completed for each stripe.

New Structures

RenderPassStripeInfoARM

Extending CommandBufferSubmitInfo:
- RenderPassStripeSubmitInfoARM
Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceRenderPassStripedFeaturesARM
Extending PhysicalDeviceProperties2:
- PhysicalDeviceRenderPassStripedPropertiesARM
Extending RenderingInfo, RenderPassBeginInfo:
- RenderPassStripeBeginInfoARM

New Enum Constants

ARM_RENDER_PASS_STRIPED_EXTENSION_NAME

Examples

None.

Version History

Revision 1, 2023-11-21
- Initial revision

Document Notes

For more information, see the Vulkan Specification.

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Synopsis

data PhysicalDeviceRenderPassStripedFeaturesARM = PhysicalDeviceRenderPassStripedFeaturesARM {
- renderPassStriped :: Bool
}
data PhysicalDeviceRenderPassStripedPropertiesARM = PhysicalDeviceRenderPassStripedPropertiesARM {
- renderPassStripeGranularity :: Extent2D
- maxRenderPassStripes :: Word32
}
data RenderPassStripeInfoARM = RenderPassStripeInfoARM {
- stripeArea :: Rect2D
}
data RenderPassStripeBeginInfoARM = RenderPassStripeBeginInfoARM {
- stripeInfos :: Vector RenderPassStripeInfoARM
}
data RenderPassStripeSubmitInfoARM = RenderPassStripeSubmitInfoARM {
- stripeSemaphoreInfos :: Vector SemaphoreSubmitInfo
}
type ARM_RENDER_PASS_STRIPED_SPEC_VERSION = 1
pattern ARM_RENDER_PASS_STRIPED_SPEC_VERSION :: Integral a => a
type ARM_RENDER_PASS_STRIPED_EXTENSION_NAME = "VK_ARM_render_pass_striped"
pattern ARM_RENDER_PASS_STRIPED_EXTENSION_NAME :: (Eq a, IsString a) => a

Documentation

data PhysicalDeviceRenderPassStripedFeaturesARM Source #

VkPhysicalDeviceRenderPassStripedFeaturesARM - Structure describing whether striped rendering can be supported by an implementation

Members

The members of the PhysicalDeviceRenderPassStripedFeaturesARM structure describe the following features:

Description

If the PhysicalDeviceRenderPassStripedFeaturesARM structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. If the application wishes to use a Device with any features described by PhysicalDeviceRenderPassStripedFeaturesARM, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Valid Usage (Implicit)

Members

The members of the PhysicalDeviceRenderPassStripedPropertiesARM structure describe the following limits:

Description

If the PhysicalDeviceRenderPassStripedPropertiesARM structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

Description

stripeArea is the render area that is affected by this stripe of the render pass instance. It must be a subregion of the renderArea of the render pass instance.

Valid Usage (Implicit)

Description

This structure can be included in the pNext chain of RenderPassBeginInfo or RenderingInfo to define how the render pass instance is split into stripes.

Valid Usage

stripeInfoCount must be less than or equal to PhysicalDeviceRenderPassStripedPropertiesARM::maxRenderPassStripes

The stripeArea defined by each element of pStripeInfos must not overlap the stripeArea of any other element

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_RENDER_PASS_STRIPE_BEGIN_INFO_ARM

pStripeInfos must be a valid pointer to an array of stripeInfoCount valid RenderPassStripeInfoARM structures
stripeInfoCount must be greater than 0

Description

This structure can be included in the pNext chain of CommandBufferSubmitInfo to provide a set of semaphores to be signaled for each striped render pass instance.

The elements of pStripeSemaphoreInfos are mapped to render pass instances in CommandBufferSubmitInfo::commandBuffer in submission order and in stripe order within each render pass instance. Each semaphore in pStripeSemaphoreInfos is signaled when the implementation has completed execution of the associated stripe. In a render pass instance that has multiview enabled, the stripe includes all views in the view mask. In a render pass instance with layerCount greater than 1, the stripe includes all layers.

Render pass instances that specify the RENDERING_RESUMING_BIT will not have any elements of pStripeSemaphoreInfos mapped to them. Instead, for suspending and resuming render pass instances, this mapping is done for the first suspending render pass instance, and the per-stripe semaphores are only signaled for the last resuming render pass instance.

Valid Usage

The semaphore member of each element of pStripeSemaphoreInfos must have been created with a SemaphoreType of SEMAPHORE_TYPE_BINARY

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_RENDER_PASS_STRIPE_SUBMIT_INFO_ARM

pStripeSemaphoreInfos must be a valid pointer to an array of stripeSemaphoreInfoCount valid SemaphoreSubmitInfo structures
stripeSemaphoreInfoCount must be greater than 0

Eq PhysicalDeviceRenderPassStripedFeaturesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods (==) :: PhysicalDeviceRenderPassStripedFeaturesARM -> PhysicalDeviceRenderPassStripedFeaturesARM -> Bool # (/=) :: PhysicalDeviceRenderPassStripedFeaturesARM -> PhysicalDeviceRenderPassStripedFeaturesARM -> Bool #
Storable PhysicalDeviceRenderPassStripedFeaturesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods sizeOf :: PhysicalDeviceRenderPassStripedFeaturesARM -> Int # alignment :: PhysicalDeviceRenderPassStripedFeaturesARM -> Int # peekElemOff :: Ptr PhysicalDeviceRenderPassStripedFeaturesARM -> Int -> IO PhysicalDeviceRenderPassStripedFeaturesARM # pokeElemOff :: Ptr PhysicalDeviceRenderPassStripedFeaturesARM -> Int -> PhysicalDeviceRenderPassStripedFeaturesARM -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceRenderPassStripedFeaturesARM # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceRenderPassStripedFeaturesARM -> IO () # peek :: Ptr PhysicalDeviceRenderPassStripedFeaturesARM -> IO PhysicalDeviceRenderPassStripedFeaturesARM # poke :: Ptr PhysicalDeviceRenderPassStripedFeaturesARM -> PhysicalDeviceRenderPassStripedFeaturesARM -> IO () #
Show PhysicalDeviceRenderPassStripedFeaturesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods showsPrec :: Int -> PhysicalDeviceRenderPassStripedFeaturesARM -> ShowS # show :: PhysicalDeviceRenderPassStripedFeaturesARM -> String # showList :: [PhysicalDeviceRenderPassStripedFeaturesARM] -> ShowS #
FromCStruct PhysicalDeviceRenderPassStripedFeaturesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods peekCStruct :: Ptr PhysicalDeviceRenderPassStripedFeaturesARM -> IO PhysicalDeviceRenderPassStripedFeaturesARM Source #
ToCStruct PhysicalDeviceRenderPassStripedFeaturesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods withCStruct :: PhysicalDeviceRenderPassStripedFeaturesARM -> (Ptr PhysicalDeviceRenderPassStripedFeaturesARM -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceRenderPassStripedFeaturesARM -> PhysicalDeviceRenderPassStripedFeaturesARM -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceRenderPassStripedFeaturesARM -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceRenderPassStripedFeaturesARM -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceRenderPassStripedFeaturesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods zero :: PhysicalDeviceRenderPassStripedFeaturesARM Source #

Storable PhysicalDeviceRenderPassStripedPropertiesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods sizeOf :: PhysicalDeviceRenderPassStripedPropertiesARM -> Int # alignment :: PhysicalDeviceRenderPassStripedPropertiesARM -> Int # peekElemOff :: Ptr PhysicalDeviceRenderPassStripedPropertiesARM -> Int -> IO PhysicalDeviceRenderPassStripedPropertiesARM # pokeElemOff :: Ptr PhysicalDeviceRenderPassStripedPropertiesARM -> Int -> PhysicalDeviceRenderPassStripedPropertiesARM -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceRenderPassStripedPropertiesARM # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceRenderPassStripedPropertiesARM -> IO () # peek :: Ptr PhysicalDeviceRenderPassStripedPropertiesARM -> IO PhysicalDeviceRenderPassStripedPropertiesARM # poke :: Ptr PhysicalDeviceRenderPassStripedPropertiesARM -> PhysicalDeviceRenderPassStripedPropertiesARM -> IO () #
Show PhysicalDeviceRenderPassStripedPropertiesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods showsPrec :: Int -> PhysicalDeviceRenderPassStripedPropertiesARM -> ShowS # show :: PhysicalDeviceRenderPassStripedPropertiesARM -> String # showList :: [PhysicalDeviceRenderPassStripedPropertiesARM] -> ShowS #
FromCStruct PhysicalDeviceRenderPassStripedPropertiesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods peekCStruct :: Ptr PhysicalDeviceRenderPassStripedPropertiesARM -> IO PhysicalDeviceRenderPassStripedPropertiesARM Source #
ToCStruct PhysicalDeviceRenderPassStripedPropertiesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods withCStruct :: PhysicalDeviceRenderPassStripedPropertiesARM -> (Ptr PhysicalDeviceRenderPassStripedPropertiesARM -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceRenderPassStripedPropertiesARM -> PhysicalDeviceRenderPassStripedPropertiesARM -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceRenderPassStripedPropertiesARM -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceRenderPassStripedPropertiesARM -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceRenderPassStripedPropertiesARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods zero :: PhysicalDeviceRenderPassStripedPropertiesARM Source #

Storable RenderPassStripeInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods sizeOf :: RenderPassStripeInfoARM -> Int # alignment :: RenderPassStripeInfoARM -> Int # peekElemOff :: Ptr RenderPassStripeInfoARM -> Int -> IO RenderPassStripeInfoARM # pokeElemOff :: Ptr RenderPassStripeInfoARM -> Int -> RenderPassStripeInfoARM -> IO () # peekByteOff :: Ptr b -> Int -> IO RenderPassStripeInfoARM # pokeByteOff :: Ptr b -> Int -> RenderPassStripeInfoARM -> IO () # peek :: Ptr RenderPassStripeInfoARM -> IO RenderPassStripeInfoARM # poke :: Ptr RenderPassStripeInfoARM -> RenderPassStripeInfoARM -> IO () #
Show RenderPassStripeInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods showsPrec :: Int -> RenderPassStripeInfoARM -> ShowS # show :: RenderPassStripeInfoARM -> String # showList :: [RenderPassStripeInfoARM] -> ShowS #
FromCStruct RenderPassStripeInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods peekCStruct :: Ptr RenderPassStripeInfoARM -> IO RenderPassStripeInfoARM Source #
ToCStruct RenderPassStripeInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods withCStruct :: RenderPassStripeInfoARM -> (Ptr RenderPassStripeInfoARM -> IO b) -> IO b Source # pokeCStruct :: Ptr RenderPassStripeInfoARM -> RenderPassStripeInfoARM -> IO b -> IO b Source # withZeroCStruct :: (Ptr RenderPassStripeInfoARM -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr RenderPassStripeInfoARM -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero RenderPassStripeInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods zero :: RenderPassStripeInfoARM Source #

Show RenderPassStripeBeginInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods showsPrec :: Int -> RenderPassStripeBeginInfoARM -> ShowS # show :: RenderPassStripeBeginInfoARM -> String # showList :: [RenderPassStripeBeginInfoARM] -> ShowS #
FromCStruct RenderPassStripeBeginInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods peekCStruct :: Ptr RenderPassStripeBeginInfoARM -> IO RenderPassStripeBeginInfoARM Source #
ToCStruct RenderPassStripeBeginInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods withCStruct :: RenderPassStripeBeginInfoARM -> (Ptr RenderPassStripeBeginInfoARM -> IO b) -> IO b Source # pokeCStruct :: Ptr RenderPassStripeBeginInfoARM -> RenderPassStripeBeginInfoARM -> IO b -> IO b Source # withZeroCStruct :: (Ptr RenderPassStripeBeginInfoARM -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr RenderPassStripeBeginInfoARM -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero RenderPassStripeBeginInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods zero :: RenderPassStripeBeginInfoARM Source #

Show RenderPassStripeSubmitInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods showsPrec :: Int -> RenderPassStripeSubmitInfoARM -> ShowS # show :: RenderPassStripeSubmitInfoARM -> String # showList :: [RenderPassStripeSubmitInfoARM] -> ShowS #
FromCStruct RenderPassStripeSubmitInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods peekCStruct :: Ptr RenderPassStripeSubmitInfoARM -> IO RenderPassStripeSubmitInfoARM Source #
ToCStruct RenderPassStripeSubmitInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods withCStruct :: RenderPassStripeSubmitInfoARM -> (Ptr RenderPassStripeSubmitInfoARM -> IO b) -> IO b Source # pokeCStruct :: Ptr RenderPassStripeSubmitInfoARM -> RenderPassStripeSubmitInfoARM -> IO b -> IO b Source # withZeroCStruct :: (Ptr RenderPassStripeSubmitInfoARM -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr RenderPassStripeSubmitInfoARM -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero RenderPassStripeSubmitInfoARM Source #
Instance details Defined in Vulkan.Extensions.VK_ARM_render_pass_striped Methods zero :: RenderPassStripeSubmitInfoARM Source #

Name

VK_ARM_render_pass_striped

Other Extension Metadata

Description

New Structures

New Enum Constants

Examples

Version History

See Also

Document Notes

Documentation

Members

Description

Valid Usage (Implicit)

See Also

Instances

Members

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

PhysicalDeviceRenderPassStripedFeaturesARM
Fields renderPassStriped :: Bool `renderPassStriped` indicates that striped rendering is supported by the implementation.

PhysicalDeviceRenderPassStripedPropertiesARM
Fields renderPassStripeGranularity :: Extent2D `renderPassStripeGranularity` indicates the minimum supported granularity of striped render pass regions. maxRenderPassStripes :: Word32 `maxRenderPassStripes` indicates the maximum number of stripes supported in striped rendering.

RenderPassStripeInfoARM
Fields stripeArea :: Rect2D `stripeArea` is the stripe area, and is described in more detail below.

RenderPassStripeBeginInfoARM
Fields stripeInfos :: Vector RenderPassStripeInfoARM `pStripeInfos` is a pointer to an array of `stripeInfoCount` `RenderPassStripeInfoARM` structures describing the stripes used by the render pass instance.

RenderPassStripeSubmitInfoARM
Fields stripeSemaphoreInfos :: Vector SemaphoreSubmitInfo `pStripeSemaphoreInfos` is a pointer to an array of `stripeSemaphoreInfoCount` `SemaphoreSubmitInfo` structures describing the semaphores used to signal stripe completion.