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 and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkImageStencilUsageCreateInfo.Buffer An array of `VkImageStencilUsageCreateInfo` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	PNEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STENCILUSAGE The struct member offsets.
public static final int	STYPE The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkImageStencilUsageCreateInfo(long address, ByteBuffer container)
public	VkImageStencilUsageCreateInfo(ByteBuffer container) Creates a `VkImageStencilUsageCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkImageStencilUsageCreateInfo	calloc() Returns a new `VkImageStencilUsageCreateInfo` instance allocated with `memCalloc`.
public static VkImageStencilUsageCreateInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated with `memCalloc`.
public static VkImageStencilUsageCreateInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkImageStencilUsageCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkImageStencilUsageCreateInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkImageStencilUsageCreateInfo	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkImageStencilUsageCreateInfo	create() Returns a new `VkImageStencilUsageCreateInfo` instance allocated with `BufferUtils`.
public static VkImageStencilUsageCreateInfo	create(long address) Returns a new `VkImageStencilUsageCreateInfo` instance for the specified memory address.
public static VkImageStencilUsageCreateInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated with `BufferUtils`.
public static VkImageStencilUsageCreateInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkImageStencilUsageCreateInfo.Buffer` instance at the specified memory.
public static VkImageStencilUsageCreateInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkImageStencilUsageCreateInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkImageStencilUsageCreateInfo	malloc() Returns a new `VkImageStencilUsageCreateInfo` instance allocated with `memAlloc`.
public static VkImageStencilUsageCreateInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated with `memAlloc`.
public static VkImageStencilUsageCreateInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkImageStencilUsageCreateInfo` instance allocated on the specified `MemoryStack`.
public static VkImageStencilUsageCreateInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nstencilUsage(long struct) Unsafe version of `stencilUsage`.
public static void	nstencilUsage(long struct, int value) Unsafe version of `stencilUsage`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkImageStencilUsageCreateInfo	pNext(long value) Sets the specified value to the `pNext` field.
public VkImageStencilUsageCreateInfo	set(int sType, long pNext, int stencilUsage) Initializes this struct with the specified values.
public VkImageStencilUsageCreateInfo	Returns: this struct set(VkImageStencilUsageCreateInfo the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	stencilUsage() a bitmask of `VkImageUsageFlagBits` describing the intended usage of the stencil aspect of the image.
public VkImageStencilUsageCreateInfo	stencilUsage(int value) Sets the specified value to the `stencilUsage` field.
public int	sType() a `VkStructureType` value identifying this structure.
public VkImageStencilUsageCreateInfo	sType(int value) Sets the specified value to the `sType` field.
public VkImageStencilUsageCreateInfo	sType$Default() Sets the `STRUCTURE_TYPE_IMAGE_STENCIL_USAGE_CREATE_INFO` value to the `sType` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STENCILUSAGE	back to summary
public static final int STENCILUSAGE The struct member offsets.

STYPE	back to summary
public static final int STYPE The struct member offsets.

Constructor Detail

VkImageStencilUsageCreateInfo	back to summary
protected VkImageStencilUsageCreateInfo(long address, ByteBuffer container)

VkImageStencilUsageCreateInfo back to summary

VkImageStencilUsageCreateInfo	back to summary
public VkImageStencilUsageCreateInfo(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.

public VkImageStencilUsageCreateInfo(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

calloc	back to summary
public static VkImageStencilUsageCreateInfo calloc() Returns a new `VkImageStencilUsageCreateInfo` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkImageStencilUsageCreateInfo.Buffer calloc(int capacity) Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkImageStencilUsageCreateInfo.Buffer calloc(int capacity)

Returns a new VkImageStencilUsageCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkImageStencilUsageCreateInfo calloc(MemoryStack stack) Returns a new `VkImageStencilUsageCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkImageStencilUsageCreateInfo calloc(MemoryStack stack)

Returns a new VkImageStencilUsageCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkImageStencilUsageCreateInfo.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkImageStencilUsageCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkImageStencilUsageCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

create back to summary

create	back to summary
protected VkImageStencilUsageCreateInfo create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected VkImageStencilUsageCreateInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static VkImageStencilUsageCreateInfo create() Returns a new `VkImageStencilUsageCreateInfo` instance allocated with `BufferUtils`.

create	back to summary
public static VkImageStencilUsageCreateInfo create(long address) Returns a new `VkImageStencilUsageCreateInfo` instance for the specified memory address.

create back to summary

create	back to summary
public static VkImageStencilUsageCreateInfo.Buffer create(int capacity) Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkImageStencilUsageCreateInfo.Buffer create(int capacity)

