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.NativeResourceStructure specifying an attachment reference.Description
Parameters defined by this structure with the same name as those in
VkAttachmentReferencehave the identical effect to those parameters.aspectMaskhas the same effect for the described attachment asVkInputAttachmentAspectReference::aspectMaskhas on each corresponding attachment. It is ignored when this structure is used to describe anything other than an input attachment reference.Valid Usage
- If
attachmentis notATTACHMENT_UNUSED,layoutmust not beIMAGE_LAYOUT_UNDEFINEDorIMAGE_LAYOUT_PREINITIALIZED
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_ATTACHMENT_REFERENCE_2_KHRlayoutmust be a validVkImageLayoutvalue
See Also
VkSubpassDescription2KHR,VkSubpassDescriptionDepthStencilResolveKHRMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.attachment– either an integer value identifying an attachment at the corresponding index inVkRenderPassCreateInfo::pAttachments, orATTACHMENT_UNUSEDto signify that this attachment is not used.layout– aVkImageLayoutvalue 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 classVkAttachmentReference2KHR.BufferAn array ofVkAttachmentReference2KHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intASPECTMASK
ATTACHMENT
LAYOUT
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkAttachmentReference2KHR(java.nio.ByteBuffer container)Creates aVkAttachmentReference2KHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intaspectMask()Returns the value of theaspectMaskfield.VkAttachmentReference2KHRaspectMask(int value)Sets the specified value to theaspectMaskfield.intattachment()Returns the value of theattachmentfield.VkAttachmentReference2KHRattachment(int value)Sets the specified value to theattachmentfield.static VkAttachmentReference2KHRcalloc()Returns a newVkAttachmentReference2KHRinstance allocated withmemCalloc.static VkAttachmentReference2KHR.Buffercalloc(int capacity)Returns a newVkAttachmentReference2KHR.Bufferinstance allocated withmemCalloc.static VkAttachmentReference2KHRcallocStack()Returns a newVkAttachmentReference2KHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkAttachmentReference2KHR.BuffercallocStack(int capacity)Returns a newVkAttachmentReference2KHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkAttachmentReference2KHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentReference2KHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkAttachmentReference2KHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentReference2KHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkAttachmentReference2KHRcreate()Returns a newVkAttachmentReference2KHRinstance allocated withBufferUtils.static VkAttachmentReference2KHR.Buffercreate(int capacity)Returns a newVkAttachmentReference2KHR.Bufferinstance allocated withBufferUtils.static VkAttachmentReference2KHRcreate(long address)Returns a newVkAttachmentReference2KHRinstance for the specified memory address.static VkAttachmentReference2KHR.Buffercreate(long address, int capacity)Create aVkAttachmentReference2KHR.Bufferinstance at the specified memory.static VkAttachmentReference2KHRcreateSafe(long address)static VkAttachmentReference2KHR.BuffercreateSafe(long address, int capacity)intlayout()Returns the value of thelayoutfield.VkAttachmentReference2KHRlayout(int value)Sets the specified value to thelayoutfield.static VkAttachmentReference2KHRmalloc()Returns a newVkAttachmentReference2KHRinstance allocated withmemAlloc.static VkAttachmentReference2KHR.Buffermalloc(int capacity)Returns a newVkAttachmentReference2KHR.Bufferinstance allocated withmemAlloc.static VkAttachmentReference2KHRmallocStack()Returns a newVkAttachmentReference2KHRinstance allocated on the thread-localMemoryStack.static VkAttachmentReference2KHR.BuffermallocStack(int capacity)Returns a newVkAttachmentReference2KHR.Bufferinstance allocated on the thread-localMemoryStack.static VkAttachmentReference2KHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentReference2KHR.Bufferinstance allocated on the specifiedMemoryStack.static VkAttachmentReference2KHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkAttachmentReference2KHRinstance allocated on the specifiedMemoryStack.static intnaspectMask(long struct)Unsafe version ofaspectMask().static voidnaspectMask(long struct, int value)Unsafe version ofaspectMask.static intnattachment(long struct)Unsafe version ofattachment().static voidnattachment(long struct, int value)Unsafe version ofattachment.static intnlayout(long struct)Unsafe version oflayout().static voidnlayout(long struct, int value)Unsafe version oflayout.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()Returns the value of thepNextfield.VkAttachmentReference2KHRpNext(long value)Sets the specified value to thepNextfield.VkAttachmentReference2KHRset(int sType, long pNext, int attachment, int layout, int aspectMask)Initializes this struct with the specified values.VkAttachmentReference2KHRset(VkAttachmentReference2KHR src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkAttachmentReference2KHRsType(int value)Sets the specified value to thesTypefield.
-
-
-
Constructor Detail
-
VkAttachmentReference2KHR
public VkAttachmentReference2KHR(java.nio.ByteBuffer container)
Creates aVkAttachmentReference2KHRinstance 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.
-
attachment
public int attachment()
Returns the value of theattachmentfield.
-
layout
public int layout()
Returns the value of thelayoutfield.
-
aspectMask
public int aspectMask()
Returns the value of theaspectMaskfield.
-
sType
public VkAttachmentReference2KHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkAttachmentReference2KHR pNext(long value)
Sets the specified value to thepNextfield.
-
attachment
public VkAttachmentReference2KHR attachment(int value)
Sets the specified value to theattachmentfield.
-
layout
public VkAttachmentReference2KHR layout(int value)
Sets the specified value to thelayoutfield.
-
aspectMask
public VkAttachmentReference2KHR aspectMask(int value)
Sets the specified value to theaspectMaskfield.
-
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 newVkAttachmentReference2KHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkAttachmentReference2KHR calloc()
Returns a newVkAttachmentReference2KHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkAttachmentReference2KHR create()
Returns a newVkAttachmentReference2KHRinstance allocated withBufferUtils.
-
create
public static VkAttachmentReference2KHR create(long address)
Returns a newVkAttachmentReference2KHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkAttachmentReference2KHR createSafe(long address)
-
malloc
public static VkAttachmentReference2KHR.Buffer malloc(int capacity)
Returns a newVkAttachmentReference2KHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkAttachmentReference2KHR.Buffer calloc(int capacity)
Returns a newVkAttachmentReference2KHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkAttachmentReference2KHR.Buffer create(int capacity)
Returns a newVkAttachmentReference2KHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkAttachmentReference2KHR.Buffer create(long address, int capacity)
Create aVkAttachmentReference2KHR.Bufferinstance 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 newVkAttachmentReference2KHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkAttachmentReference2KHR callocStack()
Returns a newVkAttachmentReference2KHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkAttachmentReference2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentReference2KHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkAttachmentReference2KHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkAttachmentReference2KHRinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkAttachmentReference2KHR.Buffer callocStack(int capacity)
Returns a newVkAttachmentReference2KHR.Bufferinstance allocated on the thread-localMemoryStackand 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.Bufferinstance 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.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().
-
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.
-
-