VkRectLayerKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkRectLayerKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure containing a rectangle, including layer, changed by vkQueuePresentKHR for a given VkImage.
Valid Usage
- The sum of offset and extent must be no greater than the imageExtent member of the VkSwapchainCreateInfoKHR structure given to CreateSwapchainKHR.
- layer must be less than imageArrayLayers member of the VkSwapchainCreateInfoKHR structure given to CreateSwapchainKHR.
Some platforms allow the size of a surface to change, and then scale the pixels of the image to fit the surface. VkRectLayerKHR specifies pixels of the swapchain's image(s), which will be constant for the life of the swapchain.

See Also

VkExtent2D, VkOffset2D, VkPresentRegionKHR

Member documentation
- offset – the origin of the rectangle, in pixels.
- extent – the size of the rectangle, in pixels.
- layer – the layer of the image. For images with only one layer, the value of layer must be 0.
Layout
```
 struct VkRectLayerKHR {
     VkOffset2D offset;
     VkExtent2D extent;
     uint32_t layer;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

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

Class VkRectLayerKHR

Valid Usage

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

OFFSET

EXTENT

LAYER

Constructor Detail

VkRectLayerKHR

Method Detail

sizeof

offset

extent

layer

offset

offset

extent

extent

layer

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

noffset

nextent

nlayer

noffset

nextent

nlayer