VkPresentRegionsKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPresentRegionsKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure hint of rectangular regions changed by vkQueuePresentKHR.
Valid Usage
- swapchainCount must be the same value as VkPresentInfoKHR::swapchainCount, where VkPresentInfoKHR is included in the pNext chain of this VkPresentRegionsKHR structure
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PRESENT_REGIONS_KHR
- If pRegions is not NULL, pRegions must be a valid pointer to an array of swapchainCount valid VkPresentRegionKHR structures
- swapchainCount must be greater than 0
See Also

VkPresentRegionKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- swapchainCount – the number of swapchains being presented to by this command.
- pRegions – NULL or a pointer to an array of VkPresentRegionKHR elements with swapchainCount entries. If not NULL, each element of pRegions contains the region that has changed since the last present to the swapchain in the corresponding entry in the VkPresentInfoKHR::pSwapchains array.
Layout
```
 struct VkPresentRegionsKHR {
     VkStructureType sType;
     void const * pNext;
     uint32_t swapchainCount;
     VkPresentRegionKHR const * pRegions;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PNEXT` The struct member offsets.
`static int`	`PREGIONS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.
`static int`	`SWAPCHAINCOUNT` The struct member offsets.

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

Constructor Summary

Constructors
Constructor and Description
`VkPresentRegionsKHR(java.nio.ByteBuffer container)` Creates a `VkPresentRegionsKHR` 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 VkPresentRegionsKHR`	`calloc()` Returns a new `VkPresentRegionsKHR` instance allocated with `memCalloc`.
`static VkPresentRegionsKHR.Buffer`	`calloc(int capacity)` Returns a new `VkPresentRegionsKHR.Buffer` instance allocated with `memCalloc`.
`static VkPresentRegionsKHR`	`callocStack()` Returns a new `VkPresentRegionsKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPresentRegionsKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkPresentRegionsKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPresentRegionsKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPresentRegionsKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPresentRegionsKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPresentRegionsKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPresentRegionsKHR`	`create()` Returns a new `VkPresentRegionsKHR` instance allocated with `BufferUtils`.
`static VkPresentRegionsKHR.Buffer`	`create(int capacity)` Returns a new `VkPresentRegionsKHR.Buffer` instance allocated with `BufferUtils`.
`static VkPresentRegionsKHR`	`create(long address)` Returns a new `VkPresentRegionsKHR` instance for the specified memory address.
`static VkPresentRegionsKHR.Buffer`	`create(long address, int capacity)` Create a `VkPresentRegionsKHR.Buffer` instance at the specified memory.
`static VkPresentRegionsKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPresentRegionsKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPresentRegionsKHR`	`malloc()` Returns a new `VkPresentRegionsKHR` instance allocated with `memAlloc`.
`static VkPresentRegionsKHR.Buffer`	`malloc(int capacity)` Returns a new `VkPresentRegionsKHR.Buffer` instance allocated with `memAlloc`.
`static VkPresentRegionsKHR`	`mallocStack()` Returns a new `VkPresentRegionsKHR` instance allocated on the thread-local `MemoryStack`.
`static VkPresentRegionsKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkPresentRegionsKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPresentRegionsKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPresentRegionsKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPresentRegionsKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPresentRegionsKHR` instance allocated on the specified `MemoryStack`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static VkPresentRegionKHR.Buffer`	`npRegions(long struct)` Unsafe version of `pRegions()`.
`static void`	`npRegions(long struct, VkPresentRegionKHR.Buffer value)` Unsafe version of `pRegions`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`static int`	`nswapchainCount(long struct)` Unsafe version of `swapchainCount()`.
`static void`	`nswapchainCount(long struct, int value)` Sets the specified value to the `swapchainCount` field of the specified `struct`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPresentRegionsKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkPresentRegionKHR.Buffer`	`pRegions()` Returns a `VkPresentRegionKHR.Buffer` view of the struct array pointed to by the `pRegions` field.
`VkPresentRegionsKHR`	`pRegions(VkPresentRegionKHR.Buffer value)` Sets the address of the specified `VkPresentRegionKHR.Buffer` to the `pRegions` field.
`VkPresentRegionsKHR`	`set(int sType, long pNext, int swapchainCount, VkPresentRegionKHR.Buffer pRegions)` Initializes this struct with the specified values.
`VkPresentRegionsKHR`	`set(VkPresentRegionsKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkPresentRegionsKHR`	`sType(int value)` Sets the specified value to the `sType` field.
`int`	`swapchainCount()` Returns the value of the `swapchainCount` field.
`VkPresentRegionsKHR`	`swapchainCount(int value)` Sets the specified value to the `swapchainCount` field.

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.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - SWAPCHAINCOUNT
```
public static final int SWAPCHAINCOUNT
```
    The struct member offsets.
  - PREGIONS
