VkImageStencilUsageCreateInfoEXT (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

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 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_EXT
- stencilUsage must be a valid combination of VkImageUsageFlagBits values
- stencilUsage must not be 0
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- stencilUsage – a bitmask of VkImageUsageFlagBits describing the intended usage of the stencil aspect of the image.
Layout
```
 struct VkImageStencilUsageCreateInfoEXT {
     VkStructureType sType;
     void const * pNext;
     VkImageUsageFlags stencilUsage;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Description

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

STENCILUSAGE

Constructor Detail

VkImageStencilUsageCreateInfoEXT

Method Detail

sizeof

sType

pNext

stencilUsage

sType

pNext

stencilUsage

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nstencilUsage

nsType

npNext

nstencilUsage