java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPresentRegionsKHR>

org.lwjgl.vulkan.VkPresentRegionsKHR

All Implemented Interfaces:: AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkPresentRegionsKHR extends org.lwjgl.system.Struct<VkPresentRegionsKHR> 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

Layout


 struct VkPresentRegionsKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t swapchainCount();
     VkPresentRegionKHR const * pRegions();
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

VkPresentRegionsKHR.Buffer

An array of VkPresentRegionsKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default
Field Summary

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

PNEXT

The struct member offsets.

static final int

PREGIONS

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

STYPE

The struct member offsets.

static final 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

Description

VkPresentRegionsKHR(ByteBuffer container)

Creates a VkPresentRegionsKHR instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

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.Buffer

calloc(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

calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPresentRegionsKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

static VkPresentRegionsKHR

callocStack()

Deprecated.

static VkPresentRegionsKHR.Buffer

callocStack(int capacity)

Deprecated.

static VkPresentRegionsKHR.Buffer

callocStack(int capacity, org.lwjgl.system.MemoryStack stack)

Deprecated.

static VkPresentRegionsKHR

callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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 @Nullable VkPresentRegionsKHR

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable 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.Buffer

malloc(int capacity, org.lwjgl.system.MemoryStack stack)

Returns a new VkPresentRegionsKHR.Buffer instance allocated on the specified MemoryStack.

static VkPresentRegionsKHR

malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPresentRegionsKHR instance allocated on the specified MemoryStack.

static VkPresentRegionsKHR

mallocStack()

Deprecated.

static VkPresentRegionsKHR.Buffer

mallocStack(int capacity)

Deprecated.

static VkPresentRegionsKHR.Buffer

mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)

Deprecated.

static VkPresentRegionsKHR

mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

static long

npNext(long struct)

Unsafe version of pNext().

static void

npNext(long struct, long value)

Unsafe version of pNext.

static @Nullable VkPresentRegionKHR.Buffer

npRegions(long struct)

Unsafe version of pRegions().

static void

npRegions(long struct, @Nullable 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()

NULL or a pointer to a structure extending this structure.

VkPresentRegionsKHR

pNext(long value)

Sets the specified value to the pNext() field.

@Nullable VkPresentRegionKHR.Buffer

pRegions()

NULL or a pointer to an array of VkPresentRegionKHR elements with swapchainCount entries.

VkPresentRegionsKHR

pRegions(@Nullable VkPresentRegionKHR.Buffer value)

Sets the address of the specified VkPresentRegionKHR.Buffer to the pRegions() field.

VkPresentRegionsKHR

set(int sType, long pNext, int swapchainCount, @Nullable 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()

a VkStructureType value identifying this structure.

VkPresentRegionsKHR

sType(int value)

Sets the specified value to the sType() field.

VkPresentRegionsKHR

sType$Default()

Sets the STRUCTURE_TYPE_PRESENT_REGIONS_KHR value to the sType() field.

int

swapchainCount()

the number of swapchains being presented to by this command.

VkPresentRegionsKHR

swapchainCount(int value)

Sets the specified value to the swapchainCount() field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validate

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 Details
- 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 Details
- VkPresentRegionsKHR
  
  public VkPresentRegionsKHR(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 Details
- sizeof
  
  public int sizeof()
  
  Specified by:
  
  sizeof in class org.lwjgl.system.Struct<VkPresentRegionsKHR>
- sType
  
  public int sType()
  
  a VkStructureType value identifying this structure.
- pNext
  
  public long pNext()
  
  NULL or a pointer to a structure extending this structure.
- swapchainCount
  
  public int swapchainCount()
  
  the number of swapchains being presented to by this command.
- pRegions
  
  public @Nullable VkPresentRegionKHR.Buffer 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.
- sType
  
  public VkPresentRegionsKHR sType(int value)
  
  Sets the specified value to the sType() field.
- sType$Default
  
  public VkPresentRegionsKHR sType$Default()
  
  Sets the STRUCTURE_TYPE_PRESENT_REGIONS_KHR 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
  
  public static @Nullable 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
  
  public static @Nullable VkPresentRegionsKHR.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- mallocStack
  
  @Deprecated public static VkPresentRegionsKHR mallocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkPresentRegionsKHR callocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkPresentRegionsKHR mallocStack(org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkPresentRegionsKHR callocStack(org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkPresentRegionsKHR.Buffer mallocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkPresentRegionsKHR.Buffer callocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkPresentRegionsKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkPresentRegionsKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static VkPresentRegionsKHR malloc(org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkPresentRegionsKHR instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkPresentRegionsKHR calloc(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
- malloc
  
  public static VkPresentRegionsKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
  
  Returns a new VkPresentRegionsKHR.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkPresentRegionsKHR.Buffer calloc(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:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- 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
  
  public static @Nullable 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

Layout

Nested Class Summary

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

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 Details

SIZEOF

ALIGNOF

STYPE

PNEXT

SWAPCHAINCOUNT

PREGIONS

Constructor Details

VkPresentRegionsKHR

Method Details

sizeof

sType

pNext

swapchainCount

pRegions

sType

sType$Default

pNext

swapchainCount

pRegions

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsType

npNext

nswapchainCount

npRegions

nsType

npNext

nswapchainCount

npRegions