VkPresentRegionKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPresentRegionKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure containing rectangular region changed by vkQueuePresentKHR for a given VkImage.
Valid Usage (Implicit)
- If rectangleCount is not 0, and pRectangles is not NULL, pRectangles must be a valid pointer to an array of rectangleCount valid VkRectLayerKHR structures
See Also

VkPresentRegionsKHR, VkRectLayerKHR

Member documentation
- rectangleCount – the number of rectangles in pRectangles, or zero if the entire image has changed and should be presented.
- pRectangles – either NULL or a pointer to an array of VkRectLayerKHR structures. The VkRectLayerKHR structure is the framebuffer coordinates, plus layer, of a portion of a presentable image that has changed and must be presented. If non-NULL, each entry in pRectangles is a rectangle of the given image that has changed since the last image was presented to the given swapchain.
Layout
```
 struct VkPresentRegionKHR {
     uint32_t rectangleCount;
     VkRectLayerKHR const * pRectangles;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PRECTANGLES` The struct member offsets.
`static int`	`RECTANGLECOUNT` 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
`VkPresentRegionKHR(java.nio.ByteBuffer container)` Creates a `VkPresentRegionKHR` 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 VkPresentRegionKHR`	`calloc()` Returns a new `VkPresentRegionKHR` instance allocated with `memCalloc`.
`static VkPresentRegionKHR.Buffer`	`calloc(int capacity)` Returns a new `VkPresentRegionKHR.Buffer` instance allocated with `memCalloc`.
`static VkPresentRegionKHR`	`callocStack()` Returns a new `VkPresentRegionKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPresentRegionKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkPresentRegionKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPresentRegionKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPresentRegionKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPresentRegionKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPresentRegionKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPresentRegionKHR`	`create()` Returns a new `VkPresentRegionKHR` instance allocated with `BufferUtils`.
`static VkPresentRegionKHR.Buffer`	`create(int capacity)` Returns a new `VkPresentRegionKHR.Buffer` instance allocated with `BufferUtils`.
`static VkPresentRegionKHR`	`create(long address)` Returns a new `VkPresentRegionKHR` instance for the specified memory address.
`static VkPresentRegionKHR.Buffer`	`create(long address, int capacity)` Create a `VkPresentRegionKHR.Buffer` instance at the specified memory.
`static VkPresentRegionKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPresentRegionKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPresentRegionKHR`	`malloc()` Returns a new `VkPresentRegionKHR` instance allocated with `memAlloc`.
`static VkPresentRegionKHR.Buffer`	`malloc(int capacity)` Returns a new `VkPresentRegionKHR.Buffer` instance allocated with `memAlloc`.
`static VkPresentRegionKHR`	`mallocStack()` Returns a new `VkPresentRegionKHR` instance allocated on the thread-local `MemoryStack`.
`static VkPresentRegionKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkPresentRegionKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPresentRegionKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPresentRegionKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPresentRegionKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPresentRegionKHR` instance allocated on the specified `MemoryStack`.
`static VkRectLayerKHR.Buffer`	`npRectangles(long struct)` Unsafe version of `pRectangles()`.
`static void`	`npRectangles(long struct, VkRectLayerKHR.Buffer value)` Unsafe version of `pRectangles`.
`static int`	`nrectangleCount(long struct)` Unsafe version of `rectangleCount()`.
`static void`	`nrectangleCount(long struct, int value)` Sets the specified value to the `rectangleCount` field of the specified `struct`.
`VkRectLayerKHR.Buffer`	`pRectangles()` Returns a `VkRectLayerKHR.Buffer` view of the struct array pointed to by the `pRectangles` field.
`VkPresentRegionKHR`	`pRectangles(VkRectLayerKHR.Buffer value)` Sets the address of the specified `VkRectLayerKHR.Buffer` to the `pRectangles` field.
`int`	`rectangleCount()` Returns the value of the `rectangleCount` field.
`VkPresentRegionKHR`	`rectangleCount(int value)` Sets the specified value to the `rectangleCount` field.
`VkPresentRegionKHR`	`set(int rectangleCount, VkRectLayerKHR.Buffer pRectangles)` Initializes this struct with the specified values.
`VkPresentRegionKHR`	`set(VkPresentRegionKHR 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.
  - RECTANGLECOUNT
```
public static final int RECTANGLECOUNT
```
    The struct member offsets.
  - PRECTANGLES
```
public static final int PRECTANGLES
```
    The struct member offsets.
- Constructor Detail
  - VkPresentRegionKHR
```
public VkPresentRegionKHR(java.nio.ByteBuffer container)
```
    Creates a VkPresentRegionKHR 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
  - rectangleCount
```
public int rectangleCount()
```
    Returns the value of the rectangleCount field.
  - pRectangles
```
@Nullable
public VkRectLayerKHR.Buffer pRectangles()
```
    Returns a VkRectLayerKHR.Buffer view of the struct array pointed to by the pRectangles field.
  - rectangleCount
```
public VkPresentRegionKHR rectangleCount(int value)
```
    Sets the specified value to the rectangleCount field.
  - pRectangles
```
public VkPresentRegionKHR pRectangles(@Nullable
                                      VkRectLayerKHR.Buffer value)
```
    Sets the address of the specified VkRectLayerKHR.Buffer to the pRectangles field.
  - set
```
public VkPresentRegionKHR set(int rectangleCount,
                              @Nullable
                              VkRectLayerKHR.Buffer pRectangles)
```
    Initializes this struct with the specified values.
  - set
```
public VkPresentRegionKHR set(VkPresentRegionKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPresentRegionKHR malloc()
```
    Returns a new VkPresentRegionKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPresentRegionKHR calloc()
```
    Returns a new VkPresentRegionKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPresentRegionKHR create()
```
    Returns a new VkPresentRegionKHR instance allocated with BufferUtils.
  - create
```
public static VkPresentRegionKHR create(long address)
```
    Returns a new VkPresentRegionKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPresentRegionKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPresentRegionKHR.Buffer malloc(int capacity)
```
    Returns a new VkPresentRegionKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPresentRegionKHR.Buffer calloc(int capacity)
```
    Returns a new VkPresentRegionKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPresentRegionKHR.Buffer create(int capacity)
```
    Returns a new VkPresentRegionKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPresentRegionKHR.Buffer create(long address,
                                               int capacity)
```
    Create a VkPresentRegionKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPresentRegionKHR.Buffer createSafe(long address,
                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPresentRegionKHR mallocStack()
```
    Returns a new VkPresentRegionKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPresentRegionKHR callocStack()
```
    Returns a new VkPresentRegionKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPresentRegionKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPresentRegionKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPresentRegionKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPresentRegionKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPresentRegionKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkPresentRegionKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPresentRegionKHR.Buffer callocStack(int capacity)
```
    Returns a new VkPresentRegionKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPresentRegionKHR.Buffer mallocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPresentRegionKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPresentRegionKHR.Buffer callocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPresentRegionKHR.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
  - nrectangleCount
```
public static int nrectangleCount(long struct)
```
    Unsafe version of rectangleCount().
  - npRectangles
```
@Nullable
public static VkRectLayerKHR.Buffer npRectangles(long struct)
```
    Unsafe version of pRectangles().
  - nrectangleCount
```
public static void nrectangleCount(long struct,
                                   int value)
```
    Sets the specified value to the rectangleCount field of the specified struct.
  - npRectangles
```
public static void npRectangles(long struct,
                                @Nullable
                                VkRectLayerKHR.Buffer value)
```
    Unsafe version of pRectangles.

Class VkPresentRegionKHR

Valid Usage (Implicit)

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

RECTANGLECOUNT

PRECTANGLES

Constructor Detail

VkPresentRegionKHR

Method Detail

sizeof

rectangleCount

pRectangles

rectangleCount

pRectangles

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nrectangleCount

npRectangles

nrectangleCount

npRectangles