Returns a new VkImageStencilUsageCreateInfo.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkImageStencilUsageCreateInfo.Buffer create(long address, int capacity) Create a `VkImageStencilUsageCreateInfo.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkImageStencilUsageCreateInfo.Buffer create(long address, int capacity)

Create a VkImageStencilUsageCreateInfo.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkImageStencilUsageCreateInfo createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkImageStencilUsageCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkImageStencilUsageCreateInfo.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkImageStencilUsageCreateInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static VkImageStencilUsageCreateInfo malloc() Returns a new `VkImageStencilUsageCreateInfo` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkImageStencilUsageCreateInfo.Buffer malloc(int capacity) Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkImageStencilUsageCreateInfo.Buffer malloc(int capacity)

Returns a new VkImageStencilUsageCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkImageStencilUsageCreateInfo malloc(MemoryStack stack) Returns a new `VkImageStencilUsageCreateInfo` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkImageStencilUsageCreateInfo malloc(MemoryStack stack)

Returns a new VkImageStencilUsageCreateInfo instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkImageStencilUsageCreateInfo.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkImageStencilUsageCreateInfo.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkImageStencilUsageCreateInfo.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkImageStencilUsageCreateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nstencilUsage	back to summary
public static int nstencilUsage(long struct) Unsafe version of `stencilUsage`.

nstencilUsage	back to summary
public static void nstencilUsage(long struct, int value) Unsafe version of `stencilUsage`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void const *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkImageStencilUsageCreateInfo pNext(long value) Sets the specified value to the `pNext` field.

set	back to summary
public VkImageStencilUsageCreateInfo set(int sType, long pNext, int stencilUsage) Initializes this struct with the specified values.

set	back to summary
public VkImageStencilUsageCreateInfo set(VkImageStencilUsageCreateInfo src) Copies the specified struct data to this struct. Parameters src:VkImageStencilUsageCreateInfo the source struct Returns:VkImageStencilUsageCreateInfo this struct

set

back to summary

public VkImageStencilUsageCreateInfo set(VkImageStencilUsageCreateInfo src)

Copies the specified struct data to this struct.

Parameters

src:VkImageStencilUsageCreateInfo: the source struct

Returns:VkImageStencilUsageCreateInfo

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

stencilUsage back to summary

stencilUsage	back to summary
public int stencilUsage() a bitmask of `VkImageUsageFlagBits` describing the intended usage of the stencil aspect of the image. Annotations @NativeType:VkImageUsageFlags

public int stencilUsage()

a bitmask of VkImageUsageFlagBits describing the intended usage of the stencil aspect of the image.

Annotations

@NativeType:VkImageUsageFlags

stencilUsage	back to summary
public VkImageStencilUsageCreateInfo stencilUsage(int value) Sets the specified value to the `stencilUsage` field.

sType back to summary

sType	back to summary
public int sType() a `VkStructureType` value identifying this structure. Annotations @NativeType:VkStructureType

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkImageStencilUsageCreateInfo sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkImageStencilUsageCreateInfo sType$Default() Sets the `STRUCTURE_TYPE_IMAGE_STENCIL_USAGE_CREATE_INFO` value to the `sType` field.

org.lwjgl.vulkan back to summary

public Class VkImageStencilUsageCreateInfo.Buffer

Class Inheritance

extends StructBuffer<VkImageStencilUsageCreateInfo, VkImageStencilUsageCreateInfo.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkImageStencilUsageCreateInfo.Buffer

All Implemented Interfaces

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

Known Direct Subclasses

org.lwjgl.vulkan.VkImageStencilUsageCreateInfoEXT.Buffer

An array of VkImageStencilUsageCreateInfo structs.

Field Summary

Modifier and Type	Field and Description
private static final VkImageStencilUsageCreateInfo	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkImageStencilUsageCreateInfo.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
protected VkImageStencilUsageCreateInfo	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkImageStencilUsageCreateInfo#pNext` field. pNext()
public VkImageStencilUsageCreateInfo.Buffer	pNext(long value) Sets the specified value to the `VkImageStencilUsageCreateInfo#pNext` field.
protected VkImageStencilUsageCreateInfo.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkImageStencilUsageCreateInfo#stencilUsage` field. stencilUsage()
public VkImageStencilUsageCreateInfo.Buffer	stencilUsage(int value) Sets the specified value to the `VkImageStencilUsageCreateInfo#stencilUsage` field.
public int	Returns: the value of the `VkImageStencilUsageCreateInfo#sType` field. sType()
public VkImageStencilUsageCreateInfo.Buffer	sType(int value) Sets the specified value to the `VkImageStencilUsageCreateInfo#sType` field.
public VkImageStencilUsageCreateInfo.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_IMAGE_STENCIL_USAGE_CREATE_INFO` value to the `VkImageStencilUsageCreateInfo#sType` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkImageStencilUsageCreateInfo ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkImageStencilUsageCreateInfo.Buffer` instance backed by the specified container. Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by `VkImageStencilUsageCreateInfo#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkImageStencilUsageCreateInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkImageStencilUsageCreateInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory	back to summary
protected VkImageStencilUsageCreateInfo getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected VkImageStencilUsageCreateInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

pNext	back to summary
public long pNext() Returns:long the value of the `VkImageStencilUsageCreateInfo#pNext` field. Annotations @NativeType:void const *

pNext	back to summary
public VkImageStencilUsageCreateInfo.Buffer pNext(long value) Sets the specified value to the `VkImageStencilUsageCreateInfo#pNext` field.

self

back to summary

protected VkImageStencilUsageCreateInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

stencilUsage	back to summary
public int stencilUsage() Returns:int the value of the `VkImageStencilUsageCreateInfo#stencilUsage` field. Annotations @NativeType:VkImageUsageFlags

stencilUsage	back to summary
public VkImageStencilUsageCreateInfo.Buffer stencilUsage(int value) Sets the specified value to the `VkImageStencilUsageCreateInfo#stencilUsage` field.

sType	back to summary
public int sType() Returns:int the value of the `VkImageStencilUsageCreateInfo#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkImageStencilUsageCreateInfo.Buffer sType(int value) Sets the specified value to the `VkImageStencilUsageCreateInfo#sType` field.

sType$Default	back to summary
public VkImageStencilUsageCreateInfo.Buffer sType$Default() Sets the `STRUCTURE_TYPE_IMAGE_STENCIL_USAGE_CREATE_INFO` value to the `VkImageStencilUsageCreateInfo#sType` field.