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

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

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

Method Summary

Modifier and Type	Method and Description
public int	baseArrayLayer() the first layer to be cleared.
public VkClearRect	baseArrayLayer(int value) Sets the specified value to the `baseArrayLayer` field.
public static VkClearRect	calloc() Returns a new `VkClearRect` instance allocated with `memCalloc`.
public static VkClearRect.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkClearRect.Buffer` instance allocated with `memCalloc`.
public static VkClearRect	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkClearRect` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkClearRect.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkClearRect.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkClearRect	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkClearRect	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkClearRect.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkClearRect.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkClearRect	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 VkClearRect	create() Returns a new `VkClearRect` instance allocated with `BufferUtils`.
public static VkClearRect	create(long address) Returns a new `VkClearRect` instance for the specified memory address.
public static VkClearRect.Buffer	create(int the buffer capacity capacity) Returns a new `VkClearRect.Buffer` instance allocated with `BufferUtils`.
public static VkClearRect.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkClearRect.Buffer` instance at the specified memory.
public static VkClearRect	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkClearRect.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	layerCount() the number of layers to clear.
public VkClearRect	layerCount(int value) Sets the specified value to the `layerCount` field.
public static VkClearRect	malloc() Returns a new `VkClearRect` instance allocated with `memAlloc`.
public static VkClearRect.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkClearRect.Buffer` instance allocated with `memAlloc`.
public static VkClearRect	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkClearRect` instance allocated on the specified `MemoryStack`.
public static VkClearRect.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkClearRect.Buffer` instance allocated on the specified `MemoryStack`.
public static VkClearRect	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkClearRect	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkClearRect.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkClearRect.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nbaseArrayLayer(long struct) Unsafe version of `baseArrayLayer`.
public static void	nbaseArrayLayer(long struct, int value) Unsafe version of `baseArrayLayer`.
public static int	nlayerCount(long struct) Unsafe version of `layerCount`.
public static void	nlayerCount(long struct, int value) Unsafe version of `layerCount`.
public static VkRect2D	nrect(long struct) Unsafe version of `rect`.
public static void	nrect(long struct, VkRect2D value) Unsafe version of `rect`.
public VkRect2D	rect() the two-dimensional region to be cleared.
public VkClearRect	rect(VkRect2D value) Copies the specified `VkRect2D` to the `rect` field.
public VkClearRect	rect(Consumer<VkRect2D> consumer) Passes the `rect` field to the specified `Consumer`.
public VkClearRect	set(VkRect2D rect, int baseArrayLayer, int layerCount) Initializes this struct with the specified values.
public VkClearRect	Returns: this struct set(VkClearRect 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)`.

Field Detail

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

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

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

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

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

Constructor Detail

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

VkClearRect back to summary

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

Creates a VkClearRect 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

baseArrayLayer	back to summary
public int baseArrayLayer() the first layer to be cleared. Annotations @NativeType:uint32_t

baseArrayLayer

back to summary

public int baseArrayLayer()

the first layer to be cleared.

Annotations

@NativeType:uint32_t

baseArrayLayer	back to summary
public VkClearRect baseArrayLayer(int value) Sets the specified value to the `baseArrayLayer` field.

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

calloc back to summary

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

public static VkClearRect.Buffer calloc(int capacity)

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

public static VkClearRect calloc(MemoryStack stack)

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

Returns a new VkClearRect.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 VkClearRect callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearRect 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 VkClearRect callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearRect 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 VkClearRect.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearRect.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 VkClearRect.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearRect.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 VkClearRect 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 VkClearRect 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 VkClearRect create() Returns a new `VkClearRect` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkClearRect.Buffer create(int capacity)

Returns a new VkClearRect.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static VkClearRect createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

layerCount	back to summary
public int layerCount() the number of layers to clear. Annotations @NativeType:uint32_t

layerCount

back to summary

public int layerCount()

the number of layers to clear.

Annotations

@NativeType:uint32_t

layerCount	back to summary
public VkClearRect layerCount(int value) Sets the specified value to the `layerCount` field.

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

malloc back to summary

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

public static VkClearRect.Buffer malloc(int capacity)

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

public static VkClearRect malloc(MemoryStack stack)

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

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

Returns a new VkClearRect.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 VkClearRect mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearRect 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 VkClearRect mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkClearRect 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 VkClearRect.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkClearRect.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 VkClearRect.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

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

Deprecated

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

Annotations

@Deprecated

nbaseArrayLayer	back to summary
public static int nbaseArrayLayer(long struct) Unsafe version of `baseArrayLayer`.

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

nlayerCount	back to summary
public static int nlayerCount(long struct) Unsafe version of `layerCount`.

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

nrect	back to summary
public static VkRect2D nrect(long struct) Unsafe version of `rect`.

nrect	back to summary
public static void nrect(long struct, VkRect2D value) Unsafe version of `rect`.

rect	back to summary
public VkRect2D rect() the two-dimensional region to be cleared.

rect	back to summary
public VkClearRect rect(VkRect2D value) Copies the specified `VkRect2D` to the `rect` field.

rect	back to summary
public VkClearRect rect(Consumer<VkRect2D> consumer) Passes the `rect` field to the specified `Consumer`.

set	back to summary
public VkClearRect set(VkRect2D rect, int baseArrayLayer, int layerCount) Initializes this struct with the specified values.

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

set

back to summary

public VkClearRect set(VkClearRect src)

Copies the specified struct data to this struct.

Parameters

src:VkClearRect: the source struct

Returns:VkClearRect

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

org.lwjgl.vulkan back to summary

public Class VkClearRect.Buffer

Class Inheritance

extends StructBuffer<VkClearRect, VkClearRect.Buffer>
implements NativeResource

All Implemented Interfaces

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

An array of VkClearRect structs.

Field Summary

Modifier and Type	Field and Description
private static final VkClearRect	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkClearRect.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 int	Returns: the value of the `VkClearRect#baseArrayLayer` field. baseArrayLayer()
public VkClearRect.Buffer	baseArrayLayer(int value) Sets the specified value to the `VkClearRect#baseArrayLayer` field.
protected VkClearRect	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `VkClearRect#layerCount` field. layerCount()
public VkClearRect.Buffer	layerCount(int value) Sets the specified value to the `VkClearRect#layerCount` field.
public VkRect2D	Returns: a `VkRect2D` view of the `VkClearRect#rect` field. rect()
public VkClearRect.Buffer	rect(VkRect2D value) Copies the specified `VkRect2D` to the `VkClearRect#rect` field.
public VkClearRect.Buffer	rect(Consumer<VkRect2D> consumer) Passes the `VkClearRect#rect` field to the specified `Consumer`.
protected VkClearRect.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

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 VkClearRect ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkClearRect.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 VkClearRect#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

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

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

getElementFactory

back to summary

protected VkClearRect getElementFactory()

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

Annotations

@Override

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

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

rect	back to summary
public VkRect2D rect() Returns:VkRect2D a `VkRect2D` view of the `VkClearRect#rect` field.

rect	back to summary
public VkClearRect.Buffer rect(VkRect2D value) Copies the specified `VkRect2D` to the `VkClearRect#rect` field.

rect	back to summary
public VkClearRect.Buffer rect(Consumer<VkRect2D> consumer) Passes the `VkClearRect#rect` field to the specified `Consumer`.

self

back to summary

protected VkClearRect.Buffer self()

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

Annotations

@Override

public Class VkClearRect

Description

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkClearRect.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail