VkClearRect (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkClearRect
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a clear rectangle.
Description

The layers [baseArrayLayer, baseArrayLayer + layerCount) counting from the base layer of the attachment image view are cleared.

See Also

VkRect2D, CmdClearAttachments

Member documentation
- rect – the two-dimensional region to be cleared.
- baseArrayLayer – the first layer to be cleared.
- layerCount – the number of layers to clear.
Layout
```
 struct VkClearRect {
     VkRect2D rect;
     uint32_t baseArrayLayer;
     uint32_t layerCount;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkClearRect.Buffer
An array of VkClearRect 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`	`VkClearRect.Buffer` An array of `VkClearRect` structs.

Field Summary

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

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

VkClearRect(java.nio.ByteBuffer container)
Creates a VkClearRect instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`VkClearRect(java.nio.ByteBuffer container)` Creates a `VkClearRect` 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
`int`	`baseArrayLayer()` Returns the value of the `baseArrayLayer` field.
`VkClearRect`	`baseArrayLayer(int value)` Sets the specified value to the `baseArrayLayer` field.
`static VkClearRect`	`calloc()` Returns a new `VkClearRect` instance allocated with `memCalloc`.
`static VkClearRect.Buffer`	`calloc(int capacity)` Returns a new `VkClearRect.Buffer` instance allocated with `memCalloc`.
`static VkClearRect`	`callocStack()` Returns a new `VkClearRect` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkClearRect.Buffer`	`callocStack(int capacity)` Returns a new `VkClearRect.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkClearRect.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearRect.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkClearRect`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearRect` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkClearRect`	`create()` Returns a new `VkClearRect` instance allocated with `BufferUtils`.
`static VkClearRect.Buffer`	`create(int capacity)` Returns a new `VkClearRect.Buffer` instance allocated with `BufferUtils`.
`static VkClearRect`	`create(long address)` Returns a new `VkClearRect` instance for the specified memory address.
`static VkClearRect.Buffer`	`create(long address, int capacity)` Create a `VkClearRect.Buffer` instance at the specified memory.
`static VkClearRect`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkClearRect.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`layerCount()` Returns the value of the `layerCount` field.
`VkClearRect`	`layerCount(int value)` Sets the specified value to the `layerCount` field.
`static VkClearRect`	`malloc()` Returns a new `VkClearRect` instance allocated with `memAlloc`.
`static VkClearRect.Buffer`	`malloc(int capacity)` Returns a new `VkClearRect.Buffer` instance allocated with `memAlloc`.
`static VkClearRect`	`mallocStack()` Returns a new `VkClearRect` instance allocated on the thread-local `MemoryStack`.
`static VkClearRect.Buffer`	`mallocStack(int capacity)` Returns a new `VkClearRect.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkClearRect.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearRect.Buffer` instance allocated on the specified `MemoryStack`.
`static VkClearRect`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkClearRect` instance allocated on the specified `MemoryStack`.
`static int`	`nbaseArrayLayer(long struct)` Unsafe version of `baseArrayLayer()`.
`static void`	`nbaseArrayLayer(long struct, int value)` Unsafe version of `baseArrayLayer`.
`static int`	`nlayerCount(long struct)` Unsafe version of `layerCount()`.
`static void`	`nlayerCount(long struct, int value)` Unsafe version of `layerCount`.
`static VkRect2D`	`nrect(long struct)` Unsafe version of `rect()`.
`static void`	`nrect(long struct, VkRect2D value)` Unsafe version of `rect`.
`VkRect2D`	`rect()` Returns a `VkRect2D` view of the `rect` field.
`VkClearRect`	`rect(java.util.function.Consumer<VkRect2D> consumer)` Passes the `rect` field to the specified `Consumer`.
`VkClearRect`	`rect(VkRect2D value)` Copies the specified `VkRect2D` to the `rect` field.
`VkClearRect`	`set(VkClearRect src)` Copies the specified struct data to this struct.
`VkClearRect`	`set(VkRect2D rect, int baseArrayLayer, int layerCount)` Initializes this struct with the specified values.
`int`	`sizeof()`

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.
  - RECT
```
public static final int RECT
```
    The struct member offsets.
  - BASEARRAYLAYER
```
public static final int BASEARRAYLAYER
```
    The struct member offsets.
  - LAYERCOUNT
```
public static final int LAYERCOUNT
```
    The struct member offsets.
- Constructor Detail
  - VkClearRect
```
public VkClearRect(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - rect
```
public VkRect2D rect()
```
    Returns a VkRect2D view of the rect field.
  - baseArrayLayer
```
public int baseArrayLayer()
```
    Returns the value of the baseArrayLayer field.
  - layerCount
```
public int layerCount()
```
    Returns the value of the layerCount field.
  - rect
```
public VkClearRect rect(VkRect2D value)
```
    Copies the specified VkRect2D to the rect field.
  - rect
```
public VkClearRect rect(java.util.function.Consumer<VkRect2D> consumer)
```
    Passes the rect field to the specified Consumer.
  - baseArrayLayer
```
public VkClearRect baseArrayLayer(int value)
```
    Sets the specified value to the baseArrayLayer field.
  - layerCount
```
public VkClearRect layerCount(int value)
```
    Sets the specified value to the layerCount field.
  - set
```
public VkClearRect set(VkRect2D rect,
                       int baseArrayLayer,
                       int layerCount)
```
    Initializes this struct with the specified values.
  - set
```
public VkClearRect set(VkClearRect src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkClearRect malloc()
```
    Returns a new VkClearRect instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkClearRect calloc()
```
    Returns a new VkClearRect instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkClearRect create()
```
    Returns a new VkClearRect instance allocated with BufferUtils.
  - create
```
public static VkClearRect create(long address)
```
    Returns a new VkClearRect instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkClearRect createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkClearRect.Buffer malloc(int capacity)
```
    Returns a new VkClearRect.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkClearRect.Buffer calloc(int capacity)
```
    Returns a new VkClearRect.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkClearRect.Buffer create(int capacity)
```
    Returns a new VkClearRect.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkClearRect.Buffer create(long address,
                                        int capacity)
```
    Create a VkClearRect.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkClearRect.Buffer createSafe(long address,
                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkClearRect mallocStack()
```
    Returns a new VkClearRect instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkClearRect callocStack()
```
    Returns a new VkClearRect instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkClearRect mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkClearRect instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkClearRect callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkClearRect instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkClearRect.Buffer mallocStack(int capacity)
```
    Returns a new VkClearRect.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkClearRect.Buffer callocStack(int capacity)
```
    Returns a new VkClearRect.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkClearRect.Buffer mallocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkClearRect.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkClearRect.Buffer callocStack(int capacity,
                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkClearRect.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
  - nrect
```
public static VkRect2D nrect(long struct)
```
    Unsafe version of rect().
  - nbaseArrayLayer
```
public static int nbaseArrayLayer(long struct)
```
    Unsafe version of baseArrayLayer().
  - nlayerCount
```
public static int nlayerCount(long struct)
```
    Unsafe version of layerCount().
  - nrect
```
public static void nrect(long struct,
                         VkRect2D value)
```
    Unsafe version of rect.
  - nbaseArrayLayer
```
public static void nbaseArrayLayer(long struct,
                                   int value)
```
    Unsafe version of baseArrayLayer.
  - nlayerCount
```
public static void nlayerCount(long struct,
                               int value)
```
    Unsafe version of layerCount.

Class VkClearRect

Description

See Also

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

RECT

BASEARRAYLAYER

LAYERCOUNT

Constructor Detail

VkClearRect

Method Detail

sizeof

rect

baseArrayLayer

layerCount

rect

rect

baseArrayLayer

layerCount

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nrect

nbaseArrayLayer

nlayerCount

nrect

nbaseArrayLayer

nlayerCount