VkSubpassDescriptionDepthStencilResolveKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSubpassDescriptionDepthStencilResolveKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying depth/stencil resolve operations for a subpass.
Valid Usage
- If pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED, pDepthStencilAttachment must not 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_KHR
- 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 a format whose features contain FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
- If the 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 the 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
- The value of depthResolveMode must be one of the bits set in VkPhysicalDeviceDepthStencilResolvePropertiesKHR::supportedDepthResolveModes or RESOLVE_MODE_NONE_KHR
- The value of stencilResolveMode must be one of the bits set in VkPhysicalDeviceDepthStencilResolvePropertiesKHR::supportedStencilResolveModes or RESOLVE_MODE_NONE_KHR
- If the VkFormat of pDepthStencilResolveAttachment has both depth and stencil components, VkPhysicalDeviceDepthStencilResolvePropertiesKHR::independentResolve is FALSE, and VkPhysicalDeviceDepthStencilResolvePropertiesKHR::independentResolveNone is FALSE, then the values of depthResolveMode and stencilResolveMode must be identical
- If the VkFormat of pDepthStencilResolveAttachment has both depth and stencil components, VkPhysicalDeviceDepthStencilResolvePropertiesKHR::independentResolve is FALSE and VkPhysicalDeviceDepthStencilResolvePropertiesKHR::independentResolveNone is TRUE, then the values of depthResolveMode and stencilResolveMode must be identical or one of them must be RESOLVE_MODE_NONE_KHR
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_SUBPASS_DESCRIPTION_DEPTH_STENCIL_RESOLVE_KHR
- depthResolveMode must be a valid VkResolveModeFlagBitsKHR value
- stencilResolveMode must be a valid VkResolveModeFlagBitsKHR value
- If pDepthStencilResolveAttachment is not NULL, pDepthStencilResolveAttachment must be a valid pointer to a valid VkAttachmentReference2KHR structure
See Also

VkAttachmentReference2KHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- depthResolveMode – a bitmask of VkResolveModeFlagBitsKHR describing the depth resolve mode.
- stencilResolveMode – a bitmask of VkResolveModeFlagBitsKHR describing the stencil resolve mode.
- pDepthStencilResolveAttachment – an optional VkAttachmentReference structure defining the depth/stencil resolve attachment for this subpass and its layout.
Layout
```
 struct VkSubpassDescriptionDepthStencilResolveKHR {
     VkStructureType sType;
     void const * pNext;
     VkResolveModeFlagBitsKHR depthResolveMode;
     VkResolveModeFlagBitsKHR stencilResolveMode;
     VkAttachmentReference2KHR const * pDepthStencilResolveAttachment;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkSubpassDescriptionDepthStencilResolveKHR.Buffer` An array of `VkSubpassDescriptionDepthStencilResolveKHR` structs.

