org.lwjgl.vulkan.VkPresentRegionKHR

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class VkPresentRegionKHR extends Struct<VkPresentRegionKHR> implements 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

Layout


 struct VkPresentRegionKHR {
     uint32_t rectangleCount();
     VkRectLayerKHR const * pRectangles();
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

VkPresentRegionKHR.Buffer

An array of VkPresentRegionKHR structs.

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

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

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

PRECTANGLES

The struct member offsets.

static final int

RECTANGLECOUNT

The struct member offsets.

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

Description

VkPresentRegionKHR(ByteBuffer container)

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

Modifier and Type

Method

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

calloc(int capacity, MemoryStack stack)

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

static VkPresentRegionKHR

calloc(MemoryStack stack)

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

static VkPresentRegionKHR

callocStack()

Deprecated.

static VkPresentRegionKHR.Buffer

callocStack(int capacity)

Deprecated.

static VkPresentRegionKHR.Buffer

callocStack(int capacity, MemoryStack stack)

Deprecated.

static VkPresentRegionKHR

callocStack(MemoryStack stack)

Deprecated.

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

malloc(int capacity, MemoryStack stack)

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

static VkPresentRegionKHR

malloc(MemoryStack stack)

Returns a new VkPresentRegionKHR instance allocated on the specified MemoryStack.

static VkPresentRegionKHR

mallocStack()

Deprecated.

static VkPresentRegionKHR.Buffer

mallocStack(int capacity)

Deprecated.

static VkPresentRegionKHR.Buffer

mallocStack(int capacity, MemoryStack stack)

Deprecated.

static VkPresentRegionKHR

mallocStack(MemoryStack stack)

Deprecated.

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

either NULL or a pointer to an array of VkRectLayerKHR structures.

VkPresentRegionKHR

pRectangles(VkRectLayerKHR.Buffer value)

Sets the address of the specified VkRectLayerKHR.Buffer to the pRectangles() field.

int

rectangleCount()

the number of rectangles in pRectangles, or zero if the entire image has changed and should be presented.

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

Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, 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.
- RECTANGLECOUNT
  
  public static final int RECTANGLECOUNT
  
  The struct member offsets.
- PRECTANGLES
  
  public static final int PRECTANGLES
  
  The struct member offsets.
Constructor Details
- VkPresentRegionKHR
  
  public VkPresentRegionKHR(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 Details
- sizeof
  
  public int sizeof()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<VkPresentRegionKHR>
- rectangleCount
  
  public int rectangleCount()
  
  the number of rectangles in pRectangles, or zero if the entire image has changed and should be presented.
- pRectangles
  
  @Nullable public VkRectLayerKHR.Buffer 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. The rectangles must be specified relative to VkSurfaceCapabilitiesKHR::currentTransform, regardless of the swapchain’s preTransform. The presentation engine will apply the preTransform transformation to the rectangles, along with any further transformation it applies to the image content.
- 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
  
  @Deprecated public static VkPresentRegionKHR mallocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkPresentRegionKHR callocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkPresentRegionKHR mallocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkPresentRegionKHR callocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkPresentRegionKHR.Buffer mallocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkPresentRegionKHR.Buffer callocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkPresentRegionKHR.Buffer mallocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkPresentRegionKHR.Buffer callocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static VkPresentRegionKHR malloc(MemoryStack stack)
  
  Returns a new VkPresentRegionKHR instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkPresentRegionKHR calloc(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
- malloc
  
  public static VkPresentRegionKHR.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new VkPresentRegionKHR.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkPresentRegionKHR.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new VkPresentRegionKHR.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
- 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

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

RECTANGLECOUNT

PRECTANGLES

Constructor Details

VkPresentRegionKHR

Method Details

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

malloc

calloc

malloc

calloc

nrectangleCount

npRectangles

nrectangleCount

npRectangles