public class VkAttachmentDescription2KHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
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 format is a depth/stencil format, and initialLayout only specifies the initial layout of the depth aspect of the attachment, the initial layout of the stencil aspect is specified by the stencilInitialLayout member of a VkAttachmentDescriptionStencilLayoutKHR structure included in the pNext chain. Otherwise, initialLayout describes the initial layout for all relevant image aspects.
If format is a depth/stencil format, and finalLayout only specifies the final layout of the depth aspect of the attachment, the final layout of the stencil aspect is specified by the stencilFinalLayout member of a VkAttachmentDescriptionStencilLayoutKHR structure included in the pNext chain. Otherwise, finalLayout describes the final layout for all relevant image aspects.
finalLayout must not be IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZEDformat is a color format, name:initialLayout must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMALformat is a depth/stencil format, name:initialLayout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMALformat is a color format, name:finalLayout must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMALformat is a depth/stencil format, name:finalLayout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMALseparateDepthStencilLayouts feature is not enabled, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHRseparateDepthStencilLayouts feature is not enabled, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHRformat is a color format, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHRformat is a color format, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHRformat is a depth/stencil format which includes both depth and stencil aspects, and initialLayout is IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, the pNext chain must include a VkAttachmentDescriptionStencilLayoutKHR structureformat is a depth/stencil format which includes both depth and stencil aspects, and finalLayout is IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, the pNext chain must include a VkAttachmentDescriptionStencilLayoutKHR structureformat is a depth/stencil format which includes only the depth aspect, initialLayout must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHRformat is a depth/stencil format which includes only the depth aspect, finalLayout must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHRformat is a depth/stencil format which includes only the stencil aspect, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHRformat is a depth/stencil format which includes only the stencil aspect, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHRsType must be STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2_KHRflags must be a valid combination of VkAttachmentDescriptionFlagBits valuesformat must be a valid VkFormat valuesamples must be a valid VkSampleCountFlagBits valueloadOp must be a valid VkAttachmentLoadOp valuestoreOp must be a valid VkAttachmentStoreOp valuestencilLoadOp must be a valid VkAttachmentLoadOp valuestencilStoreOp must be a valid VkAttachmentStoreOp valueinitialLayout must be a valid VkImageLayout valuefinalLayout must be a valid VkImageLayout valuesType – the type of this structure.pNext – NULL or a pointer to an extension-specific structure.flags – a bitmask of VkAttachmentDescriptionFlagBits specifying additional properties of the attachment.format – a VkFormat value specifying the format of the image that will be used for the attachment.samples – the number of samples of the image as defined in VkSampleCountFlagBits.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.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.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.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.initialLayout – the layout the attachment image subresource will be in when a render pass instance begins.finalLayout – the layout the attachment image subresource will be transitioned to when a render pass instance ends.
struct VkAttachmentDescription2KHR {
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 |
|---|---|
static class |
VkAttachmentDescription2KHR.Buffer
An array of
VkAttachmentDescription2KHR structs. |
| Modifier and Type | Field and Description |
|---|---|
static int |
ALIGNOF
The struct alignment in bytes.
|
static int |
FINALLAYOUT
The struct member offsets.
|
static int |
FLAGS
The struct member offsets.
|
static int |
FORMAT
The struct member offsets.
|
static int |
INITIALLAYOUT
The struct member offsets.
|
static int |
LOADOP
The struct member offsets.
|
static int |
PNEXT
The struct member offsets.
|
static int |
SAMPLES
The struct member offsets.
|
static int |
SIZEOF
The struct size in bytes.
|
static int |
STENCILLOADOP
The struct member offsets.
|
static int |
STENCILSTOREOP
The struct member offsets.
|
static int |
STOREOP
The struct member offsets.
|
static int |
STYPE
The struct member offsets.
|
| Constructor and Description |
|---|
VkAttachmentDescription2KHR(java.nio.ByteBuffer container)
Creates a
VkAttachmentDescription2KHR instance at the current position of the specified ByteBuffer container. |
| Modifier and Type | Method and Description |
|---|---|
static VkAttachmentDescription2KHR |
calloc()
Returns a new
VkAttachmentDescription2KHR instance allocated with memCalloc. |
static VkAttachmentDescription2KHR.Buffer |
calloc(int capacity)
Returns a new
VkAttachmentDescription2KHR.Buffer instance allocated with memCalloc. |
static VkAttachmentDescription2KHR |
callocStack()
Returns a new
VkAttachmentDescription2KHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero. |
static VkAttachmentDescription2KHR.Buffer |
callocStack(int capacity)
Returns a new
VkAttachmentDescription2KHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero. |
static VkAttachmentDescription2KHR.Buffer |
callocStack(int capacity,
org.lwjgl.system.MemoryStack stack)
Returns a new
VkAttachmentDescription2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero. |
static VkAttachmentDescription2KHR |
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a new
VkAttachmentDescription2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero. |
static VkAttachmentDescription2KHR |
create()
Returns a new
VkAttachmentDescription2KHR instance allocated with BufferUtils. |
static VkAttachmentDescription2KHR.Buffer |
create(int capacity)
Returns a new
VkAttachmentDescription2KHR.Buffer instance allocated with BufferUtils. |
static VkAttachmentDescription2KHR |
create(long address)
Returns a new
VkAttachmentDescription2KHR instance for the specified memory address. |
static VkAttachmentDescription2KHR.Buffer |
create(long address,
int capacity)
Create a
VkAttachmentDescription2KHR.Buffer instance at the specified memory. |
static VkAttachmentDescription2KHR |
createSafe(long address)
|
static VkAttachmentDescription2KHR.Buffer |
createSafe(long address,
int capacity)
|
int |
finalLayout()
Returns the value of the
finalLayout field. |
VkAttachmentDescription2KHR |
finalLayout(int value)
Sets the specified value to the
finalLayout field. |
int |
flags()
Returns the value of the
flags field. |
VkAttachmentDescription2KHR |
flags(int value)
Sets the specified value to the
flags field. |
int |
format()
Returns the value of the
format field. |
VkAttachmentDescription2KHR |
format(int value)
Sets the specified value to the
format field. |
int |
initialLayout()
Returns the value of the
initialLayout field. |
VkAttachmentDescription2KHR |
initialLayout(int value)
Sets the specified value to the
initialLayout field. |
int |
loadOp()
Returns the value of the
loadOp field. |
VkAttachmentDescription2KHR |
loadOp(int value)
Sets the specified value to the
loadOp field. |
static VkAttachmentDescription2KHR |
malloc()
Returns a new
VkAttachmentDescription2KHR instance allocated with memAlloc. |
static VkAttachmentDescription2KHR.Buffer |
malloc(int capacity)
Returns a new
VkAttachmentDescription2KHR.Buffer instance allocated with memAlloc. |
static VkAttachmentDescription2KHR |
mallocStack()
Returns a new
VkAttachmentDescription2KHR instance allocated on the thread-local MemoryStack. |
static VkAttachmentDescription2KHR.Buffer |
mallocStack(int capacity)
Returns a new
VkAttachmentDescription2KHR.Buffer instance allocated on the thread-local MemoryStack. |
static VkAttachmentDescription2KHR.Buffer |
mallocStack(int capacity,
org.lwjgl.system.MemoryStack stack)
Returns a new
VkAttachmentDescription2KHR.Buffer instance allocated on the specified MemoryStack. |
static VkAttachmentDescription2KHR |
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a new
VkAttachmentDescription2KHR instance allocated on the specified MemoryStack. |
static int |
nfinalLayout(long struct)
Unsafe version of
finalLayout(). |
static void |
nfinalLayout(long struct,
int value)
Unsafe version of
finalLayout. |
static int |
nflags(long struct)
Unsafe version of
flags(). |
static void |
nflags(long struct,
int value)
Unsafe version of
flags. |
static int |
nformat(long struct)
Unsafe version of
format(). |
static void |
nformat(long struct,
int value)
Unsafe version of
format. |
static int |
ninitialLayout(long struct)
Unsafe version of
initialLayout(). |
static void |
ninitialLayout(long struct,
int value)
Unsafe version of
initialLayout. |
static int |
nloadOp(long struct)
Unsafe version of
loadOp(). |
static void |
nloadOp(long struct,
int value)
Unsafe version of
loadOp. |
static long |
npNext(long struct)
Unsafe version of
pNext(). |
static void |
npNext(long struct,
long value)
Unsafe version of
pNext. |
static int |
nsamples(long struct)
Unsafe version of
samples(). |
static void |
nsamples(long struct,
int value)
Unsafe version of
samples. |
static int |
nstencilLoadOp(long struct)
Unsafe version of
stencilLoadOp(). |
static void |
nstencilLoadOp(long struct,
int value)
Unsafe version of
stencilLoadOp. |
static int |
nstencilStoreOp(long struct)
Unsafe version of
stencilStoreOp(). |
static void |
nstencilStoreOp(long struct,
int value)
Unsafe version of
stencilStoreOp. |
static int |
nstoreOp(long struct)
Unsafe version of
storeOp(). |
static void |
nstoreOp(long struct,
int value)
Unsafe version of
storeOp. |
static int |
nsType(long struct)
Unsafe version of
sType(). |
static void |
nsType(long struct,
int value)
Unsafe version of
sType. |
long |
pNext()
Returns the value of the
pNext field. |
VkAttachmentDescription2KHR |
pNext(long value)
Sets the specified value to the
pNext field. |
int |
samples()
Returns the value of the
samples field. |
VkAttachmentDescription2KHR |
samples(int value)
Sets the specified value to the
samples field. |
VkAttachmentDescription2KHR |
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.
|
VkAttachmentDescription2KHR |
set(VkAttachmentDescription2KHR src)
Copies the specified struct data to this struct.
|
int |
sizeof() |
int |
stencilLoadOp()
Returns the value of the
stencilLoadOp field. |
VkAttachmentDescription2KHR |
stencilLoadOp(int value)
Sets the specified value to the
stencilLoadOp field. |
int |
stencilStoreOp()
Returns the value of the
stencilStoreOp field. |
VkAttachmentDescription2KHR |
stencilStoreOp(int value)
Sets the specified value to the
stencilStoreOp field. |
int |
storeOp()
Returns the value of the
storeOp field. |
VkAttachmentDescription2KHR |
storeOp(int value)
Sets the specified value to the
storeOp field. |
int |
sType()
Returns the value of the
sType field. |
VkAttachmentDescription2KHR |
sType(int value)
Sets the specified value to the
sType field. |
public static final int SIZEOF
public static final int ALIGNOF
public static final int STYPE
public static final int PNEXT
public static final int FLAGS
public static final int FORMAT
public static final int SAMPLES
public static final int LOADOP
public static final int STOREOP
public static final int STENCILLOADOP
public static final int STENCILSTOREOP
public static final int INITIALLAYOUT
public static final int FINALLAYOUT
public VkAttachmentDescription2KHR(java.nio.ByteBuffer container)
VkAttachmentDescription2KHR instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be
visible to the struct instance and vice versa.
The created instance holds a strong reference to the container object.
public int sizeof()
sizeof in class org.lwjgl.system.Structpublic int sType()
sType field.public long pNext()
pNext field.public int flags()
flags field.public int format()
format field.public int samples()
samples field.public int loadOp()
loadOp field.public int storeOp()
storeOp field.public int stencilLoadOp()
stencilLoadOp field.public int stencilStoreOp()
stencilStoreOp field.public int initialLayout()
initialLayout field.public int finalLayout()
finalLayout field.public VkAttachmentDescription2KHR sType(int value)
sType field.public VkAttachmentDescription2KHR pNext(long value)
pNext field.public VkAttachmentDescription2KHR flags(int value)
flags field.public VkAttachmentDescription2KHR format(int value)
format field.public VkAttachmentDescription2KHR samples(int value)
samples field.public VkAttachmentDescription2KHR loadOp(int value)
loadOp field.public VkAttachmentDescription2KHR storeOp(int value)
storeOp field.public VkAttachmentDescription2KHR stencilLoadOp(int value)
stencilLoadOp field.public VkAttachmentDescription2KHR stencilStoreOp(int value)
stencilStoreOp field.public VkAttachmentDescription2KHR initialLayout(int value)
initialLayout field.public VkAttachmentDescription2KHR finalLayout(int value)
finalLayout field.public VkAttachmentDescription2KHR set(int sType, long pNext, int flags, int format, int samples, int loadOp, int storeOp, int stencilLoadOp, int stencilStoreOp, int initialLayout, int finalLayout)
public VkAttachmentDescription2KHR set(VkAttachmentDescription2KHR src)
src - the source structpublic static VkAttachmentDescription2KHR malloc()
VkAttachmentDescription2KHR instance allocated with memAlloc. The instance must be explicitly freed.public static VkAttachmentDescription2KHR calloc()
VkAttachmentDescription2KHR instance allocated with memCalloc. The instance must be explicitly freed.public static VkAttachmentDescription2KHR create()
VkAttachmentDescription2KHR instance allocated with BufferUtils.public static VkAttachmentDescription2KHR create(long address)
VkAttachmentDescription2KHR instance for the specified memory address.@Nullable public static VkAttachmentDescription2KHR createSafe(long address)
public static VkAttachmentDescription2KHR.Buffer malloc(int capacity)
VkAttachmentDescription2KHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.capacity - the buffer capacitypublic static VkAttachmentDescription2KHR.Buffer calloc(int capacity)
VkAttachmentDescription2KHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.capacity - the buffer capacitypublic static VkAttachmentDescription2KHR.Buffer create(int capacity)
VkAttachmentDescription2KHR.Buffer instance allocated with BufferUtils.capacity - the buffer capacitypublic static VkAttachmentDescription2KHR.Buffer create(long address, int capacity)
VkAttachmentDescription2KHR.Buffer instance at the specified memory.address - the memory addresscapacity - the buffer capacity@Nullable public static VkAttachmentDescription2KHR.Buffer createSafe(long address, int capacity)
public static VkAttachmentDescription2KHR mallocStack()
VkAttachmentDescription2KHR instance allocated on the thread-local MemoryStack.public static VkAttachmentDescription2KHR callocStack()
VkAttachmentDescription2KHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.public static VkAttachmentDescription2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
VkAttachmentDescription2KHR instance allocated on the specified MemoryStack.stack - the stack from which to allocatepublic static VkAttachmentDescription2KHR callocStack(org.lwjgl.system.MemoryStack stack)
VkAttachmentDescription2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.stack - the stack from which to allocatepublic static VkAttachmentDescription2KHR.Buffer mallocStack(int capacity)
VkAttachmentDescription2KHR.Buffer instance allocated on the thread-local MemoryStack.capacity - the buffer capacitypublic static VkAttachmentDescription2KHR.Buffer callocStack(int capacity)
VkAttachmentDescription2KHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.capacity - the buffer capacitypublic static VkAttachmentDescription2KHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
VkAttachmentDescription2KHR.Buffer instance allocated on the specified MemoryStack.stack - the stack from which to allocatecapacity - the buffer capacitypublic static VkAttachmentDescription2KHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
VkAttachmentDescription2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.stack - the stack from which to allocatecapacity - the buffer capacitypublic static int nsType(long struct)
sType().public static long npNext(long struct)
pNext().public static int nflags(long struct)
flags().public static int nformat(long struct)
format().public static int nsamples(long struct)
samples().public static int nloadOp(long struct)
loadOp().public static int nstoreOp(long struct)
storeOp().public static int nstencilLoadOp(long struct)
stencilLoadOp().public static int nstencilStoreOp(long struct)
stencilStoreOp().public static int ninitialLayout(long struct)
initialLayout().public static int nfinalLayout(long struct)
finalLayout().public static void nsType(long struct,
int value)
sType.public static void npNext(long struct,
long value)
pNext.public static void nflags(long struct,
int value)
flags.public static void nformat(long struct,
int value)
format.public static void nsamples(long struct,
int value)
samples.public static void nloadOp(long struct,
int value)
loadOp.public static void nstoreOp(long struct,
int value)
storeOp.public static void nstencilLoadOp(long struct,
int value)
stencilLoadOp.public static void nstencilStoreOp(long struct,
int value)
stencilStoreOp.public static void ninitialLayout(long struct,
int value)
initialLayout.public static void nfinalLayout(long struct,
int value)
finalLayout.Copyright LWJGL. All Rights Reserved. License terms.