```
public static final int PREGIONS
```
    The struct member offsets.
- Constructor Detail
  - VkPresentRegionsKHR
```
public VkPresentRegionsKHR(java.nio.ByteBuffer container)
```
    Creates a VkPresentRegionsKHR 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
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - swapchainCount
```
public int swapchainCount()
```
    Returns the value of the swapchainCount field.
  - pRegions
```
@Nullable
public VkPresentRegionKHR.Buffer pRegions()
```
    Returns a VkPresentRegionKHR.Buffer view of the struct array pointed to by the pRegions field.
  - sType
```
public VkPresentRegionsKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPresentRegionsKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - swapchainCount
```
public VkPresentRegionsKHR swapchainCount(int value)
```
    Sets the specified value to the swapchainCount field.
  - pRegions
```
public VkPresentRegionsKHR pRegions(@Nullable
                                    VkPresentRegionKHR.Buffer value)
```
    Sets the address of the specified VkPresentRegionKHR.Buffer to the pRegions field.
  - set
```
public VkPresentRegionsKHR set(int sType,
                               long pNext,
                               int swapchainCount,
                               @Nullable
                               VkPresentRegionKHR.Buffer pRegions)
```
    Initializes this struct with the specified values.
  - set
```
public VkPresentRegionsKHR set(VkPresentRegionsKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPresentRegionsKHR malloc()
```
    Returns a new VkPresentRegionsKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPresentRegionsKHR calloc()
```
    Returns a new VkPresentRegionsKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPresentRegionsKHR create()
```
    Returns a new VkPresentRegionsKHR instance allocated with BufferUtils.
  - create
```
public static VkPresentRegionsKHR create(long address)
```
    Returns a new VkPresentRegionsKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPresentRegionsKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPresentRegionsKHR.Buffer malloc(int capacity)
```
    Returns a new VkPresentRegionsKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPresentRegionsKHR.Buffer calloc(int capacity)
```
    Returns a new VkPresentRegionsKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPresentRegionsKHR.Buffer create(int capacity)
```
    Returns a new VkPresentRegionsKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPresentRegionsKHR.Buffer create(long address,
                                                int capacity)
```
    Create a VkPresentRegionsKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPresentRegionsKHR.Buffer createSafe(long address,
                                                              int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPresentRegionsKHR mallocStack()
```
    Returns a new VkPresentRegionsKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPresentRegionsKHR callocStack()
```
    Returns a new VkPresentRegionsKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPresentRegionsKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPresentRegionsKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPresentRegionsKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPresentRegionsKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPresentRegionsKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkPresentRegionsKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPresentRegionsKHR.Buffer callocStack(int capacity)
```
    Returns a new VkPresentRegionsKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPresentRegionsKHR.Buffer mallocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPresentRegionsKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPresentRegionsKHR.Buffer callocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPresentRegionsKHR.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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nswapchainCount
```
public static int nswapchainCount(long struct)
```
    Unsafe version of swapchainCount().
  - npRegions
```
@Nullable
public static VkPresentRegionKHR.Buffer npRegions(long struct)
```
    Unsafe version of pRegions().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nswapchainCount
```
public static void nswapchainCount(long struct,
                                   int value)
```
    Sets the specified value to the swapchainCount field of the specified struct.
  - npRegions
```
public static void npRegions(long struct,
                             @Nullable
                             VkPresentRegionKHR.Buffer value)
```
    Unsafe version of pRegions.

Class VkPresentRegionsKHR

Valid Usage

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

STYPE

PNEXT

SWAPCHAINCOUNT

PREGIONS

Constructor Detail

VkPresentRegionsKHR

Method Detail

sizeof

sType

pNext

swapchainCount

pRegions

sType

pNext

swapchainCount

pRegions

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nswapchainCount

npRegions

nsType

npNext

nswapchainCount

npRegions