Package org.lwjgl.vulkan

Class VkRenderPassInputAttachmentAspectCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkRenderPassInputAttachmentAspectCreateInfo>

org.lwjgl.vulkan.VkRenderPassInputAttachmentAspectCreateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkRenderPassInputAttachmentAspectCreateInfoKHR

public class VkRenderPassInputAttachmentAspectCreateInfo
extends Struct<VkRenderPassInputAttachmentAspectCreateInfo>
implements NativeResource

Structure specifying, for a given subpass/input attachment pair, which aspect can be read.

Description

To specify which aspects of an input attachment can be read, add a VkRenderPassInputAttachmentAspectCreateInfo structure to the pNext chain of the VkRenderPassCreateInfo structure:

An application can access any aspect of an input attachment that does not have a specified aspect mask in the pAspectReferences array. Otherwise, an application must not access aspect(s) of an input attachment other than those in its specified aspect mask.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDER_PASS_INPUT_ATTACHMENT_ASPECT_CREATE_INFO
• pAspectReferences must be a valid pointer to an array of aspectReferenceCount valid VkInputAttachmentAspectReference structures
• aspectReferenceCount must be greater than 0

See Also

VkInputAttachmentAspectReference

Layout

 struct VkRenderPassInputAttachmentAspectCreateInfo {
     VkStructureType sType();
     void const * pNext();
     uint32_t aspectReferenceCount();
     VkInputAttachmentAspectReference const * pAspectReferences();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkRenderPassInputAttachmentAspectCreateInfo.Buffer	An array of VkRenderPassInputAttachmentAspectCreateInfo 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

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	ASPECTREFERENCECOUNT	The struct member offsets.
static final int	PASPECTREFERENCES	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkRenderPassInputAttachmentAspectCreateInfo(ByteBuffer container)	Creates a VkRenderPassInputAttachmentAspectCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	aspectReferenceCount()	the number of elements in the pAspectReferences array.
static VkRenderPassInputAttachmentAspectCreateInfo	calloc()	Returns a new VkRenderPassInputAttachmentAspectCreateInfo instance allocated with memCalloc.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	calloc(int capacity)	Returns a new VkRenderPassInputAttachmentAspectCreateInfo.Buffer instance allocated with memCalloc.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkRenderPassInputAttachmentAspectCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassInputAttachmentAspectCreateInfo	calloc(MemoryStack stack)	Returns a new VkRenderPassInputAttachmentAspectCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkRenderPassInputAttachmentAspectCreateInfo	callocStack()	Deprecated.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkRenderPassInputAttachmentAspectCreateInfo	callocStack(MemoryStack stack)	Deprecated.
static VkRenderPassInputAttachmentAspectCreateInfo	create()	Returns a new VkRenderPassInputAttachmentAspectCreateInfo instance allocated with BufferUtils.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	create(int capacity)	Returns a new VkRenderPassInputAttachmentAspectCreateInfo.Buffer instance allocated with BufferUtils.
static VkRenderPassInputAttachmentAspectCreateInfo	create(long address)	Returns a new VkRenderPassInputAttachmentAspectCreateInfo instance for the specified memory address.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	create(long address, int capacity)	Create a VkRenderPassInputAttachmentAspectCreateInfo.Buffer instance at the specified memory.
static VkRenderPassInputAttachmentAspectCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkRenderPassInputAttachmentAspectCreateInfo	malloc()	Returns a new VkRenderPassInputAttachmentAspectCreateInfo instance allocated with memAlloc.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	malloc(int capacity)	Returns a new VkRenderPassInputAttachmentAspectCreateInfo.Buffer instance allocated with memAlloc.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkRenderPassInputAttachmentAspectCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkRenderPassInputAttachmentAspectCreateInfo	malloc(MemoryStack stack)	Returns a new VkRenderPassInputAttachmentAspectCreateInfo instance allocated on the specified MemoryStack.
static VkRenderPassInputAttachmentAspectCreateInfo	mallocStack()	Deprecated.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkRenderPassInputAttachmentAspectCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkRenderPassInputAttachmentAspectCreateInfo	mallocStack(MemoryStack stack)	Deprecated.
static int	naspectReferenceCount(long struct)	Unsafe version of aspectReferenceCount().
static void	naspectReferenceCount(long struct, int value)	Sets the specified value to the aspectReferenceCount field of the specified struct.
static VkInputAttachmentAspectReference.Buffer	npAspectReferences(long struct)	Unsafe version of pAspectReferences().
static void	npAspectReferences(long struct, VkInputAttachmentAspectReference.Buffer value)	Unsafe version of pAspectReferences.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
VkInputAttachmentAspectReference.Buffer	pAspectReferences()	a pointer to an array of aspectReferenceCount VkInputAttachmentAspectReference structures containing a mask describing which aspect(s) can be accessed for a given input attachment within a given subpass.
VkRenderPassInputAttachmentAspectCreateInfo	pAspectReferences(VkInputAttachmentAspectReference.Buffer value)	Sets the address of the specified VkInputAttachmentAspectReference.Buffer to the pAspectReferences() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkRenderPassInputAttachmentAspectCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkRenderPassInputAttachmentAspectCreateInfo	set(int sType, long pNext, VkInputAttachmentAspectReference.Buffer pAspectReferences)	Initializes this struct with the specified values.
VkRenderPassInputAttachmentAspectCreateInfo	set(VkRenderPassInputAttachmentAspectCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkRenderPassInputAttachmentAspectCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkRenderPassInputAttachmentAspectCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_RENDER_PASS_INPUT_ATTACHMENT_ASPECT_CREATE_INFO value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

ASPECTREFERENCECOUNT

public static final int ASPECTREFERENCECOUNT

The struct member offsets.

PASPECTREFERENCES

public static final int PASPECTREFERENCES

The struct member offsets.

Constructor Details

VkRenderPassInputAttachmentAspectCreateInfo

public VkRenderPassInputAttachmentAspectCreateInfo(ByteBuffer container)

Creates a VkRenderPassInputAttachmentAspectCreateInfo 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkRenderPassInputAttachmentAspectCreateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

aspectReferenceCount

public int aspectReferenceCount()

the number of elements in the pAspectReferences array.

pAspectReferences

public VkInputAttachmentAspectReference.Buffer pAspectReferences()

a pointer to an array of aspectReferenceCount VkInputAttachmentAspectReference structures containing a mask describing which aspect(s) can be accessed for a given input attachment within a given subpass.

sType

public VkRenderPassInputAttachmentAspectCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkRenderPassInputAttachmentAspectCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_RENDER_PASS_INPUT_ATTACHMENT_ASPECT_CREATE_INFO value to the sType() field.

pNext

public VkRenderPassInputAttachmentAspectCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

pAspectReferences

public VkRenderPassInputAttachmentAspectCreateInfo pAspectReferences(VkInputAttachmentAspectReference.Buffer value)

Sets the address of the specified VkInputAttachmentAspectReference.Buffer to the pAspectReferences() field.

set

public VkRenderPassInputAttachmentAspectCreateInfo set(int sType,
 long pNext,
 VkInputAttachmentAspectReference.Buffer pAspectReferences)

Initializes this struct with the specified values.

set

public VkRenderPassInputAttachmentAspectCreateInfo set(VkRenderPassInputAttachmentAspectCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkRenderPassInputAttachmentAspectCreateInfo malloc()

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

calloc

public static VkRenderPassInputAttachmentAspectCreateInfo calloc()

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

create

public static VkRenderPassInputAttachmentAspectCreateInfo create()

Returns a new VkRenderPassInputAttachmentAspectCreateInfo instance allocated with BufferUtils.

create

public static VkRenderPassInputAttachmentAspectCreateInfo create(long address)

Returns a new VkRenderPassInputAttachmentAspectCreateInfo instance for the specified memory address.

createSafe

@Nullable
public static VkRenderPassInputAttachmentAspectCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer create(int capacity)

Returns a new VkRenderPassInputAttachmentAspectCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer create(long address,
 int capacity)

Create a VkRenderPassInputAttachmentAspectCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkRenderPassInputAttachmentAspectCreateInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkRenderPassInputAttachmentAspectCreateInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkRenderPassInputAttachmentAspectCreateInfo mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkRenderPassInputAttachmentAspectCreateInfo callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkRenderPassInputAttachmentAspectCreateInfo malloc(MemoryStack stack)

Returns a new VkRenderPassInputAttachmentAspectCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkRenderPassInputAttachmentAspectCreateInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkRenderPassInputAttachmentAspectCreateInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

naspectReferenceCount

public static int naspectReferenceCount(long struct)

Unsafe version of aspectReferenceCount().

npAspectReferences

public static VkInputAttachmentAspectReference.Buffer npAspectReferences(long struct)

Unsafe version of pAspectReferences().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

naspectReferenceCount

public static void naspectReferenceCount(long struct,
 int value)

Sets the specified value to the aspectReferenceCount field of the specified struct.

npAspectReferences

public static void npAspectReferences(long struct,
 VkInputAttachmentAspectReference.Buffer value)

Unsafe version of pAspectReferences.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate