java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkSubpassDescriptionDepthStencilResolve

All Implemented Interfaces:

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

Direct Known Subclasses:

VkSubpassDescriptionDepthStencilResolveKHR
```
public class VkSubpassDescriptionDepthStencilResolve
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying depth/stencil resolve operations for a subpass.
Description

If pDepthStencilResolveAttachment is NULL, or if its attachment index is ATTACHMENT_UNUSED, it indicates that no depth/stencil resolve attachment will be used in the subpass.

Valid Usage
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED, pDepthStencilAttachment must not be NULL or have the value ATTACHMENT_UNUSED
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED, depthResolveMode and stencilResolveMode must not both be RESOLVE_MODE_NONE
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED, pDepthStencilAttachment must not have a sample count of SAMPLE_COUNT_1_BIT
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED, pDepthStencilResolveAttachment must have a sample count of SAMPLE_COUNT_1_BIT
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED then it must have an image format whose potential format features contain FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED and VkFormat of pDepthStencilResolveAttachment has a depth component, then the VkFormat of pDepthStencilAttachment must have a depth component with the same number of bits and numerical type
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED, and VkFormat of pDepthStencilResolveAttachment has a stencil component, then the VkFormat of pDepthStencilAttachment must have a stencil component with the same number of bits and numerical type
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED and the VkFormat of pDepthStencilResolveAttachment has a depth component, then the value of depthResolveMode must be one of the bits set in VkPhysicalDeviceDepthStencilResolveProperties::supportedDepthResolveModes or RESOLVE_MODE_NONE
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED and the VkFormat of pDepthStencilResolveAttachment has a stencil component, then the value of stencilResolveMode must be one of the bits set in VkPhysicalDeviceDepthStencilResolveProperties::supportedStencilResolveModes or RESOLVE_MODE_NONE
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED, the VkFormat of pDepthStencilResolveAttachment has both depth and stencil components, VkPhysicalDeviceDepthStencilResolveProperties::independentResolve is FALSE, and VkPhysicalDeviceDepthStencilResolveProperties::independentResolveNone is FALSE, then the values of depthResolveMode and stencilResolveMode must be identical
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED, the VkFormat of pDepthStencilResolveAttachment has both depth and stencil components, VkPhysicalDeviceDepthStencilResolveProperties::independentResolve is FALSE and VkPhysicalDeviceDepthStencilResolveProperties::independentResolveNone is TRUE, then the values of depthResolveMode and stencilResolveMode must be identical or one of them must be RESOLVE_MODE_NONE
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_SUBPASS_DESCRIPTION_DEPTH_STENCIL_RESOLVE
- If pDepthStencilResolveAttachment is not NULL, pDepthStencilResolveAttachment must be a valid pointer to a valid VkAttachmentReference2 structure
See Also

VkAttachmentReference2

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkSubpassDescriptionDepthStencilResolve.Buffer
An array of VkSubpassDescriptionDepthStencilResolve structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`DEPTHRESOLVEMODE PDEPTHSTENCILRESOLVEATTACHMENT PNEXT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STENCILRESOLVEMODE 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
`VkSubpassDescriptionDepthStencilResolve(java.nio.ByteBuffer container)`	Creates a `VkSubpassDescriptionDepthStencilResolve` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VkSubpassDescriptionDepthStencilResolve`	`calloc()`	Returns a new `VkSubpassDescriptionDepthStencilResolve` instance allocated with `memCalloc`.
`static VkSubpassDescriptionDepthStencilResolve.Buffer`	`calloc(int capacity)`	Returns a new `VkSubpassDescriptionDepthStencilResolve.Buffer` instance allocated with `memCalloc`.
`static VkSubpassDescriptionDepthStencilResolve.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSubpassDescriptionDepthStencilResolve.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSubpassDescriptionDepthStencilResolve`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSubpassDescriptionDepthStencilResolve` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSubpassDescriptionDepthStencilResolve`	`create()`	Returns a new `VkSubpassDescriptionDepthStencilResolve` instance allocated with `BufferUtils`.
`static VkSubpassDescriptionDepthStencilResolve.Buffer`	`create(int capacity)`	Returns a new `VkSubpassDescriptionDepthStencilResolve.Buffer` instance allocated with `BufferUtils`.
`static VkSubpassDescriptionDepthStencilResolve`	`create(long address)`	Returns a new `VkSubpassDescriptionDepthStencilResolve` instance for the specified memory address.
`static VkSubpassDescriptionDepthStencilResolve.Buffer`	`create(long address, int capacity)`	Create a `VkSubpassDescriptionDepthStencilResolve.Buffer` instance at the specified memory.
`static VkSubpassDescriptionDepthStencilResolve`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkSubpassDescriptionDepthStencilResolve.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`depthResolveMode()`	a `VkResolveModeFlagBits` value describing the depth resolve mode.
`VkSubpassDescriptionDepthStencilResolve`	`depthResolveMode(int value)`	Sets the specified value to the `depthResolveMode()` field.
`static VkSubpassDescriptionDepthStencilResolve`	`malloc()`	Returns a new `VkSubpassDescriptionDepthStencilResolve` instance allocated with `memAlloc`.
`static VkSubpassDescriptionDepthStencilResolve.Buffer`	`malloc(int capacity)`	Returns a new `VkSubpassDescriptionDepthStencilResolve.Buffer` instance allocated with `memAlloc`.
`static VkSubpassDescriptionDepthStencilResolve.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSubpassDescriptionDepthStencilResolve.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSubpassDescriptionDepthStencilResolve`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkSubpassDescriptionDepthStencilResolve` instance allocated on the specified `MemoryStack`.
`static int`	`ndepthResolveMode(long struct)`	Unsafe version of `depthResolveMode()`.
`static void`	`ndepthResolveMode(long struct, int value)`	Unsafe version of `depthResolveMode`.
`static VkAttachmentReference2`	`npDepthStencilResolveAttachment(long struct)`	Unsafe version of `pDepthStencilResolveAttachment()`.
`static void`	`npDepthStencilResolveAttachment(long struct, VkAttachmentReference2 value)`	Unsafe version of `pDepthStencilResolveAttachment`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nstencilResolveMode(long struct)`	Unsafe version of `stencilResolveMode()`.
`static void`	`nstencilResolveMode(long struct, int value)`	Unsafe version of `stencilResolveMode`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`VkAttachmentReference2`	`pDepthStencilResolveAttachment()`	`NULL` or a pointer to a `VkAttachmentReference2` structure defining the depth/stencil resolve attachment for this subpass and its layout.
`VkSubpassDescriptionDepthStencilResolve`	`pDepthStencilResolveAttachment(VkAttachmentReference2 value)`	Sets the address of the specified `VkAttachmentReference2` to the `pDepthStencilResolveAttachment()` field.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkSubpassDescriptionDepthStencilResolve`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkSubpassDescriptionDepthStencilResolve`	`set(int sType, long pNext, int depthResolveMode, int stencilResolveMode, VkAttachmentReference2 pDepthStencilResolveAttachment)`	Initializes this struct with the specified values.
`VkSubpassDescriptionDepthStencilResolve`	`set(VkSubpassDescriptionDepthStencilResolve src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stencilResolveMode()`	a `VkResolveModeFlagBits` value describing the stencil resolve mode.
`VkSubpassDescriptionDepthStencilResolve`	`stencilResolveMode(int value)`	Sets the specified value to the `stencilResolveMode()` field.
`int`	`sType()`	the type of this structure.
`VkSubpassDescriptionDepthStencilResolve`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkSubpassDescriptionDepthStencilResolve`	`sType$Default()`	Sets the `STRUCTURE_TYPE_SUBPASS_DESCRIPTION_DEPTH_STENCIL_RESOLVE` value to the `sType()` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

Field Detail
- SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  The struct alignment in bytes.
- STYPE, PNEXT, DEPTHRESOLVEMODE, STENCILRESOLVEMODE, PDEPTHSTENCILRESOLVEATTACHMENT
  
  The struct member offsets.

Constructor Detail
- VkSubpassDescriptionDepthStencilResolve
```
public VkSubpassDescriptionDepthStencilResolve(java.nio.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

sizeof
```
public int sizeof()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

sType
```
public int sType()
```
the type of this structure.

pNext
```
public long pNext()
```
NULL or a pointer to a structure extending this structure.

depthResolveMode
```
public int depthResolveMode()
```
a VkResolveModeFlagBits value describing the depth resolve mode.

stencilResolveMode
```
public int stencilResolveMode()
```
a VkResolveModeFlagBits value describing the stencil resolve mode.

pDepthStencilResolveAttachment
```
@Nullable
public VkAttachmentReference2 pDepthStencilResolveAttachment()
```
NULL or a pointer to a VkAttachmentReference2 structure defining the depth/stencil resolve attachment for this subpass and its layout.

sType

public VkSubpassDescriptionDepthStencilResolve sType(int value)

Sets the specified value to the sType() field.

sType$Default
```
public VkSubpassDescriptionDepthStencilResolve sType$Default()
```
Sets the STRUCTURE_TYPE_SUBPASS_DESCRIPTION_DEPTH_STENCIL_RESOLVE value to the sType() field.

pNext

public VkSubpassDescriptionDepthStencilResolve pNext(long value)

Sets the specified value to the pNext() field.

depthResolveMode

public VkSubpassDescriptionDepthStencilResolve depthResolveMode(int value)

Sets the specified value to the depthResolveMode() field.

stencilResolveMode

public VkSubpassDescriptionDepthStencilResolve stencilResolveMode(int value)

Sets the specified value to the stencilResolveMode() field.

pDepthStencilResolveAttachment

public VkSubpassDescriptionDepthStencilResolve pDepthStencilResolveAttachment(@Nullable
                                                                              VkAttachmentReference2 value)

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

set

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

Initializes this struct with the specified values.

set

public VkSubpassDescriptionDepthStencilResolve set(VkSubpassDescriptionDepthStencilResolve src)

Copies the specified struct data to this struct.

Parameters:: src - the source struct
Returns:: this struct

malloc
```
public static VkSubpassDescriptionDepthStencilResolve malloc()
```
Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkSubpassDescriptionDepthStencilResolve calloc()
```
Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkSubpassDescriptionDepthStencilResolve create()
```
Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated with BufferUtils.

create
```
public static VkSubpassDescriptionDepthStencilResolve create(long address)
```
Returns a new VkSubpassDescriptionDepthStencilResolve instance for the specified memory address.

createSafe

@Nullable
public static VkSubpassDescriptionDepthStencilResolve createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkSubpassDescriptionDepthStencilResolve.Buffer malloc(int capacity)
```
Returns a new VkSubpassDescriptionDepthStencilResolve.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkSubpassDescriptionDepthStencilResolve.Buffer calloc(int capacity)
```
Returns a new VkSubpassDescriptionDepthStencilResolve.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkSubpassDescriptionDepthStencilResolve.Buffer create(int capacity)
```
Returns a new VkSubpassDescriptionDepthStencilResolve.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSubpassDescriptionDepthStencilResolve.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc
```
public static VkSubpassDescriptionDepthStencilResolve malloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc
```
public static VkSubpassDescriptionDepthStencilResolve calloc(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkSubpassDescriptionDepthStencilResolve instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

calloc
```
public static VkSubpassDescriptionDepthStencilResolve.Buffer calloc(int capacity,
                                                                    org.lwjgl.system.MemoryStack stack)
```
Returns a new VkSubpassDescriptionDepthStencilResolve.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

ndepthResolveMode

public static int ndepthResolveMode(long struct)

Unsafe version of depthResolveMode().

nstencilResolveMode
```
public static int nstencilResolveMode(long struct)
```
Unsafe version of stencilResolveMode().

npDepthStencilResolveAttachment

@Nullable
public static VkAttachmentReference2 npDepthStencilResolveAttachment(long struct)

Unsafe version of pDepthStencilResolveAttachment().

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.

ndepthResolveMode

public static void ndepthResolveMode(long struct,
                                     int value)

Unsafe version of depthResolveMode.

nstencilResolveMode

public static void nstencilResolveMode(long struct,
                                       int value)

Unsafe version of stencilResolveMode.

npDepthStencilResolveAttachment

public static void npDepthStencilResolveAttachment(long struct,
                                                   @Nullable
                                                   VkAttachmentReference2 value)

Unsafe version of pDepthStencilResolveAttachment.

Class VkSubpassDescriptionDepthStencilResolve

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

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

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, DEPTHRESOLVEMODE, STENCILRESOLVEMODE, PDEPTHSTENCILRESOLVEATTACHMENT

Constructor Detail

VkSubpassDescriptionDepthStencilResolve

Method Detail

sizeof

sType

pNext

depthResolveMode

stencilResolveMode

pDepthStencilResolveAttachment

sType

sType$Default

pNext

depthResolveMode

stencilResolveMode

pDepthStencilResolveAttachment

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

ndepthResolveMode

nstencilResolveMode

npDepthStencilResolveAttachment

nsType

npNext

ndepthResolveMode

nstencilResolveMode

npDepthStencilResolveAttachment