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

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

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

Method Summary

Modifier and Type	Method and Description
public static VkClearDepthStencilValue	calloc() Returns a new `VkClearDepthStencilValue` instance allocated with `memCalloc`.
public static VkClearDepthStencilValue.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkClearDepthStencilValue.Buffer` instance allocated with `memCalloc`.
public static VkClearDepthStencilValue	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkClearDepthStencilValue` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkClearDepthStencilValue.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkClearDepthStencilValue.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkClearDepthStencilValue	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkClearDepthStencilValue	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkClearDepthStencilValue.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkClearDepthStencilValue.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkClearDepthStencilValue	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 VkClearDepthStencilValue	create() Returns a new `VkClearDepthStencilValue` instance allocated with `BufferUtils`.
public static VkClearDepthStencilValue	create(long address) Returns a new `VkClearDepthStencilValue` instance for the specified memory address.
public static VkClearDepthStencilValue.Buffer	create(int the buffer capacity capacity) Returns a new `VkClearDepthStencilValue.Buffer` instance allocated with `BufferUtils`.
public static VkClearDepthStencilValue.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkClearDepthStencilValue.Buffer` instance at the specified memory.
public static VkClearDepthStencilValue	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkClearDepthStencilValue.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public float	depth() the clear value for the depth aspect of the depth/stencil attachment.
public VkClearDepthStencilValue	depth(float value) Sets the specified value to the `depth` field.
public static VkClearDepthStencilValue	malloc() Returns a new `VkClearDepthStencilValue` instance allocated with `memAlloc`.
public static VkClearDepthStencilValue.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkClearDepthStencilValue.Buffer` instance allocated with `memAlloc`.
public static VkClearDepthStencilValue	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkClearDepthStencilValue` instance allocated on the specified `MemoryStack`.
public static VkClearDepthStencilValue.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkClearDepthStencilValue.Buffer` instance allocated on the specified `MemoryStack`.
public static VkClearDepthStencilValue	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkClearDepthStencilValue	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkClearDepthStencilValue.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkClearDepthStencilValue.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static float	ndepth(long struct) Unsafe version of `depth`.
public static void	ndepth(long struct, float value) Unsafe version of `depth`.
public static int	nstencil(long struct) Unsafe version of `stencil`.
public static void	nstencil(long struct, int value) Unsafe version of `stencil`.
public VkClearDepthStencilValue	set(float depth, int stencil) Initializes this struct with the specified values.
public VkClearDepthStencilValue	Returns: this struct set(VkClearDepthStencilValue 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	stencil() the clear value for the stencil aspect of the depth/stencil attachment.
public VkClearDepthStencilValue	stencil(int value) Sets the specified value to the `stencil` field.

Field Detail

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

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

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

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

Constructor Detail

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

VkClearDepthStencilValue back to summary

VkClearDepthStencilValue	back to summary
public VkClearDepthStencilValue(ByteBuffer container) Creates a `VkClearDepthStencilValue` 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 VkClearDepthStencilValue(ByteBuffer container)

Creates a VkClearDepthStencilValue 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 VkClearDepthStencilValue calloc() Returns a new `VkClearDepthStencilValue` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static VkClearDepthStencilValue.Buffer calloc(int capacity)

Returns a new VkClearDepthStencilValue.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 VkClearDepthStencilValue calloc(MemoryStack stack) Returns a new `VkClearDepthStencilValue` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkClearDepthStencilValue calloc(MemoryStack stack)

Returns a new VkClearDepthStencilValue 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 VkClearDepthStencilValue.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkClearDepthStencilValue.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 VkClearDepthStencilValue.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkClearDepthStencilValue.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

callocStack back to summary

callocStack	back to summary
public static VkClearDepthStencilValue callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearDepthStencilValue callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkClearDepthStencilValue callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearDepthStencilValue callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkClearDepthStencilValue.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearDepthStencilValue.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkClearDepthStencilValue.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearDepthStencilValue.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkClearDepthStencilValue 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 VkClearDepthStencilValue 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 VkClearDepthStencilValue create() Returns a new `VkClearDepthStencilValue` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkClearDepthStencilValue.Buffer create(int capacity)

Returns a new VkClearDepthStencilValue.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkClearDepthStencilValue.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 VkClearDepthStencilValue createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkClearDepthStencilValue createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

depth	back to summary
public float depth() the clear value for the depth aspect of the depth/stencil attachment. It is a floating-point value which is automatically converted to the attachment’s format.

depth	back to summary
public VkClearDepthStencilValue depth(float value) Sets the specified value to the `depth` field.

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

malloc back to summary

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

public static VkClearDepthStencilValue.Buffer malloc(int capacity)

Returns a new VkClearDepthStencilValue.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 VkClearDepthStencilValue malloc(MemoryStack stack) Returns a new `VkClearDepthStencilValue` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkClearDepthStencilValue malloc(MemoryStack stack)

Returns a new VkClearDepthStencilValue 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 VkClearDepthStencilValue.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkClearDepthStencilValue.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

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

mallocStack back to summary

mallocStack	back to summary
public static VkClearDepthStencilValue mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearDepthStencilValue mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkClearDepthStencilValue mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearDepthStencilValue mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkClearDepthStencilValue.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearDepthStencilValue.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkClearDepthStencilValue.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearDepthStencilValue.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

ndepth	back to summary
public static float ndepth(long struct) Unsafe version of `depth`.

ndepth	back to summary
public static void ndepth(long struct, float value) Unsafe version of `depth`.

nstencil	back to summary
public static int nstencil(long struct) Unsafe version of `stencil`.

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

set	back to summary
public VkClearDepthStencilValue set(float depth, int stencil) Initializes this struct with the specified values.

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

set

back to summary

public VkClearDepthStencilValue set(VkClearDepthStencilValue src)

Copies the specified struct data to this struct.

Parameters

src:VkClearDepthStencilValue: the source struct

Returns:VkClearDepthStencilValue

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

stencil	back to summary
public int stencil() the clear value for the stencil aspect of the depth/stencil attachment. It is a 32-bit integer value which is converted to the attachment’s format by taking the appropriate number of LSBs. Annotations @NativeType:uint32_t

stencil

back to summary

public int stencil()

the clear value for the stencil aspect of the depth/stencil attachment. It is a 32-bit integer value which is converted to the attachment’s format by taking the appropriate number of LSBs.

Annotations

@NativeType:uint32_t

stencil	back to summary
public VkClearDepthStencilValue stencil(int value) Sets the specified value to the `stencil` field.

org.lwjgl.vulkan back to summary

public Class VkClearDepthStencilValue.Buffer

Class Inheritance

extends StructBuffer<VkClearDepthStencilValue, VkClearDepthStencilValue.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of VkClearDepthStencilValue structs.

Field Summary

Modifier and Type	Field and Description
private static final VkClearDepthStencilValue	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkClearDepthStencilValue.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
public float	Returns: the value of the `VkClearDepthStencilValue#depth` field. depth()
public VkClearDepthStencilValue.Buffer	depth(float value) Sets the specified value to the `VkClearDepthStencilValue#depth` field.
protected VkClearDepthStencilValue	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VkClearDepthStencilValue.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkClearDepthStencilValue#stencil` field. stencil()
public VkClearDepthStencilValue.Buffer	stencil(int value) Sets the specified value to the `VkClearDepthStencilValue#stencil` 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 VkClearDepthStencilValue ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkClearDepthStencilValue.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 `VkClearDepthStencilValue#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 VkClearDepthStencilValue.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 VkClearDepthStencilValue#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

depth	back to summary
public float depth() Returns:float the value of the `VkClearDepthStencilValue#depth` field.

depth	back to summary
public VkClearDepthStencilValue.Buffer depth(float value) Sets the specified value to the `VkClearDepthStencilValue#depth` field.

getElementFactory

back to summary

protected VkClearDepthStencilValue getElementFactory()

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

Annotations

@Override

self

back to summary

protected VkClearDepthStencilValue.Buffer self()

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

Annotations

@Override

stencil	back to summary
public int stencil() Returns:int the value of the `VkClearDepthStencilValue#stencil` field. Annotations @NativeType:uint32_t

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

public Class VkClearDepthStencilValue

Valid Usage

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkClearDepthStencilValue.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail