Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_EXT_color_write_enable

Description

Name

VK_EXT_color_write_enable - device extension

VK_EXT_color_write_enable

Name String: VK_EXT_color_write_enable

Extension Type

Device extension

Registered Extension Number

382

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Version 1.1

Contact

Sharif Elcott @selcott%0A*Here describe the issue or question you have about the VK_EXT_color_write_enable extension*

Other Extension Metadata

Last Modified Date: 2020-02-25

IP Status

No known IP claims.

Contributors

Sharif Elcott, Google
Tobias Hector, AMD
Piers Daniell, NVIDIA

Description

This extension allows for selectively enabling and disabling writes to output color attachments via a pipeline dynamic state.

The intended use cases for this new state are mostly identical to those of colorWriteMask, such as selectively disabling writes to avoid feedback loops between subpasses or bandwidth savings for unused outputs. By making the state dynamic, one additional benefit is the ability to reduce pipeline counts and pipeline switching via shaders that write a superset of the desired data of which subsets are selected dynamically. The reason for a new state, colorWriteEnable, rather than making colorWriteMask dynamic is that, on many implementations, the more flexible per-component semantics of the colorWriteMask state cannot be made dynamic in a performant manner.

New Commands

cmdSetColorWriteEnableEXT

New Structures

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceColorWriteEnableFeaturesEXT

Extending PipelineColorBlendStateCreateInfo:
- PipelineColorWriteCreateInfoEXT

New Enum Constants

EXT_COLOR_WRITE_ENABLE_EXTENSION_NAME

EXT_COLOR_WRITE_ENABLE_SPEC_VERSION
Extending DynamicState:
- DYNAMIC_STATE_COLOR_WRITE_ENABLE_EXT
Extending StructureType:
- STRUCTURE_TYPE_PHYSICAL_DEVICE_COLOR_WRITE_ENABLE_FEATURES_EXT
- STRUCTURE_TYPE_PIPELINE_COLOR_WRITE_CREATE_INFO_EXT

Version History

Revision 1, 2020-01-25 (Sharif Elcott)
- 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

cmdSetColorWriteEnableEXT :: forall io. MonadIO io => CommandBuffer -> ("colorWriteEnables" ::: Vector Bool) -> io ()
data PhysicalDeviceColorWriteEnableFeaturesEXT = PhysicalDeviceColorWriteEnableFeaturesEXT {
- colorWriteEnable :: Bool
}
data PipelineColorWriteCreateInfoEXT = PipelineColorWriteCreateInfoEXT {
- colorWriteEnables :: Vector Bool
}
type EXT_COLOR_WRITE_ENABLE_SPEC_VERSION = 1
pattern EXT_COLOR_WRITE_ENABLE_SPEC_VERSION :: forall a. Integral a => a
type EXT_COLOR_WRITE_ENABLE_EXTENSION_NAME = "VK_EXT_color_write_enable"
pattern EXT_COLOR_WRITE_ENABLE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

cmdSetColorWriteEnableEXT Source #

Arguments

:: forall io. MonadIO io
=> CommandBuffer	`commandBuffer` is the command buffer into which the command will be recorded.
-> ("colorWriteEnables" ::: Vector Bool)	`pColorWriteEnables` is a pointer to an array of per target attachment boolean values specifying whether color writes are enabled for the given attachment.
-> io ()

vkCmdSetColorWriteEnableEXT - Enable or disable writes to a color attachment dynamically for a command buffer

Description

This command sets the color write enables for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with DYNAMIC_STATE_COLOR_WRITE_ENABLE_EXT set in PipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the PipelineColorWriteCreateInfoEXT::pColorWriteEnables values used to create the currently active pipeline.

Valid Usage

The colorWriteEnable feature must be enabled

attachmentCount must be less than or equal to the maxColorAttachments member of PhysicalDeviceLimits

Valid Usage (Implicit)

commandBuffer must be a valid CommandBuffer handle

pColorWriteEnables must be a valid pointer to an array of attachmentCount Bool32 values
commandBuffer must be in the recording state
The CommandPool that commandBuffer was allocated from must support graphics operations
This command must only be called outside of a video coding scope
attachmentCount must be greater than 0

Host Synchronization

Host access to commandBuffer must be externally synchronized

Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Both	Outside	Graphics	State

Members

This structure describes the following feature:

Description

If the PhysicalDeviceColorWriteEnableFeaturesEXT 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. PhysicalDeviceColorWriteEnableFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

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

data PipelineColorWriteCreateInfoEXT Source #

VkPipelineColorWriteCreateInfoEXT - Structure specifying color write state of a newly created pipeline

Description

When this structure is included in the pNext chain of PipelineColorBlendStateCreateInfo, it defines per-attachment color write state. If this structure is not included in the pNext chain, it is equivalent to specifying this structure with attachmentCount equal to the attachmentCount member of PipelineColorBlendStateCreateInfo, and pColorWriteEnables pointing to an array of as many TRUE values.

If the colorWriteEnable feature is not enabled on the device, all Bool32 elements in the pColorWriteEnables array must be TRUE.

Color Write Enable interacts with the Color Write Mask as follows:

If colorWriteEnable is TRUE, writes to the attachment are determined by the colorWriteMask.
If colorWriteEnable is FALSE, the colorWriteMask is ignored and writes to all components of the attachment are disabled. This is equivalent to specifying a colorWriteMask of 0.

Valid Usage

If the colorWriteEnable feature is not enabled, all elements of pColorWriteEnables must be TRUE

If the pipeline is being created with DYNAMIC_STATE_COLOR_BLEND_ADVANCED_EXT, DYNAMIC_STATE_COLOR_BLEND_ENABLE_EXT, DYNAMIC_STATE_COLOR_BLEND_EQUATION_EXT, or DYNAMIC_STATE_COLOR_WRITE_MASK_EXT dynamic states not set, attachmentCount must be equal to the attachmentCount member of the PipelineColorBlendStateCreateInfo structure specified during pipeline creation
attachmentCount must be less than or equal to the maxColorAttachments member of PhysicalDeviceLimits

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PIPELINE_COLOR_WRITE_CREATE_INFO_EXT

If attachmentCount is not 0, pColorWriteEnables must be a valid pointer to an array of attachmentCount Bool32 values

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

Name

VK_EXT_color_write_enable

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

See Also

Members

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage

Valid Usage (Implicit)

See Also

Instances

PhysicalDeviceColorWriteEnableFeaturesEXT
Fields colorWriteEnable :: Bool `colorWriteEnable` indicates that the implementation supports the dynamic state `DYNAMIC_STATE_COLOR_WRITE_ENABLE_EXT`.

PipelineColorWriteCreateInfoEXT
Fields colorWriteEnables :: Vector Bool `pColorWriteEnables` is a pointer to an array of per target attachment boolean values specifying whether color writes are enabled for the given attachment.