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.NativeResourceStructure containing rectangular region changed by vkQueuePresentKHR for a given VkImage.Valid Usage (Implicit)
- If
rectangleCountis not 0, andpRectanglesis notNULL,pRectanglesmust be a valid pointer to an array ofrectangleCountvalidVkRectLayerKHRstructures
See Also
VkPresentRegionsKHR,VkRectLayerKHRMember documentation
rectangleCount– the number of rectangles inpRectangles, or zero if the entire image has changed and should be presented.pRectangles– eitherNULLor a pointer to an array ofVkRectLayerKHRstructures. TheVkRectLayerKHRstructure 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 inpRectanglesis 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;VkRectLayerKHRconst * pRectangles; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPresentRegionKHR.BufferAn array ofVkPresentRegionKHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intPRECTANGLES
RECTANGLECOUNTThe struct member offsets.static intSIZEOFThe struct size in bytes.
-
Constructor Summary
Constructors Constructor Description VkPresentRegionKHR(java.nio.ByteBuffer container)Creates aVkPresentRegionKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPresentRegionKHRcalloc()Returns a newVkPresentRegionKHRinstance allocated withmemCalloc.static VkPresentRegionKHR.Buffercalloc(int capacity)Returns a newVkPresentRegionKHR.Bufferinstance allocated withmemCalloc.static VkPresentRegionKHRcallocStack()Returns a newVkPresentRegionKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPresentRegionKHR.BuffercallocStack(int capacity)Returns a newVkPresentRegionKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPresentRegionKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPresentRegionKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPresentRegionKHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkPresentRegionKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPresentRegionKHRcreate()Returns a newVkPresentRegionKHRinstance allocated withBufferUtils.static VkPresentRegionKHR.Buffercreate(int capacity)Returns a newVkPresentRegionKHR.Bufferinstance allocated withBufferUtils.static VkPresentRegionKHRcreate(long address)Returns a newVkPresentRegionKHRinstance for the specified memory address.static VkPresentRegionKHR.Buffercreate(long address, int capacity)Create aVkPresentRegionKHR.Bufferinstance at the specified memory.static VkPresentRegionKHRcreateSafe(long address)static VkPresentRegionKHR.BuffercreateSafe(long address, int capacity)static VkPresentRegionKHRmalloc()Returns a newVkPresentRegionKHRinstance allocated withmemAlloc.static VkPresentRegionKHR.Buffermalloc(int capacity)Returns a newVkPresentRegionKHR.Bufferinstance allocated withmemAlloc.static VkPresentRegionKHRmallocStack()Returns a newVkPresentRegionKHRinstance allocated on the thread-localMemoryStack.static VkPresentRegionKHR.BuffermallocStack(int capacity)Returns a newVkPresentRegionKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkPresentRegionKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPresentRegionKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkPresentRegionKHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkPresentRegionKHRinstance allocated on the specifiedMemoryStack.static VkRectLayerKHR.BuffernpRectangles(long struct)Unsafe version ofpRectangles().static voidnpRectangles(long struct, VkRectLayerKHR.Buffer value)Unsafe version ofpRectangles.static intnrectangleCount(long struct)Unsafe version ofrectangleCount().static voidnrectangleCount(long struct, int value)Sets the specified value to therectangleCountfield of the specifiedstruct.VkRectLayerKHR.BufferpRectangles()Returns aVkRectLayerKHR.Bufferview of the struct array pointed to by thepRectanglesfield.VkPresentRegionKHRpRectangles(VkRectLayerKHR.Buffer value)Sets the address of the specifiedVkRectLayerKHR.Bufferto thepRectanglesfield.intrectangleCount()Returns the value of therectangleCountfield.VkPresentRegionKHRrectangleCount(int value)Sets the specified value to therectangleCountfield.VkPresentRegionKHRset(int rectangleCount, VkRectLayerKHR.Buffer pRectangles)Initializes this struct with the specified values.VkPresentRegionKHRset(VkPresentRegionKHR src)Copies the specified struct data to this struct.intsizeof()
-
-
-
Constructor Detail
-
VkPresentRegionKHR
public VkPresentRegionKHR(java.nio.ByteBuffer container)
Creates aVkPresentRegionKHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
rectangleCount
public int rectangleCount()
Returns the value of therectangleCountfield.
-
pRectangles
@Nullable public VkRectLayerKHR.Buffer pRectangles()
Returns aVkRectLayerKHR.Bufferview of the struct array pointed to by thepRectanglesfield.
-
rectangleCount
public VkPresentRegionKHR rectangleCount(int value)
Sets the specified value to therectangleCountfield.
-
pRectangles
public VkPresentRegionKHR pRectangles(@Nullable VkRectLayerKHR.Buffer value)
Sets the address of the specifiedVkRectLayerKHR.Bufferto thepRectanglesfield.
-
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 newVkPresentRegionKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPresentRegionKHR calloc()
Returns a newVkPresentRegionKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPresentRegionKHR create()
Returns a newVkPresentRegionKHRinstance allocated withBufferUtils.
-
create
public static VkPresentRegionKHR create(long address)
Returns a newVkPresentRegionKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkPresentRegionKHR createSafe(long address)
-
malloc
public static VkPresentRegionKHR.Buffer malloc(int capacity)
Returns a newVkPresentRegionKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPresentRegionKHR.Buffer calloc(int capacity)
Returns a newVkPresentRegionKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPresentRegionKHR.Buffer create(int capacity)
Returns a newVkPresentRegionKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPresentRegionKHR.Buffer create(long address, int capacity)
Create aVkPresentRegionKHR.Bufferinstance 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 newVkPresentRegionKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPresentRegionKHR callocStack()
Returns a newVkPresentRegionKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPresentRegionKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPresentRegionKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPresentRegionKHRinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPresentRegionKHR.Buffer callocStack(int capacity)
Returns a newVkPresentRegionKHR.Bufferinstance allocated on the thread-localMemoryStackand 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.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand 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 therectangleCountfield of the specifiedstruct.
-
npRectangles
public static void npRectangles(long struct, @Nullable VkRectLayerKHR.Buffer value)Unsafe version ofpRectangles.
-
-