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.NativeResource
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.Valid Usage
finalLayout
must not beIMAGE_LAYOUT_UNDEFINED
orIMAGE_LAYOUT_PREINITIALIZED
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2_KHR
flags
must be a valid combination ofVkAttachmentDescriptionFlagBits
valuesformat
must be a validVkFormat
valuesamples
must be a validVkSampleCountFlagBits
valueloadOp
must be a validVkAttachmentLoadOp
valuestoreOp
must be a validVkAttachmentStoreOp
valuestencilLoadOp
must be a validVkAttachmentLoadOp
valuestencilStoreOp
must be a validVkAttachmentStoreOp
valueinitialLayout
must be a validVkImageLayout
valuefinalLayout
must be a validVkImageLayout
value
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.flags
– a bitmask ofVkAttachmentDescriptionFlagBits
specifying additional properties of the attachment.format
– aVkFormat
value 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
– aVkAttachmentLoadOp
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
– aVkAttachmentStoreOp
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
– aVkAttachmentLoadOp
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
– aVkAttachmentStoreOp
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.
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 class
VkAttachmentDescription2KHR.Buffer
An array ofVkAttachmentDescription2KHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
FINALLAYOUT
FLAGS
FORMAT
INITIALLAYOUT
LOADOP
PNEXT
SAMPLESThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STENCILLOADOP
STENCILSTOREOP
STOREOP
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkAttachmentDescription2KHR(java.nio.ByteBuffer container)
Creates aVkAttachmentDescription2KHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkAttachmentDescription2KHR
calloc()
Returns a newVkAttachmentDescription2KHR
instance allocated withmemCalloc
.static VkAttachmentDescription2KHR.Buffer
calloc(int capacity)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated withmemCalloc
.static VkAttachmentDescription2KHR
callocStack()
Returns a newVkAttachmentDescription2KHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkAttachmentDescription2KHR.Buffer
callocStack(int capacity)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkAttachmentDescription2KHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkAttachmentDescription2KHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentDescription2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkAttachmentDescription2KHR
create()
Returns a newVkAttachmentDescription2KHR
instance allocated withBufferUtils
.static VkAttachmentDescription2KHR.Buffer
create(int capacity)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated withBufferUtils
.static VkAttachmentDescription2KHR
create(long address)
Returns a newVkAttachmentDescription2KHR
instance for the specified memory address.static VkAttachmentDescription2KHR.Buffer
create(long address, int capacity)
Create aVkAttachmentDescription2KHR.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 thefinalLayout
field.VkAttachmentDescription2KHR
finalLayout(int value)
Sets the specified value to thefinalLayout
field.int
flags()
Returns the value of theflags
field.VkAttachmentDescription2KHR
flags(int value)
Sets the specified value to theflags
field.int
format()
Returns the value of theformat
field.VkAttachmentDescription2KHR
format(int value)
Sets the specified value to theformat
field.int
initialLayout()
Returns the value of theinitialLayout
field.VkAttachmentDescription2KHR
initialLayout(int value)
Sets the specified value to theinitialLayout
field.int
loadOp()
Returns the value of theloadOp
field.VkAttachmentDescription2KHR
loadOp(int value)
Sets the specified value to theloadOp
field.static VkAttachmentDescription2KHR
malloc()
Returns a newVkAttachmentDescription2KHR
instance allocated withmemAlloc
.static VkAttachmentDescription2KHR.Buffer
malloc(int capacity)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated withmemAlloc
.static VkAttachmentDescription2KHR
mallocStack()
Returns a newVkAttachmentDescription2KHR
instance allocated on the thread-localMemoryStack
.static VkAttachmentDescription2KHR.Buffer
mallocStack(int capacity)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkAttachmentDescription2KHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkAttachmentDescription2KHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentDescription2KHR
instance allocated on the specifiedMemoryStack
.static int
nfinalLayout(long struct)
Unsafe version offinalLayout()
.static void
nfinalLayout(long struct, int value)
Unsafe version offinalLayout
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static int
nformat(long struct)
Unsafe version offormat()
.static void
nformat(long struct, int value)
Unsafe version offormat
.static int
ninitialLayout(long struct)
Unsafe version ofinitialLayout()
.static void
ninitialLayout(long struct, int value)
Unsafe version ofinitialLayout
.static int
nloadOp(long struct)
Unsafe version ofloadOp()
.static void
nloadOp(long struct, int value)
Unsafe version ofloadOp
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsamples(long struct)
Unsafe version ofsamples()
.static void
nsamples(long struct, int value)
Unsafe version ofsamples
.static int
nstencilLoadOp(long struct)
Unsafe version ofstencilLoadOp()
.static void
nstencilLoadOp(long struct, int value)
Unsafe version ofstencilLoadOp
.static int
nstencilStoreOp(long struct)
Unsafe version ofstencilStoreOp()
.static void
nstencilStoreOp(long struct, int value)
Unsafe version ofstencilStoreOp
.static int
nstoreOp(long struct)
Unsafe version ofstoreOp()
.static void
nstoreOp(long struct, int value)
Unsafe version ofstoreOp
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.long
pNext()
Returns the value of thepNext
field.VkAttachmentDescription2KHR
pNext(long value)
Sets the specified value to thepNext
field.int
samples()
Returns the value of thesamples
field.VkAttachmentDescription2KHR
samples(int value)
Sets the specified value to thesamples
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 thestencilLoadOp
field.VkAttachmentDescription2KHR
stencilLoadOp(int value)
Sets the specified value to thestencilLoadOp
field.int
stencilStoreOp()
Returns the value of thestencilStoreOp
field.VkAttachmentDescription2KHR
stencilStoreOp(int value)
Sets the specified value to thestencilStoreOp
field.int
storeOp()
Returns the value of thestoreOp
field.VkAttachmentDescription2KHR
storeOp(int value)
Sets the specified value to thestoreOp
field.int
sType()
Returns the value of thesType
field.VkAttachmentDescription2KHR
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkAttachmentDescription2KHR
public VkAttachmentDescription2KHR(java.nio.ByteBuffer container)
Creates aVkAttachmentDescription2KHR
instance at the current position of the specifiedByteBuffer
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.
-
-
Method Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
format
public int format()
Returns the value of theformat
field.
-
samples
public int samples()
Returns the value of thesamples
field.
-
loadOp
public int loadOp()
Returns the value of theloadOp
field.
-
storeOp
public int storeOp()
Returns the value of thestoreOp
field.
-
stencilLoadOp
public int stencilLoadOp()
Returns the value of thestencilLoadOp
field.
-
stencilStoreOp
public int stencilStoreOp()
Returns the value of thestencilStoreOp
field.
-
initialLayout
public int initialLayout()
Returns the value of theinitialLayout
field.
-
finalLayout
public int finalLayout()
Returns the value of thefinalLayout
field.
-
sType
public VkAttachmentDescription2KHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkAttachmentDescription2KHR pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkAttachmentDescription2KHR flags(int value)
Sets the specified value to theflags
field.
-
format
public VkAttachmentDescription2KHR format(int value)
Sets the specified value to theformat
field.
-
samples
public VkAttachmentDescription2KHR samples(int value)
Sets the specified value to thesamples
field.
-
loadOp
public VkAttachmentDescription2KHR loadOp(int value)
Sets the specified value to theloadOp
field.
-
storeOp
public VkAttachmentDescription2KHR storeOp(int value)
Sets the specified value to thestoreOp
field.
-
stencilLoadOp
public VkAttachmentDescription2KHR stencilLoadOp(int value)
Sets the specified value to thestencilLoadOp
field.
-
stencilStoreOp
public VkAttachmentDescription2KHR stencilStoreOp(int value)
Sets the specified value to thestencilStoreOp
field.
-
initialLayout
public VkAttachmentDescription2KHR initialLayout(int value)
Sets the specified value to theinitialLayout
field.
-
finalLayout
public VkAttachmentDescription2KHR finalLayout(int value)
Sets the specified value to thefinalLayout
field.
-
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 newVkAttachmentDescription2KHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkAttachmentDescription2KHR calloc()
Returns a newVkAttachmentDescription2KHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkAttachmentDescription2KHR create()
Returns a newVkAttachmentDescription2KHR
instance allocated withBufferUtils
.
-
create
public static VkAttachmentDescription2KHR create(long address)
Returns a newVkAttachmentDescription2KHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkAttachmentDescription2KHR createSafe(long address)
-
malloc
public static VkAttachmentDescription2KHR.Buffer malloc(int capacity)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkAttachmentDescription2KHR.Buffer calloc(int capacity)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkAttachmentDescription2KHR.Buffer create(int capacity)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkAttachmentDescription2KHR.Buffer create(long address, int capacity)
Create aVkAttachmentDescription2KHR.Buffer
instance 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 newVkAttachmentDescription2KHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkAttachmentDescription2KHR callocStack()
Returns a newVkAttachmentDescription2KHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkAttachmentDescription2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentDescription2KHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkAttachmentDescription2KHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentDescription2KHR
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkAttachmentDescription2KHR.Buffer callocStack(int capacity)
Returns a newVkAttachmentDescription2KHR.Buffer
instance allocated on the thread-localMemoryStack
and 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.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
-