Field Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkSubpassDescriptionDepthStencilResolveKHR`	`calloc()` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR` instance allocated with `memCalloc`.
`static VkSubpassDescriptionDepthStencilResolveKHR.Buffer`	`calloc(int capacity)` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR.Buffer` instance allocated with `memCalloc`.
`static VkSubpassDescriptionDepthStencilResolveKHR`	`callocStack()` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSubpassDescriptionDepthStencilResolveKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSubpassDescriptionDepthStencilResolveKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSubpassDescriptionDepthStencilResolveKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSubpassDescriptionDepthStencilResolveKHR`	`create()` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR` instance allocated with `BufferUtils`.
`static VkSubpassDescriptionDepthStencilResolveKHR.Buffer`	`create(int capacity)` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR.Buffer` instance allocated with `BufferUtils`.
`static VkSubpassDescriptionDepthStencilResolveKHR`	`create(long address)` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR` instance for the specified memory address.
`static VkSubpassDescriptionDepthStencilResolveKHR.Buffer`	`create(long address, int capacity)` Create a `VkSubpassDescriptionDepthStencilResolveKHR.Buffer` instance at the specified memory.
`static VkSubpassDescriptionDepthStencilResolveKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSubpassDescriptionDepthStencilResolveKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`depthResolveMode()` Returns the value of the `depthResolveMode` field.
`VkSubpassDescriptionDepthStencilResolveKHR`	`depthResolveMode(int value)` Sets the specified value to the `depthResolveMode` field.
`static VkSubpassDescriptionDepthStencilResolveKHR`	`malloc()` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR` instance allocated with `memAlloc`.
`static VkSubpassDescriptionDepthStencilResolveKHR.Buffer`	`malloc(int capacity)` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR.Buffer` instance allocated with `memAlloc`.
`static VkSubpassDescriptionDepthStencilResolveKHR`	`mallocStack()` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR` instance allocated on the thread-local `MemoryStack`.
`static VkSubpassDescriptionDepthStencilResolveKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSubpassDescriptionDepthStencilResolveKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSubpassDescriptionDepthStencilResolveKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSubpassDescriptionDepthStencilResolveKHR` 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 VkAttachmentReference2KHR`	`npDepthStencilResolveAttachment(long struct)` Unsafe version of `pDepthStencilResolveAttachment()`.
`static void`	`npDepthStencilResolveAttachment(long struct, VkAttachmentReference2KHR 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`.
`VkAttachmentReference2KHR`	`pDepthStencilResolveAttachment()` Returns a `VkAttachmentReference2KHR` view of the struct pointed to by the `pDepthStencilResolveAttachment` field.
`VkSubpassDescriptionDepthStencilResolveKHR`	`pDepthStencilResolveAttachment(VkAttachmentReference2KHR value)` Sets the address of the specified `VkAttachmentReference2KHR` to the `pDepthStencilResolveAttachment` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkSubpassDescriptionDepthStencilResolveKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkSubpassDescriptionDepthStencilResolveKHR`	`set(int sType, long pNext, int depthResolveMode, int stencilResolveMode, VkAttachmentReference2KHR pDepthStencilResolveAttachment)` Initializes this struct with the specified values.
`VkSubpassDescriptionDepthStencilResolveKHR`	`set(VkSubpassDescriptionDepthStencilResolveKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stencilResolveMode()` Returns the value of the `stencilResolveMode` field.
`VkSubpassDescriptionDepthStencilResolveKHR`	`stencilResolveMode(int value)` Sets the specified value to the `stencilResolveMode` field.
`int`	`sType()` Returns the value of the `sType` field.
`VkSubpassDescriptionDepthStencilResolveKHR`	`sType(int value)` Sets the specified value to the `sType` field.

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

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 Detail
- 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.
- DEPTHRESOLVEMODE
```
public static final int DEPTHRESOLVEMODE
```
  The struct member offsets.
- STENCILRESOLVEMODE
```
public static final int STENCILRESOLVEMODE
```
  The struct member offsets.
- PDEPTHSTENCILRESOLVEATTACHMENT
```
public static final int PDEPTHSTENCILRESOLVEATTACHMENT
```
  The struct member offsets.

Constructor Detail
- VkSubpassDescriptionDepthStencilResolveKHR
```
public VkSubpassDescriptionDepthStencilResolveKHR(java.nio.ByteBuffer container)
```
  Creates a VkSubpassDescriptionDepthStencilResolveKHR 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()
```
Returns the value of the sType field.

pNext
```
public long pNext()
```
Returns the value of the pNext field.

depthResolveMode
```
public int depthResolveMode()
```
Returns the value of the depthResolveMode field.

stencilResolveMode
```
public int stencilResolveMode()
```
Returns the value of the stencilResolveMode field.

pDepthStencilResolveAttachment
```
@Nullable
public VkAttachmentReference2KHR pDepthStencilResolveAttachment()
```
Returns a VkAttachmentReference2KHR view of the struct pointed to by the pDepthStencilResolveAttachment field.

sType

public VkSubpassDescriptionDepthStencilResolveKHR sType(int value)

Sets the specified value to the sType field.

pNext

public VkSubpassDescriptionDepthStencilResolveKHR pNext(long value)

Sets the specified value to the pNext field.

depthResolveMode

public VkSubpassDescriptionDepthStencilResolveKHR depthResolveMode(int value)

Sets the specified value to the depthResolveMode field.

stencilResolveMode

public VkSubpassDescriptionDepthStencilResolveKHR stencilResolveMode(int value)

Sets the specified value to the stencilResolveMode field.

pDepthStencilResolveAttachment

public VkSubpassDescriptionDepthStencilResolveKHR pDepthStencilResolveAttachment(@Nullable
                                                                                 VkAttachmentReference2KHR value)

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

set

public VkSubpassDescriptionDepthStencilResolveKHR set(int sType,
                                                      long pNext,
                                                      int depthResolveMode,
                                                      int stencilResolveMode,
                                                      @Nullable
                                                      VkAttachmentReference2KHR pDepthStencilResolveAttachment)

Initializes this struct with the specified values.

set

public VkSubpassDescriptionDepthStencilResolveKHR set(VkSubpassDescriptionDepthStencilResolveKHR src)

Copies the specified struct data to this struct.

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

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

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

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

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

createSafe

@Nullable
public static VkSubpassDescriptionDepthStencilResolveKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Parameters:

capacity - the buffer capacity

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

Parameters:

capacity - the buffer capacity

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

Parameters:

capacity - the buffer capacity

create

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

Create a VkSubpassDescriptionDepthStencilResolveKHR.Buffer instance at the specified memory.

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

createSafe

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

Like create, but returns null if address is NULL.

mallocStack
```
public static VkSubpassDescriptionDepthStencilResolveKHR mallocStack()
```
Returns a new VkSubpassDescriptionDepthStencilResolveKHR instance allocated on the thread-local MemoryStack.

callocStack
```
public static VkSubpassDescriptionDepthStencilResolveKHR callocStack()
```
Returns a new VkSubpassDescriptionDepthStencilResolveKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

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

Parameters:

stack - the stack from which to allocate

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

Parameters:

stack - the stack from which to allocate

mallocStack
```
public static VkSubpassDescriptionDepthStencilResolveKHR.Buffer mallocStack(int capacity)
```
Returns a new VkSubpassDescriptionDepthStencilResolveKHR.Buffer instance allocated on the thread-local MemoryStack.

Parameters:

capacity - the buffer capacity

callocStack
```
public static VkSubpassDescriptionDepthStencilResolveKHR.Buffer callocStack(int capacity)
```
Returns a new VkSubpassDescriptionDepthStencilResolveKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

mallocStack

public static VkSubpassDescriptionDepthStencilResolveKHR.Buffer mallocStack(int capacity,
                                                                            org.lwjgl.system.MemoryStack stack)

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

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

callocStack
```
public static VkSubpassDescriptionDepthStencilResolveKHR.Buffer callocStack(int capacity,
                                                                            org.lwjgl.system.MemoryStack stack)
```
Returns a new VkSubpassDescriptionDepthStencilResolveKHR.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 VkAttachmentReference2KHR 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
                                                   VkAttachmentReference2KHR value)

Unsafe version of pDepthStencilResolveAttachment.

Class VkSubpassDescriptionDepthStencilResolveKHR

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

DEPTHRESOLVEMODE

STENCILRESOLVEMODE

PDEPTHSTENCILRESOLVEATTACHMENT

Constructor Detail

VkSubpassDescriptionDepthStencilResolveKHR

Method Detail

sizeof

sType

pNext

depthResolveMode

stencilResolveMode

pDepthStencilResolveAttachment

sType

pNext

depthResolveMode

stencilResolveMode

pDepthStencilResolveAttachment

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

ndepthResolveMode

nstencilResolveMode

npDepthStencilResolveAttachment

nsType

npNext

ndepthResolveMode

nstencilResolveMode

npDepthStencilResolveAttachment