Package org.lwjgl.vulkan

Class VkPresentRegionsKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPresentRegionsKHR>

org.lwjgl.vulkan.VkPresentRegionsKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkPresentRegionsKHR
extends Struct<VkPresentRegionsKHR>
implements NativeResource

 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

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	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, MemoryStack stack)	Returns a new VkPresentRegionsKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPresentRegionsKHR	calloc(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 @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, MemoryStack stack)	Returns a new VkPresentRegionsKHR.Buffer instance allocated on the specified MemoryStack.
static VkPresentRegionsKHR	malloc(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 @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()
VkPresentRegionsKHR	pNext(long value)	Sets the specified value to the pNext field.
@Nullable VkPresentRegionKHR.Buffer	pRegions()
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()	Returns sizeof(struct).
int	sType()
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()
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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkPresentRegionsKHR>

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

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

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.

malloc

public static VkPresentRegionsKHR malloc(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(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,
 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,
 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.