Package org.lwjgl.vulkan
Class VkPresentRegionKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPresentRegionKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkPresentRegionKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure containing rectangular region changed by vkQueuePresentKHR for a given VkImage.Valid Usage (Implicit)
- If
rectangleCount
is not 0, andpRectangles
is notNULL
,pRectangles
must be a valid pointer to an array ofrectangleCount
validVkRectLayerKHR
structures
See Also
VkPresentRegionsKHR
,VkRectLayerKHR
Member documentation
rectangleCount
– the number of rectangles inpRectangles
, or zero if the entire image has changed and should be presented.pRectangles
– eitherNULL
or a pointer to an array ofVkRectLayerKHR
structures. TheVkRectLayerKHR
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 inpRectangles
is a rectangle of the given image that has changed since the last image was presented to the given swapchain.
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 ofVkPresentRegionKHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
PRECTANGLES
RECTANGLECOUNTThe struct member offsets.static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor Description VkPresentRegionKHR(java.nio.ByteBuffer container)
Creates aVkPresentRegionKHR
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 VkPresentRegionKHR
calloc()
Returns a newVkPresentRegionKHR
instance allocated withmemCalloc
.static VkPresentRegionKHR.Buffer
calloc(int capacity)
Returns a newVkPresentRegionKHR.Buffer
instance allocated withmemCalloc
.static VkPresentRegionKHR
callocStack()
Returns a newVkPresentRegionKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPresentRegionKHR.Buffer
callocStack(int capacity)
Returns a newVkPresentRegionKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPresentRegionKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPresentRegionKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPresentRegionKHR
create()
Returns a newVkPresentRegionKHR
instance allocated withBufferUtils
.static VkPresentRegionKHR.Buffer
create(int capacity)
Returns a newVkPresentRegionKHR.Buffer
instance allocated withBufferUtils
.static VkPresentRegionKHR
create(long address)
Returns a newVkPresentRegionKHR
instance for the specified memory address.static VkPresentRegionKHR.Buffer
create(long address, int capacity)
Create aVkPresentRegionKHR.Buffer
instance at the specified memory.static VkPresentRegionKHR
createSafe(long address)
static VkPresentRegionKHR.Buffer
createSafe(long address, int capacity)
static VkPresentRegionKHR
malloc()
Returns a newVkPresentRegionKHR
instance allocated withmemAlloc
.static VkPresentRegionKHR.Buffer
malloc(int capacity)
Returns a newVkPresentRegionKHR.Buffer
instance allocated withmemAlloc
.static VkPresentRegionKHR
mallocStack()
Returns a newVkPresentRegionKHR
instance allocated on the thread-localMemoryStack
.static VkPresentRegionKHR.Buffer
mallocStack(int capacity)
Returns a newVkPresentRegionKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkPresentRegionKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkPresentRegionKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionKHR
instance allocated on the specifiedMemoryStack
.static VkRectLayerKHR.Buffer
npRectangles(long struct)
Unsafe version ofpRectangles()
.static void
npRectangles(long struct, VkRectLayerKHR.Buffer value)
Unsafe version ofpRectangles
.static int
nrectangleCount(long struct)
Unsafe version ofrectangleCount()
.static void
nrectangleCount(long struct, int value)
Sets the specified value to therectangleCount
field of the specifiedstruct
.VkRectLayerKHR.Buffer
pRectangles()
Returns aVkRectLayerKHR.Buffer
view of the struct array pointed to by thepRectangles
field.VkPresentRegionKHR
pRectangles(VkRectLayerKHR.Buffer value)
Sets the address of the specifiedVkRectLayerKHR.Buffer
to thepRectangles
field.int
rectangleCount()
Returns the value of therectangleCount
field.VkPresentRegionKHR
rectangleCount(int value)
Sets the specified value to therectangleCount
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()
-
-
-
Constructor Detail
-
VkPresentRegionKHR
public VkPresentRegionKHR(java.nio.ByteBuffer container)
Creates aVkPresentRegionKHR
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
-
rectangleCount
public int rectangleCount()
Returns the value of therectangleCount
field.
-
pRectangles
@Nullable public VkRectLayerKHR.Buffer pRectangles()
Returns aVkRectLayerKHR.Buffer
view of the struct array pointed to by thepRectangles
field.
-
rectangleCount
public VkPresentRegionKHR rectangleCount(int value)
Sets the specified value to therectangleCount
field.
-
pRectangles
public VkPresentRegionKHR pRectangles(@Nullable VkRectLayerKHR.Buffer value)
Sets the address of the specifiedVkRectLayerKHR.Buffer
to thepRectangles
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 newVkPresentRegionKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPresentRegionKHR calloc()
Returns a newVkPresentRegionKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPresentRegionKHR create()
Returns a newVkPresentRegionKHR
instance allocated withBufferUtils
.
-
create
public static VkPresentRegionKHR create(long address)
Returns a newVkPresentRegionKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkPresentRegionKHR createSafe(long address)
-
malloc
public static VkPresentRegionKHR.Buffer malloc(int capacity)
Returns a newVkPresentRegionKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPresentRegionKHR.Buffer calloc(int capacity)
Returns a newVkPresentRegionKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPresentRegionKHR.Buffer create(int capacity)
Returns a newVkPresentRegionKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPresentRegionKHR.Buffer create(long address, int capacity)
Create aVkPresentRegionKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPresentRegionKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPresentRegionKHR mallocStack()
Returns a newVkPresentRegionKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPresentRegionKHR callocStack()
Returns a newVkPresentRegionKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPresentRegionKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPresentRegionKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPresentRegionKHR.Buffer mallocStack(int capacity)
Returns a newVkPresentRegionKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPresentRegionKHR.Buffer callocStack(int capacity)
Returns a newVkPresentRegionKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPresentRegionKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPresentRegionKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nrectangleCount
public static int nrectangleCount(long struct)
Unsafe version ofrectangleCount()
.
-
npRectangles
@Nullable public static VkRectLayerKHR.Buffer npRectangles(long struct)
Unsafe version ofpRectangles()
.
-
nrectangleCount
public static void nrectangleCount(long struct, int value)
Sets the specified value to therectangleCount
field of the specifiedstruct
.
-
npRectangles
public static void npRectangles(long struct, @Nullable VkRectLayerKHR.Buffer value)
Unsafe version ofpRectangles
.
-
-