Package org.lwjgl.vulkan

Class VkPresentRegionKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPresentRegionKHR>

org.lwjgl.vulkan.VkPresentRegionKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkPresentRegionKHR
extends Struct<VkPresentRegionKHR>
implements NativeResource

 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	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 @Nullable VkPresentRegionKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable 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 @Nullable VkRectLayerKHR.Buffer	npRectangles(long struct)	Unsafe version of pRectangles().
static void	npRectangles(long struct, @Nullable 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.
@Nullable VkRectLayerKHR.Buffer	pRectangles()
VkPresentRegionKHR	pRectangles(@Nullable VkRectLayerKHR.Buffer value)	Sets the address of the specified VkRectLayerKHR.Buffer to the pRectangles field.
int	rectangleCount()
VkPresentRegionKHR	rectangleCount(int value)	Sets the specified value to the rectangleCount field.
VkPresentRegionKHR	set(int rectangleCount, @Nullable 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, 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()

Returns:

the value of the rectangleCount field.

pRectangles

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

public static @Nullable 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

public static @Nullable VkPresentRegionKHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

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

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