Class 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
    Valid Usage (Implicit)
    See Also

    VkPresentRegionKHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • swapchainCount – the number of swapchains being presented to by this command.
    • pRegionsNULL or a pointer to an array of VkPresentRegionKHR elements with swapchainCount entries. If not NULL, each element of pRegions contains the region that has changed since the last present to the swapchain in the corresponding entry in the VkPresentInfoKHR::pSwapchains array.

    Layout

    
     struct VkPresentRegionsKHR {
         VkStructureType sType;
         void const * pNext;
         uint32_t swapchainCount;
         VkPresentRegionKHR const * pRegions;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, SWAPCHAINCOUNT, PREGIONS

        The struct member offsets.
    • Constructor Detail

      • VkPresentRegionsKHR

        public VkPresentRegionsKHR​(java.nio.ByteBuffer container)
        Creates a VkPresentRegionsKHR 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
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • swapchainCount

        public int swapchainCount()
        Returns the value of the swapchainCount field.
      • sType

        public VkPresentRegionsKHR sType​(int value)
        Sets the specified value to the sType field.
      • pNext

        public VkPresentRegionsKHR pNext​(long value)
        Sets the specified value to the pNext field.
      • swapchainCount

        public VkPresentRegionsKHR swapchainCount​(int value)
        Sets the specified value to the swapchainCount field.
      • malloc

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

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

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

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

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

        public static VkPresentRegionsKHR mallocStack()
        Returns a new VkPresentRegionsKHR instance allocated on the thread-local MemoryStack.
      • callocStack

        public static VkPresentRegionsKHR callocStack()
        Returns a new VkPresentRegionsKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

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

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

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

        public static VkPresentRegionsKHR.Buffer callocStack​(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
        Returns a new VkPresentRegionsKHR.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
      • nsType

        public static int nsType​(long struct)
        Unsafe version of sType().
      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().
      • nswapchainCount

        public static int nswapchainCount​(long struct)
        Unsafe version of swapchainCount().
      • nsType

        public static void nsType​(long struct,
                                  int value)
        Unsafe version of sType.
      • npNext

        public static void npNext​(long struct,
                                  long value)
        Unsafe version of pNext.
      • nswapchainCount

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