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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkImageStencilUsageCreateInfoEXT
```
public class VkImageStencilUsageCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Specify separate usage flags for the stencil aspect of a depth-stencil image.
Description

If the pNext chain of VkImageCreateInfo includes a VkImageStencilUsageCreateInfo structure, then that structure includes the usage flags specific to the stencil aspect of the image for an image with a depth-stencil format.

This structure specifies image usages which only apply to the stencil aspect of a depth/stencil format image. When this structure is included in the pNext chain of VkImageCreateInfo, the stencil aspect of the image must only be used as specified by stencilUsage. When this structure is not included in the pNext chain of VkImageCreateInfo, the stencil aspect of an image must only be used as specified by VkImageCreateInfo::usage. Use of other aspects of an image are unaffected by this structure.

This structure can also be included in the pNext chain of VkPhysicalDeviceImageFormatInfo2 to query additional capabilities specific to image creation parameter combinations including a separate set of usage flags for the stencil aspect of the image using GetPhysicalDeviceImageFormatProperties2. When this structure is not included in the pNext chain of VkPhysicalDeviceImageFormatInfo2 then the implicit value of stencilUsage matches that of VkPhysicalDeviceImageFormatInfo2::usage.

Valid Usage
- If stencilUsage includes IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT, it must not include bits other than IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT or IMAGE_USAGE_INPUT_ATTACHMENT_BIT
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_IMAGE_STENCIL_USAGE_CREATE_INFO
- stencilUsage must be a valid combination of VkImageUsageFlagBits values
- stencilUsage must not be 0
Layout
```
 struct VkImageStencilUsageCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkImageUsageFlags stencilUsage();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkImageStencilUsageCreateInfo.Buffer
An array of VkImageStencilUsageCreateInfo 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`	`STENCILUSAGE 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
`VkImageStencilUsageCreateInfo(java.nio.ByteBuffer container)`	Creates a `VkImageStencilUsageCreateInfo` 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 VkImageStencilUsageCreateInfo`	`calloc()`	Returns a new `VkImageStencilUsageCreateInfo` instance allocated with `memCalloc`.
`static VkImageStencilUsageCreateInfo.Buffer`	`calloc(int capacity)`	Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkImageStencilUsageCreateInfo.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageStencilUsageCreateInfo`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImageStencilUsageCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageStencilUsageCreateInfo`	`create()`	Returns a new `VkImageStencilUsageCreateInfo` instance allocated with `BufferUtils`.
`static VkImageStencilUsageCreateInfo.Buffer`	`create(int capacity)`	Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkImageStencilUsageCreateInfo`	`create(long address)`	Returns a new `VkImageStencilUsageCreateInfo` instance for the specified memory address.
`static VkImageStencilUsageCreateInfo.Buffer`	`create(long address, int capacity)`	Create a `VkImageStencilUsageCreateInfo.Buffer` instance at the specified memory.
`static VkImageStencilUsageCreateInfo`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageStencilUsageCreateInfo.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageStencilUsageCreateInfo`	`malloc()`	Returns a new `VkImageStencilUsageCreateInfo` instance allocated with `memAlloc`.
`static VkImageStencilUsageCreateInfo.Buffer`	`malloc(int capacity)`	Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkImageStencilUsageCreateInfo.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageStencilUsageCreateInfo`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkImageStencilUsageCreateInfo` 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`	`nstencilUsage(long struct)`	Unsafe version of `stencilUsage()`.
`static void`	`nstencilUsage(long struct, int value)`	Unsafe version of `stencilUsage`.
`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.
`VkImageStencilUsageCreateInfo`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkImageStencilUsageCreateInfo`	`set(int sType, long pNext, int stencilUsage)`	Initializes this struct with the specified values.
`VkImageStencilUsageCreateInfo`	`set(VkImageStencilUsageCreateInfo src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`stencilUsage()`	a bitmask of `VkImageUsageFlagBits` describing the intended usage of the stencil aspect of the image.
`VkImageStencilUsageCreateInfo`	`stencilUsage(int value)`	Sets the specified value to the `stencilUsage()` field.
`int`	`sType()`	the type of this structure.
`VkImageStencilUsageCreateInfo`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkImageStencilUsageCreateInfo`	`sType$Default()`	Sets the `STRUCTURE_TYPE_IMAGE_STENCIL_USAGE_CREATE_INFO` 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, STENCILUSAGE
    
    The struct member offsets.
- Constructor Detail
  - VkImageStencilUsageCreateInfo
```
public VkImageStencilUsageCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkImageStencilUsageCreateInfo 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.
  - stencilUsage
```
public int stencilUsage()
```
    a bitmask of VkImageUsageFlagBits describing the intended usage of the stencil aspect of the image.
  - sType
```
public VkImageStencilUsageCreateInfo sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkImageStencilUsageCreateInfo sType$Default()
```
    Sets the STRUCTURE_TYPE_IMAGE_STENCIL_USAGE_CREATE_INFO value to the sType() field.
  - pNext
```
public VkImageStencilUsageCreateInfo pNext(long value)
```
    Sets the specified value to the pNext() field.
  - stencilUsage
```
public VkImageStencilUsageCreateInfo stencilUsage(int value)
```
    Sets the specified value to the stencilUsage() field.
  - set
```
public VkImageStencilUsageCreateInfo set(int sType,
                                         long pNext,
                                         int stencilUsage)
```
    Initializes this struct with the specified values.
  - set
```
public VkImageStencilUsageCreateInfo set(VkImageStencilUsageCreateInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkImageStencilUsageCreateInfo malloc()
```
    Returns a new VkImageStencilUsageCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkImageStencilUsageCreateInfo calloc()
```
    Returns a new VkImageStencilUsageCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkImageStencilUsageCreateInfo create()
```
    Returns a new VkImageStencilUsageCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkImageStencilUsageCreateInfo create(long address)
```
    Returns a new VkImageStencilUsageCreateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkImageStencilUsageCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkImageStencilUsageCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkImageStencilUsageCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkImageStencilUsageCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkImageStencilUsageCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageStencilUsageCreateInfo.Buffer create(int capacity)
```
    Returns a new VkImageStencilUsageCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageStencilUsageCreateInfo.Buffer create(long address,
                                                          int capacity)
```
    Create a VkImageStencilUsageCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkImageStencilUsageCreateInfo.Buffer createSafe(long address,
                                                              int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkImageStencilUsageCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageStencilUsageCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkImageStencilUsageCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageStencilUsageCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkImageStencilUsageCreateInfo.Buffer malloc(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageStencilUsageCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkImageStencilUsageCreateInfo.Buffer calloc(int capacity,
                                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageStencilUsageCreateInfo.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().
  - nstencilUsage
```
public static int nstencilUsage(long struct)
```
    Unsafe version of stencilUsage().
  - 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.
  - nstencilUsage
```
public static void nstencilUsage(long struct,
                                 int value)
```
    Unsafe version of stencilUsage.

Class VkImageStencilUsageCreateInfo

Description

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, STENCILUSAGE

Constructor Detail

VkImageStencilUsageCreateInfo

Method Detail

sizeof

sType

pNext

stencilUsage

sType

sType$Default

pNext

stencilUsage

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nstencilUsage

nsType

npNext

nstencilUsage