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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkAttachmentDescriptionStencilLayoutKHR
```
public class VkAttachmentDescriptionStencilLayout
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying an attachment description.
Valid Usage
- stencilInitialLayout must not be 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, or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
- stencilFinalLayout must not be 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, or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
- stencilFinalLayout must not be IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_STENCIL_LAYOUT
- stencilInitialLayout must be a valid VkImageLayout value
- stencilFinalLayout must be a valid VkImageLayout value
Layout
```
 struct VkAttachmentDescriptionStencilLayout {
     VkStructureType sType();
     void * pNext();
     VkImageLayout stencilInitialLayout();
     VkImageLayout stencilFinalLayout();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkAttachmentDescriptionStencilLayout.Buffer
An array of VkAttachmentDescriptionStencilLayout 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`	`PNEXT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STENCILFINALLAYOUT STENCILINITIALLAYOUT 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
`VkAttachmentDescriptionStencilLayout(java.nio.ByteBuffer container)`	Creates a `VkAttachmentDescriptionStencilLayout` 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 VkAttachmentDescriptionStencilLayout`	`calloc()`	Returns a new `VkAttachmentDescriptionStencilLayout` instance allocated with `memCalloc`.
`static VkAttachmentDescriptionStencilLayout.Buffer`	`calloc(int capacity)`	Returns a new `VkAttachmentDescriptionStencilLayout.Buffer` instance allocated with `memCalloc`.
`static VkAttachmentDescriptionStencilLayout.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentDescriptionStencilLayout.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescriptionStencilLayout`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentDescriptionStencilLayout` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescriptionStencilLayout`	`create()`	Returns a new `VkAttachmentDescriptionStencilLayout` instance allocated with `BufferUtils`.
`static VkAttachmentDescriptionStencilLayout.Buffer`	`create(int capacity)`	Returns a new `VkAttachmentDescriptionStencilLayout.Buffer` instance allocated with `BufferUtils`.
`static VkAttachmentDescriptionStencilLayout`	`create(long address)`	Returns a new `VkAttachmentDescriptionStencilLayout` instance for the specified memory address.
`static VkAttachmentDescriptionStencilLayout.Buffer`	`create(long address, int capacity)`	Create a `VkAttachmentDescriptionStencilLayout.Buffer` instance at the specified memory.
`static VkAttachmentDescriptionStencilLayout`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkAttachmentDescriptionStencilLayout.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkAttachmentDescriptionStencilLayout`	`malloc()`	Returns a new `VkAttachmentDescriptionStencilLayout` instance allocated with `memAlloc`.
`static VkAttachmentDescriptionStencilLayout.Buffer`	`malloc(int capacity)`	Returns a new `VkAttachmentDescriptionStencilLayout.Buffer` instance allocated with `memAlloc`.
`static VkAttachmentDescriptionStencilLayout.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentDescriptionStencilLayout.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAttachmentDescriptionStencilLayout`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkAttachmentDescriptionStencilLayout` 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`	`nstencilFinalLayout(long struct)`	Unsafe version of `stencilFinalLayout()`.
`static void`	`nstencilFinalLayout(long struct, int value)`	Unsafe version of `stencilFinalLayout`.
`static int`	`nstencilInitialLayout(long struct)`	Unsafe version of `stencilInitialLayout()`.
`static void`	`nstencilInitialLayout(long struct, int value)`	Unsafe version of `stencilInitialLayout`.
`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.
`VkAttachmentDescriptionStencilLayout`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkAttachmentDescriptionStencilLayout`	`set(int sType, long pNext, int stencilInitialLayout, int stencilFinalLayout)`	Initializes this struct with the specified values.
`VkAttachmentDescriptionStencilLayout`	`set(VkAttachmentDescriptionStencilLayout src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stencilFinalLayout()`	the layout the stencil aspect of the attachment image subresource will be transitioned to when a render pass instance ends.
`VkAttachmentDescriptionStencilLayout`	`stencilFinalLayout(int value)`	Sets the specified value to the `stencilFinalLayout()` field.
`int`	`stencilInitialLayout()`	the layout the stencil aspect of the attachment image subresource will be in when a render pass instance begins.
`VkAttachmentDescriptionStencilLayout`	`stencilInitialLayout(int value)`	Sets the specified value to the `stencilInitialLayout()` field.
`int`	`sType()`	the type of this structure.
`VkAttachmentDescriptionStencilLayout`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkAttachmentDescriptionStencilLayout`	`sType$Default()`	Sets the `STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_STENCIL_LAYOUT` 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, STENCILINITIALLAYOUT, STENCILFINALLAYOUT
    
    The struct member offsets.
- Constructor Detail
  - VkAttachmentDescriptionStencilLayout
```
public VkAttachmentDescriptionStencilLayout(java.nio.ByteBuffer container)
```
    Creates a VkAttachmentDescriptionStencilLayout 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.
  - stencilInitialLayout
```
public int stencilInitialLayout()
```
    the layout the stencil aspect of the attachment image subresource will be in when a render pass instance begins.
  - stencilFinalLayout
```
public int stencilFinalLayout()
```
    the layout the stencil aspect of the attachment image subresource will be transitioned to when a render pass instance ends.
  - sType
```
public VkAttachmentDescriptionStencilLayout sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkAttachmentDescriptionStencilLayout sType$Default()
```
    Sets the STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_STENCIL_LAYOUT value to the sType() field.
  - pNext
```
public VkAttachmentDescriptionStencilLayout pNext(long value)
```
    Sets the specified value to the pNext() field.
  - stencilInitialLayout
```
public VkAttachmentDescriptionStencilLayout stencilInitialLayout(int value)
```
    Sets the specified value to the stencilInitialLayout() field.
  - stencilFinalLayout
```
public VkAttachmentDescriptionStencilLayout stencilFinalLayout(int value)
```
    Sets the specified value to the stencilFinalLayout() field.
  - set
```
public VkAttachmentDescriptionStencilLayout set(int sType,
                                                long pNext,
                                                int stencilInitialLayout,
                                                int stencilFinalLayout)
```
    Initializes this struct with the specified values.
  - set
```
public VkAttachmentDescriptionStencilLayout set(VkAttachmentDescriptionStencilLayout src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkAttachmentDescriptionStencilLayout malloc()
```
    Returns a new VkAttachmentDescriptionStencilLayout instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkAttachmentDescriptionStencilLayout calloc()
```
    Returns a new VkAttachmentDescriptionStencilLayout instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkAttachmentDescriptionStencilLayout create()
```
    Returns a new VkAttachmentDescriptionStencilLayout instance allocated with BufferUtils.
  - create
```
public static VkAttachmentDescriptionStencilLayout create(long address)
```
    Returns a new VkAttachmentDescriptionStencilLayout instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkAttachmentDescriptionStencilLayout createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAttachmentDescriptionStencilLayout.Buffer malloc(int capacity)
```
    Returns a new VkAttachmentDescriptionStencilLayout.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkAttachmentDescriptionStencilLayout.Buffer calloc(int capacity)
```
    Returns a new VkAttachmentDescriptionStencilLayout.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentDescriptionStencilLayout.Buffer create(int capacity)
```
    Returns a new VkAttachmentDescriptionStencilLayout.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentDescriptionStencilLayout.Buffer create(long address,
                                                                 int capacity)
```
    Create a VkAttachmentDescriptionStencilLayout.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkAttachmentDescriptionStencilLayout.Buffer createSafe(long address,
                                                                     int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAttachmentDescriptionStencilLayout malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescriptionStencilLayout instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkAttachmentDescriptionStencilLayout calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescriptionStencilLayout instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkAttachmentDescriptionStencilLayout.Buffer malloc(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescriptionStencilLayout.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkAttachmentDescriptionStencilLayout.Buffer calloc(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescriptionStencilLayout.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().
  - nstencilInitialLayout
```
public static int nstencilInitialLayout(long struct)
```
    Unsafe version of stencilInitialLayout().
  - nstencilFinalLayout
```
public static int nstencilFinalLayout(long struct)
```
    Unsafe version of stencilFinalLayout().
  - 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.
  - nstencilInitialLayout
```
public static void nstencilInitialLayout(long struct,
                                         int value)
```
    Unsafe version of stencilInitialLayout.
  - nstencilFinalLayout
```
public static void nstencilFinalLayout(long struct,
                                       int value)
```
    Unsafe version of stencilFinalLayout.

Class VkAttachmentDescriptionStencilLayout

Valid Usage

Valid Usage (Implicit)

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, STENCILINITIALLAYOUT, STENCILFINALLAYOUT

Constructor Detail

VkAttachmentDescriptionStencilLayout

Method Detail

sizeof

sType

pNext

stencilInitialLayout

stencilFinalLayout

sType

sType$Default

pNext

stencilInitialLayout

stencilFinalLayout

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nstencilInitialLayout

nstencilFinalLayout

nsType

npNext

nstencilInitialLayout

nstencilFinalLayout