VkRect2D (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkRect2D
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a two-dimensional subregion.
Member documentation
- offset – a VkOffset2D specifying the rectangle offset.
- extent – a VkExtent2D specifying the rectangle extent.
Layout
```
 struct VkRect2D {
     VkOffset2D offset;
     VkExtent2D extent;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`EXTENT` The struct member offsets.
`static int`	`OFFSET` 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

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

Constructors
Constructor and Description
`VkRect2D(java.nio.ByteBuffer container)` Creates a `VkRect2D` 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 VkRect2D`	`calloc()` Returns a new `VkRect2D` instance allocated with `memCalloc`.
`static VkRect2D.Buffer`	`calloc(int capacity)` Returns a new `VkRect2D.Buffer` instance allocated with `memCalloc`.
`static VkRect2D`	`callocStack()` Returns a new `VkRect2D` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkRect2D.Buffer`	`callocStack(int capacity)` Returns a new `VkRect2D.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkRect2D.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkRect2D.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkRect2D`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkRect2D` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkRect2D`	`create()` Returns a new `VkRect2D` instance allocated with `BufferUtils`.
`static VkRect2D.Buffer`	`create(int capacity)` Returns a new `VkRect2D.Buffer` instance allocated with `BufferUtils`.
`static VkRect2D`	`create(long address)` Returns a new `VkRect2D` instance for the specified memory address.
`static VkRect2D.Buffer`	`create(long address, int capacity)` Create a `VkRect2D.Buffer` instance at the specified memory.
`static VkRect2D`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkRect2D.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`VkExtent2D`	`extent()` Returns a `VkExtent2D` view of the `extent` field.
`VkRect2D`	`extent(java.util.function.Consumer<VkExtent2D> consumer)` Passes the `extent` field to the specified `Consumer`.
`VkRect2D`	`extent(VkExtent2D value)` Copies the specified `VkExtent2D` to the `extent` field.
`static VkRect2D`	`malloc()` Returns a new `VkRect2D` instance allocated with `memAlloc`.
`static VkRect2D.Buffer`	`malloc(int capacity)` Returns a new `VkRect2D.Buffer` instance allocated with `memAlloc`.
`static VkRect2D`	`mallocStack()` Returns a new `VkRect2D` instance allocated on the thread-local `MemoryStack`.
`static VkRect2D.Buffer`	`mallocStack(int capacity)` Returns a new `VkRect2D.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkRect2D.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkRect2D.Buffer` instance allocated on the specified `MemoryStack`.
`static VkRect2D`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkRect2D` instance allocated on the specified `MemoryStack`.
`static VkExtent2D`	`nextent(long struct)` Unsafe version of `extent()`.
`static void`	`nextent(long struct, VkExtent2D value)` Unsafe version of `extent`.
`static VkOffset2D`	`noffset(long struct)` Unsafe version of `offset()`.
`static void`	`noffset(long struct, VkOffset2D value)` Unsafe version of `offset`.
`VkOffset2D`	`offset()` Returns a `VkOffset2D` view of the `offset` field.
`VkRect2D`	`offset(java.util.function.Consumer<VkOffset2D> consumer)` Passes the `offset` field to the specified `Consumer`.
`VkRect2D`	`offset(VkOffset2D value)` Copies the specified `VkOffset2D` to the `offset` field.
`VkRect2D`	`set(VkOffset2D offset, VkExtent2D extent)` Initializes this struct with the specified values.
`VkRect2D`	`set(VkRect2D src)` Copies the specified struct data to this struct.
`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.
  - OFFSET
```
public static final int OFFSET
```
    The struct member offsets.
  - EXTENT
```
public static final int EXTENT
```
    The struct member offsets.
- Constructor Detail
  - VkRect2D
```
public VkRect2D(java.nio.ByteBuffer container)
```
    Creates a VkRect2D 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
  - offset
```
public VkOffset2D offset()
```
    Returns a VkOffset2D view of the offset field.
  - extent
```
public VkExtent2D extent()
```
    Returns a VkExtent2D view of the extent field.
  - offset
```
public VkRect2D offset(VkOffset2D value)
```
    Copies the specified VkOffset2D to the offset field.
  - offset
```
public VkRect2D offset(java.util.function.Consumer<VkOffset2D> consumer)
```
    Passes the offset field to the specified Consumer.
  - extent
```
public VkRect2D extent(VkExtent2D value)
```
    Copies the specified VkExtent2D to the extent field.
  - extent
```
public VkRect2D extent(java.util.function.Consumer<VkExtent2D> consumer)
```
    Passes the extent field to the specified Consumer.
  - set
```
public VkRect2D set(VkOffset2D offset,
                    VkExtent2D extent)
```
    Initializes this struct with the specified values.
  - set
```
public VkRect2D set(VkRect2D src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkRect2D malloc()
```
    Returns a new VkRect2D instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkRect2D calloc()
```
    Returns a new VkRect2D instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkRect2D create()
```
    Returns a new VkRect2D instance allocated with BufferUtils.
  - create
```
public static VkRect2D create(long address)
```
    Returns a new VkRect2D instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkRect2D createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkRect2D.Buffer malloc(int capacity)
```
    Returns a new VkRect2D.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkRect2D.Buffer calloc(int capacity)
```
    Returns a new VkRect2D.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkRect2D.Buffer create(int capacity)
```
    Returns a new VkRect2D.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkRect2D.Buffer create(long address,
                                     int capacity)
```
    Create a VkRect2D.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkRect2D.Buffer createSafe(long address,
                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkRect2D mallocStack()
```
    Returns a new VkRect2D instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkRect2D callocStack()
```
    Returns a new VkRect2D instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkRect2D mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRect2D instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkRect2D callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRect2D instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkRect2D.Buffer mallocStack(int capacity)
```
    Returns a new VkRect2D.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkRect2D.Buffer callocStack(int capacity)
```
    Returns a new VkRect2D.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkRect2D.Buffer mallocStack(int capacity,
                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRect2D.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkRect2D.Buffer callocStack(int capacity,
                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRect2D.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
  - noffset
```
public static VkOffset2D noffset(long struct)
```
    Unsafe version of offset().
  - nextent
```
public static VkExtent2D nextent(long struct)
```
    Unsafe version of extent().
  - noffset
```
public static void noffset(long struct,
                           VkOffset2D value)
```
    Unsafe version of offset.
  - nextent
```
public static void nextent(long struct,
                           VkExtent2D value)
```
    Unsafe version of extent.

Class VkRect2D

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

OFFSET

EXTENT

Constructor Detail

VkRect2D

Method Detail

sizeof

offset

extent

offset

offset

extent

extent

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

noffset

nextent

noffset

nextent