Package org.lwjgl.vulkan
Class VkInputAttachmentAspectReference
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkInputAttachmentAspectReference>
org.lwjgl.vulkan.VkInputAttachmentAspectReference
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
- Direct Known Subclasses:
VkInputAttachmentAspectReferenceKHR
public class VkInputAttachmentAspectReference
extends Struct<VkInputAttachmentAspectReference>
implements NativeResource
Structure specifying a subpass/input attachment pair and an aspect mask that can be read.
Description
This structure specifies an aspect mask for a specific input attachment of a specific subpass in the render pass.
subpass
and inputAttachmentIndex
index into the render pass as:
pCreateInfo->pSubpasses[subpass].pInputAttachments[inputAttachmentIndex]
Valid Usage
aspectMask
must not includeIMAGE_ASPECT_METADATA_BIT
aspectMask
must not includeVK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
for any index i
Valid Usage (Implicit)
aspectMask
must be a valid combination ofVkImageAspectFlagBits
valuesaspectMask
must not be 0
See Also
VkRenderPassInputAttachmentAspectCreateInfo
Layout
struct VkInputAttachmentAspectReference {
uint32_t subpass()
;
uint32_t inputAttachmentIndex()
;
VkImageAspectFlags aspectMask()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkInputAttachmentAspectReference
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkInputAttachmentAspectReference
(ByteBuffer container) Creates aVkInputAttachmentAspectReference
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionint
a mask of which aspect(s) can be accessed within the specified subpass.aspectMask
(int value) Sets the specified value to theaspectMask()
field.calloc()
Returns a newVkInputAttachmentAspectReference
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkInputAttachmentAspectReference.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkInputAttachmentAspectReference.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkInputAttachmentAspectReference
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkInputAttachmentAspectReference
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkInputAttachmentAspectReference.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkInputAttachmentAspectReference
instance for the specified memory address.create
(long address, int capacity) Create aVkInputAttachmentAspectReference.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) int
an index into thepInputAttachments
of the specified subpass.inputAttachmentIndex
(int value) Sets the specified value to theinputAttachmentIndex()
field.malloc()
Returns a newVkInputAttachmentAspectReference
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkInputAttachmentAspectReference.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkInputAttachmentAspectReference.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkInputAttachmentAspectReference
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.static int
naspectMask
(long struct) Unsafe version ofaspectMask()
.static void
naspectMask
(long struct, int value) Unsafe version ofaspectMask
.static int
ninputAttachmentIndex
(long struct) Unsafe version ofinputAttachmentIndex()
.static void
ninputAttachmentIndex
(long struct, int value) Unsafe version ofinputAttachmentIndex
.static int
nsubpass
(long struct) Unsafe version ofsubpass()
.static void
nsubpass
(long struct, int value) Unsafe version ofsubpass
.set
(int subpass, int inputAttachmentIndex, int aspectMask) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
subpass()
an index into thepSubpasses
array of the parentVkRenderPassCreateInfo
structure.subpass
(int value) Sets the specified value to thesubpass()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
SUBPASS
public static final int SUBPASSThe struct member offsets. -
INPUTATTACHMENTINDEX
public static final int INPUTATTACHMENTINDEXThe struct member offsets. -
ASPECTMASK
public static final int ASPECTMASKThe struct member offsets.
-
-
Constructor Details
-
VkInputAttachmentAspectReference
Creates aVkInputAttachmentAspectReference
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkInputAttachmentAspectReference>
-
subpass
public int subpass()an index into thepSubpasses
array of the parentVkRenderPassCreateInfo
structure. -
inputAttachmentIndex
public int inputAttachmentIndex()an index into thepInputAttachments
of the specified subpass. -
aspectMask
public int aspectMask()a mask of which aspect(s) can be accessed within the specified subpass. -
subpass
Sets the specified value to thesubpass()
field. -
inputAttachmentIndex
Sets the specified value to theinputAttachmentIndex()
field. -
aspectMask
Sets the specified value to theaspectMask()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkInputAttachmentAspectReference
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkInputAttachmentAspectReference
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkInputAttachmentAspectReference
instance allocated withBufferUtils
. -
create
Returns a newVkInputAttachmentAspectReference
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkInputAttachmentAspectReference.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkInputAttachmentAspectReference.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkInputAttachmentAspectReference.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkInputAttachmentAspectReference.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkInputAttachmentAspectReference.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkInputAttachmentAspectReference.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkInputAttachmentAspectReference.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkInputAttachmentAspectReference
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkInputAttachmentAspectReference
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkInputAttachmentAspectReference.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkInputAttachmentAspectReference.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nsubpass
public static int nsubpass(long struct) Unsafe version ofsubpass()
. -
ninputAttachmentIndex
public static int ninputAttachmentIndex(long struct) Unsafe version ofinputAttachmentIndex()
. -
naspectMask
public static int naspectMask(long struct) Unsafe version ofaspectMask()
. -
nsubpass
public static void nsubpass(long struct, int value) Unsafe version ofsubpass
. -
ninputAttachmentIndex
public static void ninputAttachmentIndex(long struct, int value) Unsafe version ofinputAttachmentIndex
. -
naspectMask
public static void naspectMask(long struct, int value) Unsafe version ofaspectMask
.
-