Vulkan.Extensions.VK_EXT_color_write_enable

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 QUEUE_GRAPHICS_BIT 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

'

Conditional Rendering

vkCmdSetColorWriteEnableEXT is not affected by conditional rendering

See Also

VK_EXT_color_write_enable, Bool32, CommandBuffer

VkPhysicalDeviceColorWriteEnableFeaturesEXT - Structure describing whether writes to color attachments can be enabled and disabled dynamically

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. If the application wishes to use a Device with any features described by PhysicalDeviceColorWriteEnableFeaturesEXT, 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.

Structure Chaining

Extends the structures

• DeviceCreateInfo

• PhysicalDeviceFeatures2

See Also

VK_EXT_color_write_enable, Bool32, StructureType

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, 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

Structure Chaining

Extends the structure

• PipelineColorBlendStateCreateInfo

See Also

VK_EXT_color_write_enable, Bool32, StructureType