VkAttachmentReferenceStencilLayout(3)

# VkAttachmentReferenceStencilLayout(3) Manual Page

## Name

VkAttachmentReferenceStencilLayout - Structure specifying an attachment description

Loading… please wait.

## C Specification

The `VkAttachmentReferenceStencilLayout` structure is defined as:

    // Provided by VK_VERSION_1_2
    typedef struct VkAttachmentReferenceStencilLayout {
        VkStructureType    sType;
        void*              pNext;
        VkImageLayout      stencilLayout;
    } VkAttachmentReferenceStencilLayout;

or the equivalent

    // Provided by VK_KHR_separate_depth_stencil_layouts
    typedef VkAttachmentReferenceStencilLayout VkAttachmentReferenceStencilLayoutKHR;

## Members

- `sType` is the type of this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `stencilLayout` is a VkImageLayout value specifying the layout the stencil aspect of the attachment uses during the subpass.

## Description

Valid Usage

- VUID-VkAttachmentReferenceStencilLayout-stencilLayout-03318
  `stencilLayout` must not be `VK_IMAGE_LAYOUT_UNDEFINED`, `VK_IMAGE_LAYOUT_PREINITIALIZED`, `VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL`, `VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL`, `VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL`, `VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL`, `VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL`, `VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL`, `VK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL`, or `VK_IMAGE_LAYOUT_PRESENT_SRC_KHR`

Valid Usage (Implicit)

- VUID-VkAttachmentReferenceStencilLayout-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_STENCIL_LAYOUT`

- VUID-VkAttachmentReferenceStencilLayout-stencilLayout-parameter
  `stencilLayout` must be a valid VkImageLayout value

## See Also

VkImageLayout, VkStructureType

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright (c) 2014-2020 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0