VkAttachmentDescriptionStencilLayoutKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkAttachmentDescriptionStencilLayoutKHR
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_KHR, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, 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_KHR, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, 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_KHR
- stencilInitialLayout must be a valid VkImageLayout value
- stencilFinalLayout must be a valid VkImageLayout value
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- stencilInitialLayout – the layout the stencil aspect of the attachment image subresource will be in when a render pass instance begins.
- stencilFinalLayout – the layout the stencil aspect of the attachment image subresource will be transitioned to when a render pass instance ends.
Layout
```
 struct VkAttachmentDescriptionStencilLayoutKHR {
     VkStructureType sType;
     void * pNext;
     VkImageLayout stencilInitialLayout;
     VkImageLayout stencilFinalLayout;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkAttachmentDescriptionStencilLayoutKHR.Buffer
An array of VkAttachmentDescriptionStencilLayoutKHR 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`	`VkAttachmentDescriptionStencilLayoutKHR.Buffer` An array of `VkAttachmentDescriptionStencilLayoutKHR` structs.

Field Summary

Fields
Modifier and Type	Field and 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` The struct member offsets.
`static int`	`STENCILINITIALLAYOUT` 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
`VkAttachmentDescriptionStencilLayoutKHR(java.nio.ByteBuffer container)` Creates a `VkAttachmentDescriptionStencilLayoutKHR` 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 VkAttachmentDescriptionStencilLayoutKHR`	`calloc()` Returns a new `VkAttachmentDescriptionStencilLayoutKHR` instance allocated with `memCalloc`.
`static VkAttachmentDescriptionStencilLayoutKHR.Buffer`	`calloc(int capacity)` Returns a new `VkAttachmentDescriptionStencilLayoutKHR.Buffer` instance allocated with `memCalloc`.
`static VkAttachmentDescriptionStencilLayoutKHR`	`callocStack()` Returns a new `VkAttachmentDescriptionStencilLayoutKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescriptionStencilLayoutKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkAttachmentDescriptionStencilLayoutKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescriptionStencilLayoutKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentDescriptionStencilLayoutKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescriptionStencilLayoutKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentDescriptionStencilLayoutKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkAttachmentDescriptionStencilLayoutKHR`	`create()` Returns a new `VkAttachmentDescriptionStencilLayoutKHR` instance allocated with `BufferUtils`.
`static VkAttachmentDescriptionStencilLayoutKHR.Buffer`	`create(int capacity)` Returns a new `VkAttachmentDescriptionStencilLayoutKHR.Buffer` instance allocated with `BufferUtils`.
`static VkAttachmentDescriptionStencilLayoutKHR`	`create(long address)` Returns a new `VkAttachmentDescriptionStencilLayoutKHR` instance for the specified memory address.
`static VkAttachmentDescriptionStencilLayoutKHR.Buffer`	`create(long address, int capacity)` Create a `VkAttachmentDescriptionStencilLayoutKHR.Buffer` instance at the specified memory.
`static VkAttachmentDescriptionStencilLayoutKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkAttachmentDescriptionStencilLayoutKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkAttachmentDescriptionStencilLayoutKHR`	`malloc()` Returns a new `VkAttachmentDescriptionStencilLayoutKHR` instance allocated with `memAlloc`.
`static VkAttachmentDescriptionStencilLayoutKHR.Buffer`	`malloc(int capacity)` Returns a new `VkAttachmentDescriptionStencilLayoutKHR.Buffer` instance allocated with `memAlloc`.
`static VkAttachmentDescriptionStencilLayoutKHR`	`mallocStack()` Returns a new `VkAttachmentDescriptionStencilLayoutKHR` instance allocated on the thread-local `MemoryStack`.
`static VkAttachmentDescriptionStencilLayoutKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkAttachmentDescriptionStencilLayoutKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkAttachmentDescriptionStencilLayoutKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentDescriptionStencilLayoutKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkAttachmentDescriptionStencilLayoutKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkAttachmentDescriptionStencilLayoutKHR` 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()` Returns the value of the `pNext` field.
`VkAttachmentDescriptionStencilLayoutKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkAttachmentDescriptionStencilLayoutKHR`	`set(int sType, long pNext, int stencilInitialLayout, int stencilFinalLayout)` Initializes this struct with the specified values.
`VkAttachmentDescriptionStencilLayoutKHR`	`set(VkAttachmentDescriptionStencilLayoutKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stencilFinalLayout()` Returns the value of the `stencilFinalLayout` field.
`VkAttachmentDescriptionStencilLayoutKHR`	`stencilFinalLayout(int value)` Sets the specified value to the `stencilFinalLayout` field.
`int`	`stencilInitialLayout()` Returns the value of the `stencilInitialLayout` field.
`VkAttachmentDescriptionStencilLayoutKHR`	`stencilInitialLayout(int value)` Sets the specified value to the `stencilInitialLayout` field.
`int`	`sType()` Returns the value of the `sType` field.
`VkAttachmentDescriptionStencilLayoutKHR`	`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.
  - STENCILINITIALLAYOUT
```
public static final int STENCILINITIALLAYOUT
```
    The struct member offsets.
  - STENCILFINALLAYOUT
```
public static final int STENCILFINALLAYOUT
```
    The struct member offsets.
- Constructor Detail
  - VkAttachmentDescriptionStencilLayoutKHR
```
public VkAttachmentDescriptionStencilLayoutKHR(java.nio.ByteBuffer container)
```
    Creates a VkAttachmentDescriptionStencilLayoutKHR 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.
  - stencilInitialLayout
```
public int stencilInitialLayout()
```
    Returns the value of the stencilInitialLayout field.
  - stencilFinalLayout
```
public int stencilFinalLayout()
```
    Returns the value of the stencilFinalLayout field.
  - sType
```
public VkAttachmentDescriptionStencilLayoutKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkAttachmentDescriptionStencilLayoutKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - stencilInitialLayout
```
public VkAttachmentDescriptionStencilLayoutKHR stencilInitialLayout(int value)
```
    Sets the specified value to the stencilInitialLayout field.
  - stencilFinalLayout
```
public VkAttachmentDescriptionStencilLayoutKHR stencilFinalLayout(int value)
```
    Sets the specified value to the stencilFinalLayout field.
  - set
```
public VkAttachmentDescriptionStencilLayoutKHR set(int sType,
                                                   long pNext,
                                                   int stencilInitialLayout,
                                                   int stencilFinalLayout)
```
    Initializes this struct with the specified values.
  - set
```
public VkAttachmentDescriptionStencilLayoutKHR set(VkAttachmentDescriptionStencilLayoutKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkAttachmentDescriptionStencilLayoutKHR malloc()
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkAttachmentDescriptionStencilLayoutKHR calloc()
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkAttachmentDescriptionStencilLayoutKHR create()
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR instance allocated with BufferUtils.
  - create
```
public static VkAttachmentDescriptionStencilLayoutKHR create(long address)
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkAttachmentDescriptionStencilLayoutKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkAttachmentDescriptionStencilLayoutKHR.Buffer malloc(int capacity)
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkAttachmentDescriptionStencilLayoutKHR.Buffer calloc(int capacity)
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentDescriptionStencilLayoutKHR.Buffer create(int capacity)
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkAttachmentDescriptionStencilLayoutKHR.Buffer create(long address,
                                                                    int capacity)
```
    Create a VkAttachmentDescriptionStencilLayoutKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkAttachmentDescriptionStencilLayoutKHR.Buffer createSafe(long address,
                                                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkAttachmentDescriptionStencilLayoutKHR mallocStack()
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkAttachmentDescriptionStencilLayoutKHR callocStack()
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkAttachmentDescriptionStencilLayoutKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkAttachmentDescriptionStencilLayoutKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkAttachmentDescriptionStencilLayoutKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAttachmentDescriptionStencilLayoutKHR.Buffer callocStack(int capacity)
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkAttachmentDescriptionStencilLayoutKHR.Buffer mallocStack(int capacity,
                                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkAttachmentDescriptionStencilLayoutKHR.Buffer callocStack(int capacity,
                                                                         org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkAttachmentDescriptionStencilLayoutKHR.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 VkAttachmentDescriptionStencilLayoutKHR

Valid Usage

Valid Usage (Implicit)

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

STENCILINITIALLAYOUT

STENCILFINALLAYOUT

Constructor Detail

VkAttachmentDescriptionStencilLayoutKHR

Method Detail

sizeof

sType

pNext

stencilInitialLayout

stencilFinalLayout

sType

pNext

stencilInitialLayout

stencilFinalLayout

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nstencilInitialLayout

nstencilFinalLayout

nsType

npNext

nstencilInitialLayout

nstencilFinalLayout