VkAttachmentReferenceStencilLayoutKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkAttachmentReferenceStencilLayoutKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying an attachment description.
Valid Usage
- stencilLayout must not be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_PREINITIALIZED, 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, IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_PRESENT_SRC_KHR
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_ATTACHMENT_REFERENCE_STENCIL_LAYOUT_KHR
- stencilLayout must be a valid VkImageLayout value
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- stencilLayout – a VkImageLayout value specifying the layout the stencil aspect of the attachment uses during the subpass.
Layout
```
 struct VkAttachmentReferenceStencilLayoutKHR {
     VkStructureType sType;
     void * pNext;
     VkImageLayout stencilLayout;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Class VkAttachmentReferenceStencilLayoutKHR

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

STENCILLAYOUT

Constructor Detail

VkAttachmentReferenceStencilLayoutKHR

Method Detail

sizeof

sType

pNext

stencilLayout

sType

pNext

stencilLayout

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nstencilLayout

nsType

npNext

nstencilLayout