Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkInputAttachmentAspectReference

extends Struct<VkInputAttachmentAspectReference>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkInputAttachmentAspectReferenceKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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
Valid Usage (Implicit)
See Also

VkRenderPassInputAttachmentAspectCreateInfo

Layout


struct VkInputAttachmentAspectReference {
    uint32_t subpass;
    uint32_t inputAttachmentIndex;
    VkImageAspectFlags aspectMask;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkInputAttachmentAspectReference.Buffer

An array of VkInputAttachmentAspectReference structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ASPECTMASK

The struct member offsets.

public static final int
INPUTATTACHMENTINDEX

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUBPASS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkInputAttachmentAspectReference(long address, ByteBuffer container)

public
VkInputAttachmentAspectReference(ByteBuffer container)

Creates a VkInputAttachmentAspectReference instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
aspectMask()

a mask of which aspect(s) can be accessed within the specified subpass.

public VkInputAttachmentAspectReference
aspectMask(int value)

Sets the specified value to the aspectMask field.

public static VkInputAttachmentAspectReference
calloc()

Returns a new VkInputAttachmentAspectReference instance allocated with memCalloc.

public static VkInputAttachmentAspectReference.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkInputAttachmentAspectReference.Buffer instance allocated with memCalloc.

public static VkInputAttachmentAspectReference
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkInputAttachmentAspectReference instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkInputAttachmentAspectReference.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkInputAttachmentAspectReference.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkInputAttachmentAspectReference
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkInputAttachmentAspectReference
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkInputAttachmentAspectReference.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkInputAttachmentAspectReference.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkInputAttachmentAspectReference
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkInputAttachmentAspectReference
create()

Returns a new VkInputAttachmentAspectReference instance allocated with BufferUtils.

public static VkInputAttachmentAspectReference
create(long address)

Returns a new VkInputAttachmentAspectReference instance for the specified memory address.

public static VkInputAttachmentAspectReference.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkInputAttachmentAspectReference.Buffer instance allocated with BufferUtils.

public static VkInputAttachmentAspectReference.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkInputAttachmentAspectReference.Buffer instance at the specified memory.

public static VkInputAttachmentAspectReference
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkInputAttachmentAspectReference.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
inputAttachmentIndex()

an index into the pInputAttachments of the specified subpass.

public VkInputAttachmentAspectReference
inputAttachmentIndex(int value)

Sets the specified value to the inputAttachmentIndex field.

public static VkInputAttachmentAspectReference
malloc()

Returns a new VkInputAttachmentAspectReference instance allocated with memAlloc.

public static VkInputAttachmentAspectReference.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkInputAttachmentAspectReference.Buffer instance allocated with memAlloc.

public static VkInputAttachmentAspectReference
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkInputAttachmentAspectReference instance allocated on the specified MemoryStack.

public static VkInputAttachmentAspectReference.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkInputAttachmentAspectReference.Buffer instance allocated on the specified MemoryStack.

public static VkInputAttachmentAspectReference
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkInputAttachmentAspectReference
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkInputAttachmentAspectReference.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkInputAttachmentAspectReference.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
naspectMask(long struct)

Unsafe version of aspectMask.

public static void
naspectMask(long struct, int value)

Unsafe version of aspectMask.

public static int
ninputAttachmentIndex(long struct)

Unsafe version of inputAttachmentIndex.

public static void
ninputAttachmentIndex(long struct, int value)

Unsafe version of inputAttachmentIndex.

public static int
nsubpass(long struct)

Unsafe version of subpass.

public static void
nsubpass(long struct, int value)

Unsafe version of subpass.

public VkInputAttachmentAspectReference
set(int subpass, int inputAttachmentIndex, int aspectMask)

Initializes this struct with the specified values.

public VkInputAttachmentAspectReference

Returns:

this struct
set(VkInputAttachmentAspectReference
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
subpass()

an index into the pSubpasses array of the parent VkRenderPassCreateInfo structure.

public VkInputAttachmentAspectReference
subpass(int value)

Sets the specified value to the subpass field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

ASPECTMASKback to summary
public static final int ASPECTMASK

The struct member offsets.

INPUTATTACHMENTINDEXback to summary
public static final int INPUTATTACHMENTINDEX

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUBPASSback to summary
public static final int SUBPASS

The struct member offsets.

Constructor Detail

VkInputAttachmentAspectReferenceback to summary
protected VkInputAttachmentAspectReference(long address, ByteBuffer container)
VkInputAttachmentAspectReferenceback to summary
public VkInputAttachmentAspectReference(ByteBuffer container)

Creates a VkInputAttachmentAspectReference instance at the current position of the specified ByteBuffer 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

aspectMaskback to summary
public int aspectMask()

a mask of which aspect(s) can be accessed within the specified subpass.

Annotations
@NativeType:VkImageAspectFlags
aspectMaskback to summary
public VkInputAttachmentAspectReference aspectMask(int value)

Sets the specified value to the aspectMask field.

callocback to summary
public static VkInputAttachmentAspectReference calloc()

Returns a new VkInputAttachmentAspectReference instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkInputAttachmentAspectReference.Buffer calloc(int capacity)

Returns a new VkInputAttachmentAspectReference.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkInputAttachmentAspectReference calloc(MemoryStack stack)

Returns a new VkInputAttachmentAspectReference instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkInputAttachmentAspectReference.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkInputAttachmentAspectReference.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkInputAttachmentAspectReference callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkInputAttachmentAspectReference callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkInputAttachmentAspectReference.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkInputAttachmentAspectReference.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkInputAttachmentAspectReference create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkInputAttachmentAspectReference create()

Returns a new VkInputAttachmentAspectReference instance allocated with BufferUtils.

createback to summary
public static VkInputAttachmentAspectReference create(long address)

Returns a new VkInputAttachmentAspectReference instance for the specified memory address.

createback to summary
public static VkInputAttachmentAspectReference.Buffer create(int capacity)

Returns a new VkInputAttachmentAspectReference.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkInputAttachmentAspectReference.Buffer create(long address, int capacity)

Create a VkInputAttachmentAspectReference.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkInputAttachmentAspectReference createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkInputAttachmentAspectReference.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
inputAttachmentIndexback to summary
public int inputAttachmentIndex()

an index into the pInputAttachments of the specified subpass.

Annotations
@NativeType:uint32_t
inputAttachmentIndexback to summary
public VkInputAttachmentAspectReference inputAttachmentIndex(int value)

Sets the specified value to the inputAttachmentIndex field.

mallocback to summary
public static VkInputAttachmentAspectReference malloc()

Returns a new VkInputAttachmentAspectReference instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkInputAttachmentAspectReference.Buffer malloc(int capacity)

Returns a new VkInputAttachmentAspectReference.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkInputAttachmentAspectReference malloc(MemoryStack stack)

Returns a new VkInputAttachmentAspectReference instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkInputAttachmentAspectReference.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkInputAttachmentAspectReference.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkInputAttachmentAspectReference mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkInputAttachmentAspectReference mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkInputAttachmentAspectReference.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkInputAttachmentAspectReference.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
naspectMaskback to summary
public static int naspectMask(long struct)

Unsafe version of aspectMask.

naspectMaskback to summary
public static void naspectMask(long struct, int value)

Unsafe version of aspectMask.

ninputAttachmentIndexback to summary
public static int ninputAttachmentIndex(long struct)

Unsafe version of inputAttachmentIndex.

ninputAttachmentIndexback to summary
public static void ninputAttachmentIndex(long struct, int value)

Unsafe version of inputAttachmentIndex.

nsubpassback to summary
public static int nsubpass(long struct)

Unsafe version of subpass.

nsubpassback to summary
public static void nsubpass(long struct, int value)

Unsafe version of subpass.

setback to summary
public VkInputAttachmentAspectReference set(int subpass, int inputAttachmentIndex, int aspectMask)

Initializes this struct with the specified values.

setback to summary
public VkInputAttachmentAspectReference set(VkInputAttachmentAspectReference src)

Copies the specified struct data to this struct.

Parameters
src:VkInputAttachmentAspectReference

the source struct

Returns:VkInputAttachmentAspectReference

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
subpassback to summary
public int subpass()

an index into the pSubpasses array of the parent VkRenderPassCreateInfo structure.

Annotations
@NativeType:uint32_t
subpassback to summary
public VkInputAttachmentAspectReference subpass(int value)

Sets the specified value to the subpass field.

org.lwjgl.vulkan back to summary

public Class VkInputAttachmentAspectReference.Buffer

extends StructBuffer<VkInputAttachmentAspectReference, VkInputAttachmentAspectReference.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkInputAttachmentAspectReferenceKHR.Buffer
An array of VkInputAttachmentAspectReference structs.

Field Summary

Modifier and TypeField and Description
private static final VkInputAttachmentAspectReference
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkInputAttachmentAspectReference.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkInputAttachmentAspectReference#aspectMask field.
aspectMask()

public VkInputAttachmentAspectReference.Buffer
aspectMask(int value)

Sets the specified value to the VkInputAttachmentAspectReference#aspectMask field.

protected VkInputAttachmentAspectReference
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public int

Returns:

the value of the VkInputAttachmentAspectReference#inputAttachmentIndex field.
inputAttachmentIndex()

public VkInputAttachmentAspectReference.Buffer
inputAttachmentIndex(int value)

Sets the specified value to the VkInputAttachmentAspectReference#inputAttachmentIndex field.

protected VkInputAttachmentAspectReference.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkInputAttachmentAspectReference#subpass field.
subpass()

public VkInputAttachmentAspectReference.Buffer
subpass(int value)

Sets the specified value to the VkInputAttachmentAspectReference#subpass field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkInputAttachmentAspectReference ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkInputAttachmentAspectReference.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkInputAttachmentAspectReference#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

aspectMaskback to summary
public int aspectMask()
Returns:int

the value of the VkInputAttachmentAspectReference#aspectMask field.

Annotations
@NativeType:VkImageAspectFlags
aspectMaskback to summary
public VkInputAttachmentAspectReference.Buffer aspectMask(int value)

Sets the specified value to the VkInputAttachmentAspectReference#aspectMask field.

getElementFactoryback to summary
protected VkInputAttachmentAspectReference getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
inputAttachmentIndexback to summary
public int inputAttachmentIndex()
Returns:int

the value of the VkInputAttachmentAspectReference#inputAttachmentIndex field.

Annotations
@NativeType:uint32_t
inputAttachmentIndexback to summary
public VkInputAttachmentAspectReference.Buffer inputAttachmentIndex(int value)

Sets the specified value to the VkInputAttachmentAspectReference#inputAttachmentIndex field.

selfback to summary
protected VkInputAttachmentAspectReference.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
subpassback to summary
public int subpass()
Returns:int

the value of the VkInputAttachmentAspectReference#subpass field.

Annotations
@NativeType:uint32_t
subpassback to summary
public VkInputAttachmentAspectReference.Buffer subpass(int value)

Sets the specified value to the VkInputAttachmentAspectReference#subpass field.