Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkAttachmentReferenceStencilLayout

extends Struct<VkAttachmentReferenceStencilLayout>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkAttachmentReferenceStencilLayoutKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying an attachment description.
Valid Usage
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STENCILLAYOUT

The struct member offsets.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkAttachmentReferenceStencilLayout(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkAttachmentReferenceStencilLayout
calloc()

Returns a new VkAttachmentReferenceStencilLayout instance allocated with memCalloc.

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

Returns a new VkAttachmentReferenceStencilLayout.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkAttachmentReferenceStencilLayout
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 VkAttachmentReferenceStencilLayout
create()

Returns a new VkAttachmentReferenceStencilLayout instance allocated with BufferUtils.

public static VkAttachmentReferenceStencilLayout
create(long address)

Returns a new VkAttachmentReferenceStencilLayout instance for the specified memory address.

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

Returns a new VkAttachmentReferenceStencilLayout.Buffer instance allocated with BufferUtils.

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

Create a VkAttachmentReferenceStencilLayout.Buffer instance at the specified memory.

public static VkAttachmentReferenceStencilLayout
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkAttachmentReferenceStencilLayout
malloc()

Returns a new VkAttachmentReferenceStencilLayout instance allocated with memAlloc.

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

Returns a new VkAttachmentReferenceStencilLayout.Buffer instance allocated with memAlloc.

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

Returns a new VkAttachmentReferenceStencilLayout instance allocated on the specified MemoryStack.

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

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nstencilLayout(long struct)

Unsafe version of stencilLayout.

public static void
nstencilLayout(long struct, int value)

Unsafe version of stencilLayout.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkAttachmentReferenceStencilLayout
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkAttachmentReferenceStencilLayout

Returns:

this struct
set
(VkAttachmentReferenceStencilLayout
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
stencilLayout()

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

public VkAttachmentReferenceStencilLayout
stencilLayout(int value)

Sets the specified value to the stencilLayout field.

public int
sType()

a VkStructureType value identifying this structure.

public VkAttachmentReferenceStencilLayout
sType(int value)

Sets the specified value to the sType field.

public VkAttachmentReferenceStencilLayout
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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STENCILLAYOUTback to summary
public static final int STENCILLAYOUT

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkAttachmentReferenceStencilLayoutback to summary
protected VkAttachmentReferenceStencilLayout(long address, ByteBuffer container)
VkAttachmentReferenceStencilLayoutback to summary
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 Detail

callocback to summary
public static VkAttachmentReferenceStencilLayout calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkAttachmentReferenceStencilLayout calloc(MemoryStack stack)

Returns a new VkAttachmentReferenceStencilLayout 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 VkAttachmentReferenceStencilLayout.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected VkAttachmentReferenceStencilLayout 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 VkAttachmentReferenceStencilLayout create()

Returns a new VkAttachmentReferenceStencilLayout instance allocated with BufferUtils.

createback to summary
public static VkAttachmentReferenceStencilLayout create(long address)

Returns a new VkAttachmentReferenceStencilLayout instance for the specified memory address.

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

Returns a new VkAttachmentReferenceStencilLayout.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkAttachmentReferenceStencilLayout.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkAttachmentReferenceStencilLayout createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkAttachmentReferenceStencilLayout malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkAttachmentReferenceStencilLayout malloc(MemoryStack stack)

Returns a new VkAttachmentReferenceStencilLayout instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nstencilLayoutback to summary
public static int nstencilLayout(long struct)

Unsafe version of stencilLayout.

nstencilLayoutback to summary
public static void nstencilLayout(long struct, int value)

Unsafe version of stencilLayout.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkAttachmentReferenceStencilLayout pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkAttachmentReferenceStencilLayout set(int sType, long pNext, int stencilLayout)

Initializes this struct with the specified values.

setback to summary
public VkAttachmentReferenceStencilLayout set(VkAttachmentReferenceStencilLayout src)

Copies the specified struct data to this struct.

Parameters
src:VkAttachmentReferenceStencilLayout

the source struct

Returns:VkAttachmentReferenceStencilLayout

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
stencilLayoutback to summary
public int stencilLayout()

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

Annotations
@NativeType:VkImageLayout
stencilLayoutback to summary
public VkAttachmentReferenceStencilLayout stencilLayout(int value)

Sets the specified value to the stencilLayout field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkAttachmentReferenceStencilLayout sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkAttachmentReferenceStencilLayout sType$Default()

Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_STENCIL_LAYOUT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkAttachmentReferenceStencilLayout.Buffer

extends StructBuffer<VkAttachmentReferenceStencilLayout, VkAttachmentReferenceStencilLayout.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkAttachmentReferenceStencilLayoutKHR.Buffer

An array of VkAttachmentReferenceStencilLayout structs.

Field Summary

Modifier and TypeField and Description
private static final VkAttachmentReferenceStencilLayout

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkAttachmentReferenceStencilLayout.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
protected VkAttachmentReferenceStencilLayout
public long

Returns:

the value of the VkAttachmentReferenceStencilLayout#pNext field.
pNext
()

public VkAttachmentReferenceStencilLayout.Buffer
pNext(long value)

Sets the specified value to the VkAttachmentReferenceStencilLayout#pNext field.

protected VkAttachmentReferenceStencilLayout.Buffer
public int
public VkAttachmentReferenceStencilLayout.Buffer
stencilLayout(int value)

Sets the specified value to the VkAttachmentReferenceStencilLayout#stencilLayout field.

public int

Returns:

the value of the VkAttachmentReferenceStencilLayout#sType field.
sType
()

public VkAttachmentReferenceStencilLayout.Buffer
sType(int value)

Sets the specified value to the VkAttachmentReferenceStencilLayout#sType field.

public VkAttachmentReferenceStencilLayout.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkAttachmentReferenceStencilLayout ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkAttachmentReferenceStencilLayout.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 VkAttachmentReferenceStencilLayout#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

getElementFactoryback to summary
protected VkAttachmentReferenceStencilLayout getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkAttachmentReferenceStencilLayout#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkAttachmentReferenceStencilLayout.Buffer pNext(long value)

Sets the specified value to the VkAttachmentReferenceStencilLayout#pNext field.

selfback to summary
protected VkAttachmentReferenceStencilLayout.Buffer self()

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

Annotations
@Override
stencilLayoutback to summary
public int stencilLayout()
Returns:int

the value of the VkAttachmentReferenceStencilLayout#stencilLayout field.

Annotations
@NativeType:VkImageLayout
stencilLayoutback to summary
public VkAttachmentReferenceStencilLayout.Buffer stencilLayout(int value)

Sets the specified value to the VkAttachmentReferenceStencilLayout#stencilLayout field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkAttachmentReferenceStencilLayout#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkAttachmentReferenceStencilLayout.Buffer sType(int value)

Sets the specified value to the VkAttachmentReferenceStencilLayout#sType field.

sType$Defaultback to summary
public VkAttachmentReferenceStencilLayout.Buffer sType$Default()

Sets the STRUCTURE_TYPE_ATTACHMENT_REFERENCE_STENCIL_LAYOUT value to the VkAttachmentReferenceStencilLayout#sType field.