Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_nested_command_buffer

Description

Name

VK_EXT_nested_command_buffer - device extension

VK_EXT_nested_command_buffer

Name String: VK_EXT_nested_command_buffer

Extension Type

Device extension

Registered Extension Number

452

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Vulkan Version 1.1

Contact

Piers Daniell @pdaniell-nv%0A*Here describe the issue or question you have about the VK_EXT_nested_command_buffer extension*

Other Extension Metadata

Last Modified Date: 2023-09-18

Contributors

Daniel Story, Nintendo
Peter Kohaut, NVIDIA
Shahbaz Youssefi, Google
Slawomir Grajewski, Intel
Stu Smith, AMD

Description

With core Vulkan it is not legal to call cmdExecuteCommands when recording a secondary command buffer. This extension relaxes that restriction, allowing secondary command buffers to execute other secondary command buffers.

New Structures

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceNestedCommandBufferFeaturesEXT

Extending PhysicalDeviceProperties2:
- PhysicalDeviceNestedCommandBufferPropertiesEXT

New Enum Constants

EXT_NESTED_COMMAND_BUFFER_EXTENSION_NAME

EXT_NESTED_COMMAND_BUFFER_SPEC_VERSION
Extending RenderingFlagBits:
- RENDERING_CONTENTS_INLINE_BIT_EXT
Extending StructureType:
- STRUCTURE_TYPE_PHYSICAL_DEVICE_NESTED_COMMAND_BUFFER_FEATURES_EXT
- STRUCTURE_TYPE_PHYSICAL_DEVICE_NESTED_COMMAND_BUFFER_PROPERTIES_EXT
Extending SubpassContents:
- SUBPASS_CONTENTS_INLINE_AND_SECONDARY_COMMAND_BUFFERS_EXT

Issues

1) The Command Buffer Levels property for the Vulkan commands comes from the cmdbufferlevel attribute in vk.xml for the command, and it is currently not possible to modify this attribute based on whether an extension is enabled. For this extension we want the cmdbufferlevel attribute for vkCmdExecuteCommands to be primary,secondary when this extension is enabled and primary otherwise.

RESOLVED: The cmdbufferlevel attribute for cmdExecuteCommands has been changed to primary,secondary and a new VUID added to prohibit recording this command in a secondary command buffer unless this extension is enabled.

Version History

Revision 1, 2023-09-18 (Piers Daniell)
- Internal revisions

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

pattern SUBPASS_CONTENTS_INLINE_AND_SECONDARY_COMMAND_BUFFERS_EXT :: SubpassContents
pattern RENDERING_CONTENTS_INLINE_BIT_EXT :: RenderingFlagBits
data PhysicalDeviceNestedCommandBufferFeaturesEXT = PhysicalDeviceNestedCommandBufferFeaturesEXT {
}
data PhysicalDeviceNestedCommandBufferPropertiesEXT = PhysicalDeviceNestedCommandBufferPropertiesEXT {
- maxCommandBufferNestingLevel :: Word32
}
type EXT_NESTED_COMMAND_BUFFER_SPEC_VERSION = 1
pattern EXT_NESTED_COMMAND_BUFFER_SPEC_VERSION :: Integral a => a
type EXT_NESTED_COMMAND_BUFFER_EXTENSION_NAME = "VK_EXT_nested_command_buffer"
pattern EXT_NESTED_COMMAND_BUFFER_EXTENSION_NAME :: (Eq a, IsString a) => a

Documentation

pattern SUBPASS_CONTENTS_INLINE_AND_SECONDARY_COMMAND_BUFFERS_EXT :: SubpassContents Source #

pattern RENDERING_CONTENTS_INLINE_BIT_EXT :: RenderingFlagBits Source #

data PhysicalDeviceNestedCommandBufferFeaturesEXT Source #

VkPhysicalDeviceNestedCommandBufferFeaturesEXT - Structure describing whether nested command buffers are supported by the implementation

Members

This structure describes the following features:

Description

If the PhysicalDeviceNestedCommandBufferFeaturesEXT 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 PhysicalDeviceNestedCommandBufferFeaturesEXT, 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)

nestedCommandBuffer :: Bool
nestedCommandBuffer indicates the implementation supports nested command buffers, which allows Secondary Command Buffers to execute other Secondary Command Buffers.
nestedCommandBufferRendering :: Bool
nestedCommandBufferRendering indicates that it is valid to call cmdExecuteCommands inside a Secondary Command Buffer recorded with COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT.
nestedCommandBufferSimultaneousUse :: Bool
nestedCommandBufferSimultaneousUse indicates that the implementation supports nested command buffers with command buffers that are recorded with COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT.

Instances

Instances details

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

data PhysicalDeviceNestedCommandBufferPropertiesEXT Source #

VkPhysicalDeviceNestedCommandBufferPropertiesEXT - Structure describing the nested command buffer limits of an implementation

Members

The members of the PhysicalDeviceNestedCommandBufferPropertiesEXT structure describe the following features:

Description

If the PhysicalDeviceNestedCommandBufferPropertiesEXT 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)

PhysicalDeviceNestedCommandBufferPropertiesEXT
Fields maxCommandBufferNestingLevel :: Word32 `maxCommandBufferNestingLevel` indicates the maximum nesting level of calls to `cmdExecuteCommands` from Secondary Command Buffers. A `maxCommandBufferNestingLevel` of `UINT32_MAX` means there is no limit to the nesting level.

Instances

Instances details

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