Package org.lwjgl.vulkan

Class VkAttachmentReferenceStencilLayout

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkAttachmentReferenceStencilLayout>

org.lwjgl.vulkan.VkAttachmentReferenceStencilLayout

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkAttachmentReferenceStencilLayoutKHR

public class VkAttachmentReferenceStencilLayout
extends org.lwjgl.system.Struct<VkAttachmentReferenceStencilLayout>
implements org.lwjgl.system.NativeResource

Structure specifying an attachment description.

Valid Usage

• stencilLayout must not be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_PREINITIALIZED, IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_PRESENT_SRC_KHR

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_ATTACHMENT_REFERENCE_STENCIL_LAYOUT
• stencilLayout must be a valid VkImageLayout value

Layout

 struct VkAttachmentReferenceStencilLayout {
     VkStructureType sType();
     void * pNext();
     VkImageLayout stencilLayout();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAttachmentReferenceStencilLayout.Buffer	An array of VkAttachmentReferenceStencilLayout structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STENCILLAYOUT	The struct member offsets.
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
VkAttachmentReferenceStencilLayout(ByteBuffer container)	Creates a VkAttachmentReferenceStencilLayout instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkAttachmentReferenceStencilLayout	calloc()	Returns a new VkAttachmentReferenceStencilLayout instance allocated with memCalloc.
static VkAttachmentReferenceStencilLayout.Buffer	calloc(int capacity)	Returns a new VkAttachmentReferenceStencilLayout.Buffer instance allocated with memCalloc.
static VkAttachmentReferenceStencilLayout.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentReferenceStencilLayout.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAttachmentReferenceStencilLayout	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentReferenceStencilLayout instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAttachmentReferenceStencilLayout	create()	Returns a new VkAttachmentReferenceStencilLayout instance allocated with BufferUtils.
static VkAttachmentReferenceStencilLayout.Buffer	create(int capacity)	Returns a new VkAttachmentReferenceStencilLayout.Buffer instance allocated with BufferUtils.
static VkAttachmentReferenceStencilLayout	create(long address)	Returns a new VkAttachmentReferenceStencilLayout instance for the specified memory address.
static VkAttachmentReferenceStencilLayout.Buffer	create(long address, int capacity)	Create a VkAttachmentReferenceStencilLayout.Buffer instance at the specified memory.
static @Nullable VkAttachmentReferenceStencilLayout	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkAttachmentReferenceStencilLayout.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkAttachmentReferenceStencilLayout	malloc()	Returns a new VkAttachmentReferenceStencilLayout instance allocated with memAlloc.
static VkAttachmentReferenceStencilLayout.Buffer	malloc(int capacity)	Returns a new VkAttachmentReferenceStencilLayout.Buffer instance allocated with memAlloc.
static VkAttachmentReferenceStencilLayout.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentReferenceStencilLayout.Buffer instance allocated on the specified MemoryStack.
static VkAttachmentReferenceStencilLayout	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentReferenceStencilLayout instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nstencilLayout(long struct)	Unsafe version of stencilLayout().
static void	nstencilLayout(long struct, int value)	Unsafe version of stencilLayout.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkAttachmentReferenceStencilLayout	pNext(long value)	Sets the specified value to the pNext() field.
VkAttachmentReferenceStencilLayout	set(int sType, long pNext, int stencilLayout)	Initializes this struct with the specified values.
VkAttachmentReferenceStencilLayout	set(VkAttachmentReferenceStencilLayout src)	Copies the specified struct data to this struct.
int	sizeof()
int	stencilLayout()	a VkImageLayout value specifying the layout the stencil aspect of the attachment uses during the subpass.
VkAttachmentReferenceStencilLayout	stencilLayout(int value)	Sets the specified value to the stencilLayout() field.
int	sType()	a VkStructureType value identifying this structure.
VkAttachmentReferenceStencilLayout	sType(int value)	Sets the specified value to the sType() field.
VkAttachmentReferenceStencilLayout	sType$Default()	Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_STENCIL_LAYOUT value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

STENCILLAYOUT

public static final int STENCILLAYOUT

The struct member offsets.

Constructor Details

VkAttachmentReferenceStencilLayout

public VkAttachmentReferenceStencilLayout(ByteBuffer container)

Creates a VkAttachmentReferenceStencilLayout 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkAttachmentReferenceStencilLayout>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

stencilLayout

public int stencilLayout()

a VkImageLayout value specifying the layout the stencil aspect of the attachment uses during the subpass.

sType

public VkAttachmentReferenceStencilLayout sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkAttachmentReferenceStencilLayout sType$Default()

Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_STENCIL_LAYOUT value to the sType() field.

pNext

public VkAttachmentReferenceStencilLayout pNext(long value)

Sets the specified value to the pNext() field.

stencilLayout

public VkAttachmentReferenceStencilLayout stencilLayout(int value)

Sets the specified value to the stencilLayout() field.

set

public VkAttachmentReferenceStencilLayout set(int sType,
 long pNext,
 int stencilLayout)

Initializes this struct with the specified values.

set

public VkAttachmentReferenceStencilLayout set(VkAttachmentReferenceStencilLayout src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAttachmentReferenceStencilLayout malloc()

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

calloc

public static VkAttachmentReferenceStencilLayout calloc()

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

create

public static VkAttachmentReferenceStencilLayout create()

Returns a new VkAttachmentReferenceStencilLayout instance allocated with BufferUtils.

create

public static VkAttachmentReferenceStencilLayout create(long address)

Returns a new VkAttachmentReferenceStencilLayout instance for the specified memory address.

createSafe

public static @Nullable VkAttachmentReferenceStencilLayout createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAttachmentReferenceStencilLayout.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkAttachmentReferenceStencilLayout.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkAttachmentReferenceStencilLayout.Buffer create(int capacity)

Returns a new VkAttachmentReferenceStencilLayout.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkAttachmentReferenceStencilLayout.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkAttachmentReferenceStencilLayout malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkAttachmentReferenceStencilLayout instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkAttachmentReferenceStencilLayout calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkAttachmentReferenceStencilLayout.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkAttachmentReferenceStencilLayout.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkAttachmentReferenceStencilLayout.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().

nstencilLayout

public static int nstencilLayout(long struct)

Unsafe version of stencilLayout().

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.

nstencilLayout

public static void nstencilLayout(long struct,
 int value)

Unsafe version of stencilLayout.