LWJGL 3.3.3 · org.lwjgl.vulkan.VkAttachmentDescription2

Structure specifying an attachment description.

Description

Parameters defined by this structure with the same name as those in VkAttachmentDescription have the identical effect to those parameters.

If the separateDepthStencilLayouts feature is enabled, and format is a depth/stencil format, initialLayout and finalLayout can be set to a layout that only specifies the layout of the depth aspect.

If the pNext chain includes a VkAttachmentDescriptionStencilLayout structure, then the stencilInitialLayout and stencilFinalLayout members specify the initial and final layouts of the stencil aspect of a depth/stencil format, and initialLayout and finalLayout only apply to the depth aspect. For depth-only formats, the VkAttachmentDescriptionStencilLayout structure is ignored. For stencil-only formats, the initial and final layouts of the stencil aspect are taken from the VkAttachmentDescriptionStencilLayout structure if present, or initialLayout and finalLayout if not present.

If format is a depth/stencil format, and either initialLayout or finalLayout does not specify a layout for the stencil aspect, then the application must specify the initial and final layouts of the stencil aspect by including a VkAttachmentDescriptionStencilLayout structure in the pNext chain.

Valid Usage

format must not be FORMAT_UNDEFINED
If format includes a color or depth component and loadOp is ATTACHMENT_LOAD_OP_LOAD, then initialLayout must not be IMAGE_LAYOUT_UNDEFINED
finalLayout must not be IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED
If format is a color format, initialLayout must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format, initialLayout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
If format is a color format, finalLayout must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format, finalLayout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
If format is a color format, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
If format is a color format, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
If the separateDepthStencilLayouts feature is not enabled, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL,
If the separateDepthStencilLayouts feature is not enabled, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL,
If format is a color format, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a color format, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format which includes both depth and stencil components, initialLayout must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format which includes both depth and stencil components, finalLayout must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format which includes only the depth component, initialLayout must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If format is a depth/stencil format which includes only the depth component, finalLayout must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If the synchronization2 feature is not enabled, initialLayout must not be IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
If the synchronization2 feature is not enabled, finalLayout must not be IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
If the attachmentFeedbackLoopLayout feature is not enabled, initialLayout must not be IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT
If the attachmentFeedbackLoopLayout feature is not enabled, finalLayout must not be IMAGE_LAYOUT_ATTACHMENT_FEEDBACK_LOOP_OPTIMAL_EXT
samples must be a bit value that is set in imageCreateSampleCounts (as defined in Image Creation Limits) for the given format
If the pNext chain does not include a VkAttachmentDescriptionStencilLayout structure, format includes a stencil component, and stencilLoadOp is ATTACHMENT_LOAD_OP_LOAD, then initialLayout must not be IMAGE_LAYOUT_UNDEFINED
If the pNext chain does includes a VkAttachmentDescriptionStencilLayout structure, format includes a stencil component, and stencilLoadOp is ATTACHMENT_LOAD_OP_LOAD, then VkAttachmentDescriptionStencilLayout::stencilInitialLayout must not be IMAGE_LAYOUT_UNDEFINED
If format is a depth/stencil format which includes both depth and stencil components, and initialLayout is IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, the pNext chain must include a VkAttachmentDescriptionStencilLayout structure
If format is a depth/stencil format which includes both depth and stencil components, and finalLayout is IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, the pNext chain must include a VkAttachmentDescriptionStencilLayout structure
If the pNext chain does not include a VkAttachmentDescriptionStencilLayout structure and format only includes a stencil component, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
If the pNext chain does not include a VkAttachmentDescriptionStencilLayout structure and format only includes a stencil component, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2
pNext must be NULL or a pointer to a valid instance of VkAttachmentDescriptionStencilLayout
The sType value of each struct in the pNext chain must be unique
flags must be a valid combination of VkAttachmentDescriptionFlagBits values
format must be a valid VkFormat value
samples must be a valid VkSampleCountFlagBits value
loadOp must be a valid VkAttachmentLoadOp value
storeOp must be a valid VkAttachmentStoreOp value
stencilLoadOp must be a valid VkAttachmentLoadOp value
stencilStoreOp must be a valid VkAttachmentStoreOp value
initialLayout must be a valid VkImageLayout value
finalLayout must be a valid VkImageLayout value

Layout


struct VkAttachmentDescription2 {
    VkStructureType sType;
    void const * pNext;
    VkAttachmentDescriptionFlags flags;
    VkFormat format;
    VkSampleCountFlagBits samples;
    VkAttachmentLoadOp loadOp;
    VkAttachmentStoreOp storeOp;
    VkAttachmentLoadOp stencilLoadOp;
    VkAttachmentStoreOp stencilStoreOp;
    VkImageLayout initialLayout;
    VkImageLayout finalLayout;
}

Modifier and Type	Class and Description
public static class	VkAttachmentDescription2.Buffer An array of `VkAttachmentDescription2` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FINALLAYOUT The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	FORMAT The struct member offsets.
public static final int	INITIALLAYOUT The struct member offsets.
public static final int	LOADOP The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SAMPLES The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STENCILLOADOP The struct member offsets.
public static final int	STENCILSTOREOP The struct member offsets.
public static final int	STOREOP The struct member offsets.
public static final int	STYPE The struct member offsets.

Access	Constructor and Description
protected	VkAttachmentDescription2(long address, ByteBuffer container)
public	VkAttachmentDescription2(ByteBuffer container) Creates a `VkAttachmentDescription2` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkAttachmentDescription2	calloc() Returns a new `VkAttachmentDescription2` instance allocated with `memCalloc`.
public static VkAttachmentDescription2.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkAttachmentDescription2.Buffer` instance allocated with `memCalloc`.
public static VkAttachmentDescription2	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkAttachmentDescription2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkAttachmentDescription2.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkAttachmentDescription2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkAttachmentDescription2	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkAttachmentDescription2	create() Returns a new `VkAttachmentDescription2` instance allocated with `BufferUtils`.
public static VkAttachmentDescription2	create(long address) Returns a new `VkAttachmentDescription2` instance for the specified memory address.
public static VkAttachmentDescription2.Buffer	create(int the buffer capacity capacity) Returns a new `VkAttachmentDescription2.Buffer` instance allocated with `BufferUtils`.
public static VkAttachmentDescription2.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkAttachmentDescription2.Buffer` instance at the specified memory.
public static VkAttachmentDescription2	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkAttachmentDescription2.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	finalLayout() the layout the attachment image subresource will be transitioned to when a render pass instance ends.
public VkAttachmentDescription2	finalLayout(int value) Sets the specified value to the `finalLayout` field.
public int	flags() a bitmask of `VkAttachmentDescriptionFlagBits` specifying additional properties of the attachment.
public VkAttachmentDescription2	flags(int value) Sets the specified value to the `flags` field.
public int	format() a `VkFormat` value specifying the format of the image that will be used for the attachment.
public VkAttachmentDescription2	format(int value) Sets the specified value to the `format` field.
public int	initialLayout() the layout the attachment image subresource will be in when a render pass instance begins.
public VkAttachmentDescription2	initialLayout(int value) Sets the specified value to the `initialLayout` field.
public int	loadOp() a `VkAttachmentLoadOp` value specifying how the contents of color and depth components of the attachment are treated at the beginning of the subpass where it is first used.
public VkAttachmentDescription2	loadOp(int value) Sets the specified value to the `loadOp` field.
public static VkAttachmentDescription2	malloc() Returns a new `VkAttachmentDescription2` instance allocated with `memAlloc`.
public static VkAttachmentDescription2.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkAttachmentDescription2.Buffer` instance allocated with `memAlloc`.
public static VkAttachmentDescription2	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkAttachmentDescription2` instance allocated on the specified `MemoryStack`.
public static VkAttachmentDescription2.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkAttachmentDescription2.Buffer` instance allocated on the specified `MemoryStack`.
public static int	nfinalLayout(long struct) Unsafe version of `finalLayout`.
public static void	nfinalLayout(long struct, int value) Unsafe version of `finalLayout`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static int	nformat(long struct) Unsafe version of `format`.
public static void	nformat(long struct, int value) Unsafe version of `format`.
public static int	ninitialLayout(long struct) Unsafe version of `initialLayout`.
public static void	ninitialLayout(long struct, int value) Unsafe version of `initialLayout`.
public static int	nloadOp(long struct) Unsafe version of `loadOp`.
public static void	nloadOp(long struct, int value) Unsafe version of `loadOp`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nsamples(long struct) Unsafe version of `samples`.
public static void	nsamples(long struct, int value) Unsafe version of `samples`.
public static int	nstencilLoadOp(long struct) Unsafe version of `stencilLoadOp`.
public static void	nstencilLoadOp(long struct, int value) Unsafe version of `stencilLoadOp`.
public static int	nstencilStoreOp(long struct) Unsafe version of `stencilStoreOp`.
public static void	nstencilStoreOp(long struct, int value) Unsafe version of `stencilStoreOp`.
public static int	nstoreOp(long struct) Unsafe version of `storeOp`.
public static void	nstoreOp(long struct, int value) Unsafe version of `storeOp`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkAttachmentDescription2	pNext(long value) Sets the specified value to the `pNext` field.
public VkAttachmentDescription2	pNext(VkAttachmentDescriptionStencilLayout value) Prepends the specified `VkAttachmentDescriptionStencilLayout` value to the `pNext` chain.
public VkAttachmentDescription2	pNext(VkAttachmentDescriptionStencilLayoutKHR value) Prepends the specified `VkAttachmentDescriptionStencilLayoutKHR` value to the `pNext` chain.
public int	samples() a `VkSampleCountFlagBits` value specifying the number of samples of the image.
public VkAttachmentDescription2	samples(int value) Sets the specified value to the `samples` field.
public VkAttachmentDescription2	set(int sType, long pNext, int flags, int format, int samples, int loadOp, int storeOp, int stencilLoadOp, int stencilStoreOp, int initialLayout, int finalLayout) Initializes this struct with the specified values.
public VkAttachmentDescription2	Returns: this struct set(VkAttachmentDescription2 the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	stencilLoadOp() a `VkAttachmentLoadOp` value specifying how the contents of stencil components of the attachment are treated at the beginning of the subpass where it is first used.
public VkAttachmentDescription2	stencilLoadOp(int value) Sets the specified value to the `stencilLoadOp` field.
public int	stencilStoreOp() a `VkAttachmentStoreOp` value specifying how the contents of stencil components of the attachment are treated at the end of the last subpass where it is used.
public VkAttachmentDescription2	stencilStoreOp(int value) Sets the specified value to the `stencilStoreOp` field.
public int	storeOp() a `VkAttachmentStoreOp` value specifying how the contents of color and depth components of the attachment are treated at the end of the subpass where it is last used.
public VkAttachmentDescription2	storeOp(int value) Sets the specified value to the `storeOp` field.
public int	sType() a `VkStructureType` value identifying this structure.
public VkAttachmentDescription2	sType(int value) Sets the specified value to the `sType` field.
public VkAttachmentDescription2	sType$Default() Sets the `STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2` value to the `sType` field.

public Class VkAttachmentDescription2

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary