VkPipelineColorWriteCreateInfoEXT
The VkPipelineColorWriteCreateInfoEXT
structure is defined as:
typedef struct VkPipelineColorWriteCreateInfoEXT {
VkStructureType sType;
const void* pNext;
uint32_t attachmentCount;
const VkBool32* pColorWriteEnables;
} VkPipelineColorWriteCreateInfoEXT;
sType
is a VkStructureType value identifying this structure.pNext
isNULL
or a pointer to a structure extending this structure.attachmentCount
is the number of VkBool32 elements inpColorWriteEnables
.pColorWriteEnables
is a pointer to an array of per target attachment boolean values specifying whether color writes are enabled for the given attachment.
When this structure is included in the pNext
chain of
VkPipelineColorBlendStateCreateInfo, 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 VkPipelineColorBlendStateCreateInfo,
and pColorWriteEnables
pointing to an array of as many VK_TRUE
values.
If the colorWriteEnable
feature is not
enabled on the device, all VkBool32 elements in the
pColorWriteEnables
array must be VK_TRUE
.
Color Write Enable interacts with the Color Write Mask as follows:
- If
colorWriteEnable
isVK_TRUE
, writes to the attachment are determined by thecolorWriteMask
. - If
colorWriteEnable
isVK_FALSE
, thecolorWriteMask
is ignored and writes to all components of the attachment are disabled. This is equivalent to specifying acolorWriteMask
of 0.
Valid Usage
VUID-VkPipelineColorWriteCreateInfoEXT-pAttachments-04801
If the colorWriteEnable
feature is
not enabled, all elements of pColorWriteEnables
must be
VK_TRUE
VUID-VkPipelineColorWriteCreateInfoEXT-attachmentCount-07608
If the pipeline is being created with
VK_DYNAMIC_STATE_COLOR_BLEND_ADVANCED_EXT
,
VK_DYNAMIC_STATE_COLOR_BLEND_ENABLE_EXT
,
VK_DYNAMIC_STATE_COLOR_BLEND_EQUATION_EXT
, or
VK_DYNAMIC_STATE_COLOR_WRITE_MASK_EXT
dynamic states not set,
attachmentCount
must be equal to the attachmentCount
member
of the VkPipelineColorBlendStateCreateInfo
structure specified
during pipeline creation
VUID-VkPipelineColorWriteCreateInfoEXT-attachmentCount-06655
attachmentCount
must be less than or equal to the
maxColorAttachments
member of VkPhysicalDeviceLimits
Valid Usage (Implicit)
VUID-VkPipelineColorWriteCreateInfoEXT-sType-sType
sType
must be VK_STRUCTURE_TYPE_PIPELINE_COLOR_WRITE_CREATE_INFO_EXT
VUID-VkPipelineColorWriteCreateInfoEXT-pColorWriteEnables-parameter
If attachmentCount
is not 0
, pColorWriteEnables
must be a valid pointer to an array of attachmentCount
VkBool32 values