Package org.lwjgl.vulkan

Class 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, and pRectangles is not NULL, pRectangles must be a valid pointer to an array of rectangleCount valid VkRectLayerKHR structures
    See Also

    VkPresentRegionsKHR, VkRectLayerKHR

    Layout

    
 struct VkPresentRegionKHR {
     uint32_t rectangleCount();
     VkRectLayerKHR const * pRectangles();
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • RECTANGLECOUNT, PRECTANGLES

        The struct member offsets.

    • Constructor Detail

      • VkPresentRegionKHR

        public VkPresentRegionKHR​(java.nio.ByteBuffer container)
        Creates a VkPresentRegionKHR 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 Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • rectangleCount

        public int rectangleCount()
        the number of rectangles in pRectangles, or zero if the entire image has changed and should be presented.

      • pRectangles

        @Nullable
public VkRectLayerKHR.Buffer pRectangles()
        either NULL or a pointer to an array of VkRectLayerKHR structures. The VkRectLayerKHR 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 in pRectangles is a rectangle of the given image that has changed since the last image was presented to the given swapchain. The rectangles must be specified relative to VkSurfaceCapabilitiesKHR::currentTransform, regardless of the swapchain’s preTransform. The presentation engine will apply the preTransform transformation to the rectangles, along with any further transformation it applies to the image content.

      • malloc

        public static VkPresentRegionKHR malloc()
        Returns a new VkPresentRegionKHR instance allocated with memAlloc. The instance must be explicitly freed.

      • calloc

        public static VkPresentRegionKHR calloc()
        Returns a new VkPresentRegionKHR instance allocated with memCalloc. The instance must be explicitly freed.

      • create

        public static VkPresentRegionKHR create()
        Returns a new VkPresentRegionKHR instance allocated with BufferUtils.

      • create

        public static VkPresentRegionKHR create​(long address)
        Returns a new VkPresentRegionKHR instance for the specified memory address.

      • createSafe

        @Nullable
public static VkPresentRegionKHR createSafe​(long address)
        Like create, but returns null if address is NULL.

      • createSafe

        @Nullable
public static VkPresentRegionKHR.Buffer createSafe​(long address,
                                                   int capacity)
        Like create, but returns null if address is NULL.

      • mallocStack

        @Deprecated
public static VkPresentRegionKHR mallocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

      • callocStack

        @Deprecated
public static VkPresentRegionKHR callocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

      • malloc

        public static VkPresentRegionKHR malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkPresentRegionKHR instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • calloc

        public static VkPresentRegionKHR calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkPresentRegionKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate

      • malloc

        public static VkPresentRegionKHR.Buffer malloc​(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
        Returns a new VkPresentRegionKHR.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • calloc

        public static VkPresentRegionKHR.Buffer calloc​(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
        Returns a new VkPresentRegionKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • nrectangleCount

        public static int nrectangleCount​(long struct)
        Unsafe version of rectangleCount().

      • nrectangleCount

        public static void nrectangleCount​(long struct,
                                   int value)
        Sets the specified value to the rectangleCount field of the specified struct.