Package org.lwjgl.vulkan
Class VkAttachmentDescription2KHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkAttachmentDescription2KHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkAttachmentDescription2KHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying an attachment description.Description
Parameters defined by this structure with the same name as those in
VkAttachmentDescriptionhave the identical effect to those parameters.Valid Usage
finalLayoutmust not beIMAGE_LAYOUT_UNDEFINEDorIMAGE_LAYOUT_PREINITIALIZED
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2_KHRflagsmust be a valid combination ofVkAttachmentDescriptionFlagBitsvaluesformatmust be a validVkFormatvaluesamplesmust be a validVkSampleCountFlagBitsvalueloadOpmust be a validVkAttachmentLoadOpvaluestoreOpmust be a validVkAttachmentStoreOpvaluestencilLoadOpmust be a validVkAttachmentLoadOpvaluestencilStoreOpmust be a validVkAttachmentStoreOpvalueinitialLayoutmust be a validVkImageLayoutvaluefinalLayoutmust be a validVkImageLayoutvalue
See Also
Member documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.flags– a bitmask ofVkAttachmentDescriptionFlagBitsspecifying additional properties of the attachment.format– aVkFormatvalue specifying the format of the image that will be used for the attachment.samples– the number of samples of the image as defined inVkSampleCountFlagBits.loadOp– aVkAttachmentLoadOpvalue 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– aVkAttachmentStoreOpvalue 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– aVkAttachmentLoadOpvalue specifying how the contents of stencil components of the attachment are treated at the beginning of the subpass where it is first used.stencilStoreOp– aVkAttachmentStoreOpvalue 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.
Layout
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; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkAttachmentDescription2KHR.BufferAn array ofVkAttachmentDescription2KHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intFINALLAYOUT
FLAGS
FORMAT
INITIALLAYOUT
LOADOP
PNEXT
SAMPLESThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTENCILLOADOP
STENCILSTOREOP
STOREOP
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkAttachmentDescription2KHR(java.nio.ByteBuffer container)Creates aVkAttachmentDescription2KHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkAttachmentDescription2KHRcalloc()Returns a newVkAttachmentDescription2KHRinstance allocated withmemCalloc.static VkAttachmentDescription2KHR.Buffercalloc(int capacity)Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated withmemCalloc.static VkAttachmentDescription2KHRcallocStack()Returns a newVkAttachmentDescription2KHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkAttachmentDescription2KHR.BuffercallocStack(int capacity)Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkAttachmentDescription2KHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkAttachmentDescription2KHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentDescription2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkAttachmentDescription2KHRcreate()Returns a newVkAttachmentDescription2KHRinstance allocated withBufferUtils.static VkAttachmentDescription2KHR.Buffercreate(int capacity)Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated withBufferUtils.static VkAttachmentDescription2KHRcreate(long address)Returns a newVkAttachmentDescription2KHRinstance for the specified memory address.static VkAttachmentDescription2KHR.Buffercreate(long address, int capacity)Create aVkAttachmentDescription2KHR.Bufferinstance at the specified memory.static VkAttachmentDescription2KHRcreateSafe(long address)static VkAttachmentDescription2KHR.BuffercreateSafe(long address, int capacity)intfinalLayout()Returns the value of thefinalLayoutfield.VkAttachmentDescription2KHRfinalLayout(int value)Sets the specified value to thefinalLayoutfield.intflags()Returns the value of theflagsfield.VkAttachmentDescription2KHRflags(int value)Sets the specified value to theflagsfield.intformat()Returns the value of theformatfield.VkAttachmentDescription2KHRformat(int value)Sets the specified value to theformatfield.intinitialLayout()Returns the value of theinitialLayoutfield.VkAttachmentDescription2KHRinitialLayout(int value)Sets the specified value to theinitialLayoutfield.intloadOp()Returns the value of theloadOpfield.VkAttachmentDescription2KHRloadOp(int value)Sets the specified value to theloadOpfield.static VkAttachmentDescription2KHRmalloc()Returns a newVkAttachmentDescription2KHRinstance allocated withmemAlloc.static VkAttachmentDescription2KHR.Buffermalloc(int capacity)Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated withmemAlloc.static VkAttachmentDescription2KHRmallocStack()Returns a newVkAttachmentDescription2KHRinstance allocated on the thread-localMemoryStack.static VkAttachmentDescription2KHR.BuffermallocStack(int capacity)Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated on the thread-localMemoryStack.static VkAttachmentDescription2KHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated on the specifiedMemoryStack.static VkAttachmentDescription2KHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentDescription2KHRinstance allocated on the specifiedMemoryStack.static intnfinalLayout(long struct)Unsafe version offinalLayout().static voidnfinalLayout(long struct, int value)Unsafe version offinalLayout.static intnflags(long struct)Unsafe version offlags().static voidnflags(long struct, int value)Unsafe version offlags.static intnformat(long struct)Unsafe version offormat().static voidnformat(long struct, int value)Unsafe version offormat.static intninitialLayout(long struct)Unsafe version ofinitialLayout().static voidninitialLayout(long struct, int value)Unsafe version ofinitialLayout.static intnloadOp(long struct)Unsafe version ofloadOp().static voidnloadOp(long struct, int value)Unsafe version ofloadOp.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsamples(long struct)Unsafe version ofsamples().static voidnsamples(long struct, int value)Unsafe version ofsamples.static intnstencilLoadOp(long struct)Unsafe version ofstencilLoadOp().static voidnstencilLoadOp(long struct, int value)Unsafe version ofstencilLoadOp.static intnstencilStoreOp(long struct)Unsafe version ofstencilStoreOp().static voidnstencilStoreOp(long struct, int value)Unsafe version ofstencilStoreOp.static intnstoreOp(long struct)Unsafe version ofstoreOp().static voidnstoreOp(long struct, int value)Unsafe version ofstoreOp.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()Returns the value of thepNextfield.VkAttachmentDescription2KHRpNext(long value)Sets the specified value to thepNextfield.intsamples()Returns the value of thesamplesfield.VkAttachmentDescription2KHRsamples(int value)Sets the specified value to thesamplesfield.VkAttachmentDescription2KHRset(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.VkAttachmentDescription2KHRset(VkAttachmentDescription2KHR src)Copies the specified struct data to this struct.intsizeof()intstencilLoadOp()Returns the value of thestencilLoadOpfield.VkAttachmentDescription2KHRstencilLoadOp(int value)Sets the specified value to thestencilLoadOpfield.intstencilStoreOp()Returns the value of thestencilStoreOpfield.VkAttachmentDescription2KHRstencilStoreOp(int value)Sets the specified value to thestencilStoreOpfield.intstoreOp()Returns the value of thestoreOpfield.VkAttachmentDescription2KHRstoreOp(int value)Sets the specified value to thestoreOpfield.intsType()Returns the value of thesTypefield.VkAttachmentDescription2KHRsType(int value)Sets the specified value to thesTypefield.
-
-
-
Constructor Detail
-
VkAttachmentDescription2KHR
public VkAttachmentDescription2KHR(java.nio.ByteBuffer container)
Creates aVkAttachmentDescription2KHRinstance at the current position of the specifiedByteBuffercontainer. 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.
-
-
Method Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
format
public int format()
Returns the value of theformatfield.
-
samples
public int samples()
Returns the value of thesamplesfield.
-
loadOp
public int loadOp()
Returns the value of theloadOpfield.
-
storeOp
public int storeOp()
Returns the value of thestoreOpfield.
-
stencilLoadOp
public int stencilLoadOp()
Returns the value of thestencilLoadOpfield.
-
stencilStoreOp
public int stencilStoreOp()
Returns the value of thestencilStoreOpfield.
-
initialLayout
public int initialLayout()
Returns the value of theinitialLayoutfield.
-
finalLayout
public int finalLayout()
Returns the value of thefinalLayoutfield.
-
sType
public VkAttachmentDescription2KHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkAttachmentDescription2KHR pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkAttachmentDescription2KHR flags(int value)
Sets the specified value to theflagsfield.
-
format
public VkAttachmentDescription2KHR format(int value)
Sets the specified value to theformatfield.
-
samples
public VkAttachmentDescription2KHR samples(int value)
Sets the specified value to thesamplesfield.
-
loadOp
public VkAttachmentDescription2KHR loadOp(int value)
Sets the specified value to theloadOpfield.
-
storeOp
public VkAttachmentDescription2KHR storeOp(int value)
Sets the specified value to thestoreOpfield.
-
stencilLoadOp
public VkAttachmentDescription2KHR stencilLoadOp(int value)
Sets the specified value to thestencilLoadOpfield.
-
stencilStoreOp
public VkAttachmentDescription2KHR stencilStoreOp(int value)
Sets the specified value to thestencilStoreOpfield.
-
initialLayout
public VkAttachmentDescription2KHR initialLayout(int value)
Sets the specified value to theinitialLayoutfield.
-
finalLayout
public VkAttachmentDescription2KHR finalLayout(int value)
Sets the specified value to thefinalLayoutfield.
-
set
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)
Initializes this struct with the specified values.
-
set
public VkAttachmentDescription2KHR set(VkAttachmentDescription2KHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkAttachmentDescription2KHR malloc()
Returns a newVkAttachmentDescription2KHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkAttachmentDescription2KHR calloc()
Returns a newVkAttachmentDescription2KHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkAttachmentDescription2KHR create()
Returns a newVkAttachmentDescription2KHRinstance allocated withBufferUtils.
-
create
public static VkAttachmentDescription2KHR create(long address)
Returns a newVkAttachmentDescription2KHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkAttachmentDescription2KHR createSafe(long address)
-
malloc
public static VkAttachmentDescription2KHR.Buffer malloc(int capacity)
Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkAttachmentDescription2KHR.Buffer calloc(int capacity)
Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkAttachmentDescription2KHR.Buffer create(int capacity)
Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkAttachmentDescription2KHR.Buffer create(long address, int capacity)
Create aVkAttachmentDescription2KHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkAttachmentDescription2KHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkAttachmentDescription2KHR mallocStack()
Returns a newVkAttachmentDescription2KHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkAttachmentDescription2KHR callocStack()
Returns a newVkAttachmentDescription2KHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkAttachmentDescription2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentDescription2KHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkAttachmentDescription2KHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentDescription2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkAttachmentDescription2KHR.Buffer mallocStack(int capacity)
Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkAttachmentDescription2KHR.Buffer callocStack(int capacity)
Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkAttachmentDescription2KHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkAttachmentDescription2KHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentDescription2KHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nflags
public static int nflags(long struct)
Unsafe version offlags().
-
nformat
public static int nformat(long struct)
Unsafe version offormat().
-
nsamples
public static int nsamples(long struct)
Unsafe version ofsamples().
-
nloadOp
public static int nloadOp(long struct)
Unsafe version ofloadOp().
-
nstoreOp
public static int nstoreOp(long struct)
Unsafe version ofstoreOp().
-
nstencilLoadOp
public static int nstencilLoadOp(long struct)
Unsafe version ofstencilLoadOp().
-
nstencilStoreOp
public static int nstencilStoreOp(long struct)
Unsafe version ofstencilStoreOp().
-
ninitialLayout
public static int ninitialLayout(long struct)
Unsafe version ofinitialLayout().
-
nfinalLayout
public static int nfinalLayout(long struct)
Unsafe version offinalLayout().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nflags
public static void nflags(long struct, int value)Unsafe version offlags.
-
nformat
public static void nformat(long struct, int value)Unsafe version offormat.
-
nsamples
public static void nsamples(long struct, int value)Unsafe version ofsamples.
-
nloadOp
public static void nloadOp(long struct, int value)Unsafe version ofloadOp.
-
nstoreOp
public static void nstoreOp(long struct, int value)Unsafe version ofstoreOp.
-
nstencilLoadOp
public static void nstencilLoadOp(long struct, int value)Unsafe version ofstencilLoadOp.
-
nstencilStoreOp
public static void nstencilStoreOp(long struct, int value)Unsafe version ofstencilStoreOp.
-
ninitialLayout
public static void ninitialLayout(long struct, int value)Unsafe version ofinitialLayout.
-
nfinalLayout
public static void nfinalLayout(long struct, int value)Unsafe version offinalLayout.
-
-