Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSubpassDescriptionDepthStencilResolve

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

Structure specifying depth/stencil resolve operations for a subpass.
Description

If the pNext chain of VkSubpassDescription2 includes a VkSubpassDescriptionDepthStencilResolve structure, then that structure describes multisample resolve operations for the depth/stencil attachment in a subpass. If this structure is not included in the pNext chain of VkSubpassDescription2, or if it is and either pDepthStencilResolveAttachment is NULL or its attachment index is ATTACHMENT_UNUSED, it indicates that no depth/stencil resolve attachment will be used in the subpass.

Valid Usage
Valid Usage (Implicit)
See Also

VkAttachmentReference2

Layout


struct VkSubpassDescriptionDepthStencilResolve {
    VkStructureType sType;
    void const * pNext;
    VkResolveModeFlagBits depthResolveMode;
    VkResolveModeFlagBits stencilResolveMode;
    VkAttachmentReference2 const * pDepthStencilResolveAttachment;
}

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
DEPTHRESOLVEMODE

The struct member offsets.

public static final int
PDEPTHSTENCILRESOLVEATTACHMENT

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STENCILRESOLVEMODE

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
VkSubpassDescriptionDepthStencilResolve(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSubpassDescriptionDepthStencilResolve
calloc()

Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated with memCalloc.

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

Returns a new VkSubpassDescriptionDepthStencilResolve.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated with BufferUtils.

public static VkSubpassDescriptionDepthStencilResolve
create(long address)

Returns a new VkSubpassDescriptionDepthStencilResolve instance for the specified memory address.

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

Returns a new VkSubpassDescriptionDepthStencilResolve.Buffer instance allocated with BufferUtils.

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

Create a VkSubpassDescriptionDepthStencilResolve.Buffer instance at the specified memory.

public static VkSubpassDescriptionDepthStencilResolve
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
depthResolveMode()

a VkResolveModeFlagBits value describing the depth resolve mode.

public VkSubpassDescriptionDepthStencilResolve
depthResolveMode(int value)

Sets the specified value to the depthResolveMode field.

public static VkSubpassDescriptionDepthStencilResolve
malloc()

Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated with memAlloc.

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

Returns a new VkSubpassDescriptionDepthStencilResolve.Buffer instance allocated with memAlloc.

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

Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated on the specified MemoryStack.

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

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

public static int
ndepthResolveMode(long struct)

Unsafe version of depthResolveMode.

public static void
ndepthResolveMode(long struct, int value)

Unsafe version of depthResolveMode.

public static VkAttachmentReference2
public static void
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
nstencilResolveMode(long struct)

Unsafe version of stencilResolveMode.

public static void
nstencilResolveMode(long struct, int value)

Unsafe version of stencilResolveMode.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public VkAttachmentReference2
pDepthStencilResolveAttachment()

NULL or a pointer to a VkAttachmentReference2 structure defining the depth/stencil resolve attachment for this subpass and its layout.

public VkSubpassDescriptionDepthStencilResolve
public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSubpassDescriptionDepthStencilResolve
pNext(long value)

Sets the specified value to the pNext field.

public VkSubpassDescriptionDepthStencilResolve
set(int sType, long pNext, int depthResolveMode, int stencilResolveMode, VkAttachmentReference2 pDepthStencilResolveAttachment)

Initializes this struct with the specified values.

public VkSubpassDescriptionDepthStencilResolve

Returns:

this struct
set
(VkSubpassDescriptionDepthStencilResolve
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
stencilResolveMode()

a VkResolveModeFlagBits value describing the stencil resolve mode.

public VkSubpassDescriptionDepthStencilResolve
stencilResolveMode(int value)

Sets the specified value to the stencilResolveMode field.

public int
sType()

a VkStructureType value identifying this structure.

public VkSubpassDescriptionDepthStencilResolve
sType(int value)

Sets the specified value to the sType field.

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

DEPTHRESOLVEMODEback to summary
public static final int DEPTHRESOLVEMODE

The struct member offsets.

PDEPTHSTENCILRESOLVEATTACHMENTback to summary
public static final int PDEPTHSTENCILRESOLVEATTACHMENT

The struct member offsets.

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.

STENCILRESOLVEMODEback to summary
public static final int STENCILRESOLVEMODE

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkSubpassDescriptionDepthStencilResolveback to summary
protected VkSubpassDescriptionDepthStencilResolve(long address, ByteBuffer container)
VkSubpassDescriptionDepthStencilResolveback to summary
public VkSubpassDescriptionDepthStencilResolve(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSubpassDescriptionDepthStencilResolve calloc(MemoryStack stack)

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

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

Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated with BufferUtils.

createback to summary
public static VkSubpassDescriptionDepthStencilResolve create(long address)

Returns a new VkSubpassDescriptionDepthStencilResolve instance for the specified memory address.

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

Returns a new VkSubpassDescriptionDepthStencilResolve.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSubpassDescriptionDepthStencilResolve.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSubpassDescriptionDepthStencilResolve createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
depthResolveModeback to summary
public int depthResolveMode()

a VkResolveModeFlagBits value describing the depth resolve mode.

Annotations
@NativeType:VkResolveModeFlagBits
depthResolveModeback to summary
public VkSubpassDescriptionDepthStencilResolve depthResolveMode(int value)

Sets the specified value to the depthResolveMode field.

mallocback to summary
public static VkSubpassDescriptionDepthStencilResolve malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSubpassDescriptionDepthStencilResolve malloc(MemoryStack stack)

Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndepthResolveModeback to summary
public static int ndepthResolveMode(long struct)

Unsafe version of depthResolveMode.

ndepthResolveModeback to summary
public static void ndepthResolveMode(long struct, int value)

Unsafe version of depthResolveMode.

npDepthStencilResolveAttachmentback to summary
public static VkAttachmentReference2 npDepthStencilResolveAttachment(long struct)

Unsafe version of pDepthStencilResolveAttachment.

Annotations
@Nullable
npDepthStencilResolveAttachmentback to summary
public static void npDepthStencilResolveAttachment(long struct, VkAttachmentReference2 value)

Unsafe version of pDepthStencilResolveAttachment.

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.

nstencilResolveModeback to summary
public static int nstencilResolveMode(long struct)

Unsafe version of stencilResolveMode.

nstencilResolveModeback to summary
public static void nstencilResolveMode(long struct, int value)

Unsafe version of stencilResolveMode.

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.

pDepthStencilResolveAttachmentback to summary
public VkAttachmentReference2 pDepthStencilResolveAttachment()

NULL or a pointer to a VkAttachmentReference2 structure defining the depth/stencil resolve attachment for this subpass and its layout.

Annotations
@Nullable
@NativeType:VkAttachmentReference2 const *
pDepthStencilResolveAttachmentback to summary
public VkSubpassDescriptionDepthStencilResolve pDepthStencilResolveAttachment(VkAttachmentReference2 value)

Sets the address of the specified VkAttachmentReference2 to the pDepthStencilResolveAttachment field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkSubpassDescriptionDepthStencilResolve set(int sType, long pNext, int depthResolveMode, int stencilResolveMode, VkAttachmentReference2 pDepthStencilResolveAttachment)

Initializes this struct with the specified values.

setback to summary
public VkSubpassDescriptionDepthStencilResolve set(VkSubpassDescriptionDepthStencilResolve src)

Copies the specified struct data to this struct.

Parameters
src:VkSubpassDescriptionDepthStencilResolve

the source struct

Returns:VkSubpassDescriptionDepthStencilResolve

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
stencilResolveModeback to summary
public int stencilResolveMode()

a VkResolveModeFlagBits value describing the stencil resolve mode.

Annotations
@NativeType:VkResolveModeFlagBits
stencilResolveModeback to summary
public VkSubpassDescriptionDepthStencilResolve stencilResolveMode(int value)

Sets the specified value to the stencilResolveMode field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SUBPASS_DESCRIPTION_DEPTH_STENCIL_RESOLVE value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSubpassDescriptionDepthStencilResolve.Buffer

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

An array of VkSubpassDescriptionDepthStencilResolve structs.

Field Summary

Modifier and TypeField and Description
private static final VkSubpassDescriptionDepthStencilResolve

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSubpassDescriptionDepthStencilResolve.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
public VkSubpassDescriptionDepthStencilResolve.Buffer
depthResolveMode(int value)

Sets the specified value to the VkSubpassDescriptionDepthStencilResolve#depthResolveMode field.

protected VkSubpassDescriptionDepthStencilResolve
public VkAttachmentReference2
public VkSubpassDescriptionDepthStencilResolve.Buffer
public long

Returns:

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

public VkSubpassDescriptionDepthStencilResolve.Buffer
pNext(long value)

Sets the specified value to the VkSubpassDescriptionDepthStencilResolve#pNext field.

protected VkSubpassDescriptionDepthStencilResolve.Buffer
public int
public VkSubpassDescriptionDepthStencilResolve.Buffer
stencilResolveMode(int value)

Sets the specified value to the VkSubpassDescriptionDepthStencilResolve#stencilResolveMode field.

public int

Returns:

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

public VkSubpassDescriptionDepthStencilResolve.Buffer
sType(int value)

Sets the specified value to the VkSubpassDescriptionDepthStencilResolve#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSubpassDescriptionDepthStencilResolve ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

depthResolveModeback to summary
public int depthResolveMode()
Returns:int

the value of the VkSubpassDescriptionDepthStencilResolve#depthResolveMode field.

Annotations
@NativeType:VkResolveModeFlagBits
depthResolveModeback to summary
public VkSubpassDescriptionDepthStencilResolve.Buffer depthResolveMode(int value)

Sets the specified value to the VkSubpassDescriptionDepthStencilResolve#depthResolveMode field.

getElementFactoryback to summary
protected VkSubpassDescriptionDepthStencilResolve getElementFactory()

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

Annotations
@Override
pDepthStencilResolveAttachmentback to summary
public VkAttachmentReference2 pDepthStencilResolveAttachment()
Returns:VkAttachmentReference2

a VkAttachmentReference2 view of the struct pointed to by the VkSubpassDescriptionDepthStencilResolve#pDepthStencilResolveAttachment field.

Annotations
@Nullable
@NativeType:VkAttachmentReference2 const *
pDepthStencilResolveAttachmentback to summary
public VkSubpassDescriptionDepthStencilResolve.Buffer pDepthStencilResolveAttachment(VkAttachmentReference2 value)

Sets the address of the specified VkAttachmentReference2 to the VkSubpassDescriptionDepthStencilResolve#pDepthStencilResolveAttachment field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkSubpassDescriptionDepthStencilResolve#pNext field.

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

Sets the specified value to the VkSubpassDescriptionDepthStencilResolve#pNext field.

selfback to summary
protected VkSubpassDescriptionDepthStencilResolve.Buffer self()

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

Annotations
@Override
stencilResolveModeback to summary
public int stencilResolveMode()
Returns:int

the value of the VkSubpassDescriptionDepthStencilResolve#stencilResolveMode field.

Annotations
@NativeType:VkResolveModeFlagBits
stencilResolveModeback to summary
public VkSubpassDescriptionDepthStencilResolve.Buffer stencilResolveMode(int value)

Sets the specified value to the VkSubpassDescriptionDepthStencilResolve#stencilResolveMode field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkSubpassDescriptionDepthStencilResolve#sType field.

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

Sets the specified value to the VkSubpassDescriptionDepthStencilResolve#sType field.

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

Sets the STRUCTURE_TYPE_SUBPASS_DESCRIPTION_DEPTH_STENCIL_RESOLVE value to the VkSubpassDescriptionDepthStencilResolve#sType field.