Package org.lwjgl.vulkan
Class VkPresentRegionsKHR
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
Structure hint of rectangular regions changed by vkQueuePresentKHR.
Valid Usage
swapchainCount
must be the same value asVkPresentInfoKHR
::swapchainCount
, whereVkPresentInfoKHR
is included in thepNext
chain of thisVkPresentRegionsKHR
structure
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PRESENT_REGIONS_KHR
- If
pRegions
is notNULL
,pRegions
must be a valid pointer to an array ofswapchainCount
validVkPresentRegionKHR
structures swapchainCount
must be greater than 0
See Also
Layout
struct VkPresentRegionsKHR {
VkStructureType sType()
;
void const * pNext()
;
uint32_t swapchainCount()
;
VkPresentRegionKHR
const * pRegions()
;
}
-
Nested Class Summary
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
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkPresentRegionsKHR
(ByteBuffer container) Creates aVkPresentRegionsKHR
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkPresentRegionsKHR
calloc()
Returns a newVkPresentRegionsKHR
instance allocated withmemCalloc
.static VkPresentRegionsKHR.Buffer
calloc
(int capacity) Returns a newVkPresentRegionsKHR.Buffer
instance allocated withmemCalloc
.static VkPresentRegionsKHR.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPresentRegionsKHR
calloc
(MemoryStack stack) Returns a newVkPresentRegionsKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPresentRegionsKHR
Deprecated.static VkPresentRegionsKHR.Buffer
callocStack
(int capacity) Deprecated.static VkPresentRegionsKHR.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VkPresentRegionsKHR
callocStack
(MemoryStack stack) Deprecated.static VkPresentRegionsKHR
create()
Returns a newVkPresentRegionsKHR
instance allocated withBufferUtils
.static VkPresentRegionsKHR.Buffer
create
(int capacity) Returns a newVkPresentRegionsKHR.Buffer
instance allocated withBufferUtils
.static VkPresentRegionsKHR
create
(long address) Returns a newVkPresentRegionsKHR
instance for the specified memory address.static VkPresentRegionsKHR.Buffer
create
(long address, int capacity) Create aVkPresentRegionsKHR.Buffer
instance at the specified memory.static VkPresentRegionsKHR
createSafe
(long address) static VkPresentRegionsKHR.Buffer
createSafe
(long address, int capacity) static VkPresentRegionsKHR
malloc()
Returns a newVkPresentRegionsKHR
instance allocated withmemAlloc
.static VkPresentRegionsKHR.Buffer
malloc
(int capacity) Returns a newVkPresentRegionsKHR.Buffer
instance allocated withmemAlloc
.static VkPresentRegionsKHR.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkPresentRegionsKHR
malloc
(MemoryStack stack) Returns a newVkPresentRegionsKHR
instance allocated on the specifiedMemoryStack
.static VkPresentRegionsKHR
Deprecated.static VkPresentRegionsKHR.Buffer
mallocStack
(int capacity) Deprecated.static VkPresentRegionsKHR.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkPresentRegionsKHR
mallocStack
(MemoryStack stack) Deprecated.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static VkPresentRegionKHR.Buffer
npRegions
(long struct) Unsafe version ofpRegions()
.static void
npRegions
(long struct, VkPresentRegionKHR.Buffer value) Unsafe version ofpRegions
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.static int
nswapchainCount
(long struct) Unsafe version ofswapchainCount()
.static void
nswapchainCount
(long struct, int value) Sets the specified value to theswapchainCount
field of the specifiedstruct
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.pRegions()
Sets the address of the specifiedVkPresentRegionKHR.Buffer
to thepRegions()
field.set
(int sType, long pNext, int swapchainCount, VkPresentRegionKHR.Buffer pRegions) Initializes this struct with the specified values.set
(VkPresentRegionsKHR src) Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_PRESENT_REGIONS_KHR
value to thesType()
field.int
the number of swapchains being presented to by this command.swapchainCount
(int value) Sets the specified value to theswapchainCount()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
SWAPCHAINCOUNT
public static final int SWAPCHAINCOUNTThe struct member offsets. -
PREGIONS
public static final int PREGIONSThe struct member offsets.
-
-
Constructor Details
-
VkPresentRegionsKHR
Creates aVkPresentRegionsKHR
instance at the current position of the specifiedByteBuffer
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
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkPresentRegionsKHR>
-
sType
public int sType()aVkStructureType
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
NULL
or a pointer to an array ofVkPresentRegionKHR
elements withswapchainCount
entries. If notNULL
, each element ofpRegions
contains the region that has changed since the last present to the swapchain in the corresponding entry in theVkPresentInfoKHR
::pSwapchains
array. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_PRESENT_REGIONS_KHR
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
swapchainCount
Sets the specified value to theswapchainCount()
field. -
pRegions
Sets the address of the specifiedVkPresentRegionKHR.Buffer
to thepRegions()
field. -
set
public VkPresentRegionsKHR set(int sType, long pNext, int swapchainCount, @Nullable VkPresentRegionKHR.Buffer pRegions) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPresentRegionsKHR
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkPresentRegionsKHR
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkPresentRegionsKHR
instance allocated withBufferUtils
. -
create
Returns a newVkPresentRegionsKHR
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPresentRegionsKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkPresentRegionsKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkPresentRegionsKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkPresentRegionsKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkPresentRegionsKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkPresentRegionsKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType()
. -
npNext
public static long npNext(long struct) Unsafe version ofpNext()
. -
nswapchainCount
public static int nswapchainCount(long struct) Unsafe version ofswapchainCount()
. -
npRegions
Unsafe version ofpRegions()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
nswapchainCount
public static void nswapchainCount(long struct, int value) Sets the specified value to theswapchainCount
field of the specifiedstruct
. -
npRegions
Unsafe version ofpRegions
.
-