Package org.lwjgl.vulkan
Class VkAttachmentReference2KHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkAttachmentReference2KHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkAttachmentReference2KHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying an attachment reference.Description
Parameters defined by this structure with the same name as those in
VkAttachmentReference
have the identical effect to those parameters.aspectMask
has the same effect for the described attachment asVkInputAttachmentAspectReference
::aspectMask
has on each corresponding attachment. It is ignored when this structure is used to describe anything other than an input attachment reference.Valid Usage
- If
attachment
is notATTACHMENT_UNUSED
,layout
must not beIMAGE_LAYOUT_UNDEFINED
orIMAGE_LAYOUT_PREINITIALIZED
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_ATTACHMENT_REFERENCE_2_KHR
layout
must be a validVkImageLayout
value
See Also
VkSubpassDescription2KHR
,VkSubpassDescriptionDepthStencilResolveKHR
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.attachment
– either an integer value identifying an attachment at the corresponding index inVkRenderPassCreateInfo
::pAttachments
, orATTACHMENT_UNUSED
to signify that this attachment is not used.layout
– aVkImageLayout
value specifying the layout the attachment uses during the subpass.aspectMask
– a mask of which aspect(s) can be accessed within the specified subpass as an input attachment.
Layout
struct VkAttachmentReference2KHR { VkStructureType sType; void const * pNext; uint32_t attachment; VkImageLayout layout; VkImageAspectFlags aspectMask; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkAttachmentReference2KHR.Buffer
An array ofVkAttachmentReference2KHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
ASPECTMASK
ATTACHMENT
LAYOUT
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkAttachmentReference2KHR(java.nio.ByteBuffer container)
Creates aVkAttachmentReference2KHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
aspectMask()
Returns the value of theaspectMask
field.VkAttachmentReference2KHR
aspectMask(int value)
Sets the specified value to theaspectMask
field.int
attachment()
Returns the value of theattachment
field.VkAttachmentReference2KHR
attachment(int value)
Sets the specified value to theattachment
field.static VkAttachmentReference2KHR
calloc()
Returns a newVkAttachmentReference2KHR
instance allocated withmemCalloc
.static VkAttachmentReference2KHR.Buffer
calloc(int capacity)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated withmemCalloc
.static VkAttachmentReference2KHR
callocStack()
Returns a newVkAttachmentReference2KHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkAttachmentReference2KHR.Buffer
callocStack(int capacity)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkAttachmentReference2KHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkAttachmentReference2KHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentReference2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkAttachmentReference2KHR
create()
Returns a newVkAttachmentReference2KHR
instance allocated withBufferUtils
.static VkAttachmentReference2KHR.Buffer
create(int capacity)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated withBufferUtils
.static VkAttachmentReference2KHR
create(long address)
Returns a newVkAttachmentReference2KHR
instance for the specified memory address.static VkAttachmentReference2KHR.Buffer
create(long address, int capacity)
Create aVkAttachmentReference2KHR.Buffer
instance at the specified memory.static VkAttachmentReference2KHR
createSafe(long address)
static VkAttachmentReference2KHR.Buffer
createSafe(long address, int capacity)
int
layout()
Returns the value of thelayout
field.VkAttachmentReference2KHR
layout(int value)
Sets the specified value to thelayout
field.static VkAttachmentReference2KHR
malloc()
Returns a newVkAttachmentReference2KHR
instance allocated withmemAlloc
.static VkAttachmentReference2KHR.Buffer
malloc(int capacity)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated withmemAlloc
.static VkAttachmentReference2KHR
mallocStack()
Returns a newVkAttachmentReference2KHR
instance allocated on the thread-localMemoryStack
.static VkAttachmentReference2KHR.Buffer
mallocStack(int capacity)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkAttachmentReference2KHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkAttachmentReference2KHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentReference2KHR
instance allocated on the specifiedMemoryStack
.static int
naspectMask(long struct)
Unsafe version ofaspectMask()
.static void
naspectMask(long struct, int value)
Unsafe version ofaspectMask
.static int
nattachment(long struct)
Unsafe version ofattachment()
.static void
nattachment(long struct, int value)
Unsafe version ofattachment
.static int
nlayout(long struct)
Unsafe version oflayout()
.static void
nlayout(long struct, int value)
Unsafe version oflayout
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.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.VkAttachmentReference2KHR
pNext(long value)
Sets the specified value to thepNext
field.VkAttachmentReference2KHR
set(int sType, long pNext, int attachment, int layout, int aspectMask)
Initializes this struct with the specified values.VkAttachmentReference2KHR
set(VkAttachmentReference2KHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkAttachmentReference2KHR
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkAttachmentReference2KHR
public VkAttachmentReference2KHR(java.nio.ByteBuffer container)
Creates aVkAttachmentReference2KHR
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.
-
attachment
public int attachment()
Returns the value of theattachment
field.
-
layout
public int layout()
Returns the value of thelayout
field.
-
aspectMask
public int aspectMask()
Returns the value of theaspectMask
field.
-
sType
public VkAttachmentReference2KHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkAttachmentReference2KHR pNext(long value)
Sets the specified value to thepNext
field.
-
attachment
public VkAttachmentReference2KHR attachment(int value)
Sets the specified value to theattachment
field.
-
layout
public VkAttachmentReference2KHR layout(int value)
Sets the specified value to thelayout
field.
-
aspectMask
public VkAttachmentReference2KHR aspectMask(int value)
Sets the specified value to theaspectMask
field.
-
set
public VkAttachmentReference2KHR set(int sType, long pNext, int attachment, int layout, int aspectMask)
Initializes this struct with the specified values.
-
set
public VkAttachmentReference2KHR set(VkAttachmentReference2KHR src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkAttachmentReference2KHR malloc()
Returns a newVkAttachmentReference2KHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkAttachmentReference2KHR calloc()
Returns a newVkAttachmentReference2KHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkAttachmentReference2KHR create()
Returns a newVkAttachmentReference2KHR
instance allocated withBufferUtils
.
-
create
public static VkAttachmentReference2KHR create(long address)
Returns a newVkAttachmentReference2KHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkAttachmentReference2KHR createSafe(long address)
-
malloc
public static VkAttachmentReference2KHR.Buffer malloc(int capacity)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkAttachmentReference2KHR.Buffer calloc(int capacity)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkAttachmentReference2KHR.Buffer create(int capacity)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkAttachmentReference2KHR.Buffer create(long address, int capacity)
Create aVkAttachmentReference2KHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkAttachmentReference2KHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkAttachmentReference2KHR mallocStack()
Returns a newVkAttachmentReference2KHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkAttachmentReference2KHR callocStack()
Returns a newVkAttachmentReference2KHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkAttachmentReference2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentReference2KHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkAttachmentReference2KHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentReference2KHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkAttachmentReference2KHR.Buffer mallocStack(int capacity)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkAttachmentReference2KHR.Buffer callocStack(int capacity)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkAttachmentReference2KHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentReference2KHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkAttachmentReference2KHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentReference2KHR.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()
.
-
nattachment
public static int nattachment(long struct)
Unsafe version ofattachment()
.
-
nlayout
public static int nlayout(long struct)
Unsafe version oflayout()
.
-
naspectMask
public static int naspectMask(long struct)
Unsafe version ofaspectMask()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nattachment
public static void nattachment(long struct, int value)
Unsafe version ofattachment
.
-
nlayout
public static void nlayout(long struct, int value)
Unsafe version oflayout
.
-
naspectMask
public static void naspectMask(long struct, int value)
Unsafe version ofaspectMask
.
-
-