Package org.lwjgl.vulkan
Class VkPresentRegionsKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPresentRegionsKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkPresentRegionsKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure hint of rectangular regions changed by vkQueuePresentKHR.Valid Usage
swapchainCount
must be the same value asVkPresentInfoKHR
::swapchainCount
, whereVkPresentInfoKHR
is 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
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.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.
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 ofVkPresentRegionsKHR
structs.
-
Constructor Summary
Constructors Constructor Description VkPresentRegionsKHR(java.nio.ByteBuffer container)
Creates aVkPresentRegionsKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPresentRegionsKHR
calloc()
Returns a newVkPresentRegionsKHR
instance allocated withmemCalloc
.static VkPresentRegionsKHR.Buffer
calloc(int capacity)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated withmemCalloc
.static VkPresentRegionsKHR
callocStack()
Returns a newVkPresentRegionsKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPresentRegionsKHR.Buffer
callocStack(int capacity)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPresentRegionsKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPresentRegionsKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionsKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.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
mallocStack()
Returns a newVkPresentRegionsKHR
instance allocated on the thread-localMemoryStack
.static VkPresentRegionsKHR.Buffer
mallocStack(int capacity)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkPresentRegionsKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkPresentRegionsKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionsKHR
instance allocated on the specifiedMemoryStack
.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()
Returns the value of thepNext
field.VkPresentRegionsKHR
pNext(long value)
Sets the specified value to thepNext
field.VkPresentRegionKHR.Buffer
pRegions()
Returns aVkPresentRegionKHR.Buffer
view of the struct array pointed to by thepRegions
field.VkPresentRegionsKHR
pRegions(VkPresentRegionKHR.Buffer value)
Sets the address of the specifiedVkPresentRegionKHR.Buffer
to thepRegions
field.VkPresentRegionsKHR
set(int sType, long pNext, int swapchainCount, 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()
Returns the value of thesType
field.VkPresentRegionsKHR
sType(int value)
Sets the specified value to thesType
field.int
swapchainCount()
Returns the value of theswapchainCount
field.VkPresentRegionsKHR
swapchainCount(int value)
Sets the specified value to theswapchainCount
field.
-
-
-
Constructor Detail
-
VkPresentRegionsKHR
public VkPresentRegionsKHR(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
swapchainCount
public int swapchainCount()
Returns the value of theswapchainCount
field.
-
pRegions
@Nullable public VkPresentRegionKHR.Buffer pRegions()
Returns aVkPresentRegionKHR.Buffer
view of the struct array pointed to by thepRegions
field.
-
sType
public VkPresentRegionsKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPresentRegionsKHR pNext(long value)
Sets the specified value to thepNext
field.
-
swapchainCount
public VkPresentRegionsKHR swapchainCount(int value)
Sets the specified value to theswapchainCount
field.
-
pRegions
public VkPresentRegionsKHR pRegions(@Nullable VkPresentRegionKHR.Buffer value)
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
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 newVkPresentRegionsKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPresentRegionsKHR calloc()
Returns a newVkPresentRegionsKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPresentRegionsKHR create()
Returns a newVkPresentRegionsKHR
instance allocated withBufferUtils
.
-
create
public static VkPresentRegionsKHR create(long address)
Returns a newVkPresentRegionsKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkPresentRegionsKHR createSafe(long address)
-
malloc
public static VkPresentRegionsKHR.Buffer malloc(int capacity)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPresentRegionsKHR.Buffer calloc(int capacity)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPresentRegionsKHR.Buffer create(int capacity)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPresentRegionsKHR.Buffer create(long address, int capacity)
Create aVkPresentRegionsKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPresentRegionsKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPresentRegionsKHR mallocStack()
Returns a newVkPresentRegionsKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPresentRegionsKHR callocStack()
Returns a newVkPresentRegionsKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPresentRegionsKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionsKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPresentRegionsKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionsKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPresentRegionsKHR.Buffer mallocStack(int capacity)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPresentRegionsKHR.Buffer callocStack(int capacity)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPresentRegionsKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPresentRegionsKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionsKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
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
@Nullable public static VkPresentRegionKHR.Buffer npRegions(long struct)
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
public static void npRegions(long struct, @Nullable VkPresentRegionKHR.Buffer value)
Unsafe version ofpRegions
.
-
-