Package org.lwjgl.vulkan

Class VkSurfaceCapabilitiesKHR

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • MINIMAGECOUNT, MAXIMAGECOUNT, CURRENTEXTENT, MINIMAGEEXTENT, MAXIMAGEEXTENT, MAXIMAGEARRAYLAYERS, SUPPORTEDTRANSFORMS, CURRENTTRANSFORM, SUPPORTEDCOMPOSITEALPHA, SUPPORTEDUSAGEFLAGS

        The struct member offsets.

    • Constructor Detail

      • VkSurfaceCapabilitiesKHR

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

      • minImageCount

        public int minImageCount()
        the minimum number of images the specified device supports for a swapchain created for the surface, and will be at least one.

      • maxImageCount

        public int maxImageCount()
        the maximum number of images the specified device supports for a swapchain created for the surface, and will be either 0, or greater than or equal to minImageCount. A value of 0 means that there is no limit on the number of images, though there may be limits related to the total amount of memory used by presentable images.

      • currentExtent

        public VkExtent2D currentExtent()
        the current width and height of the surface, or the special value (0xFFFFFFFF, 0xFFFFFFFF) indicating that the surface size will be determined by the extent of a swapchain targeting the surface.

      • minImageExtent

        public VkExtent2D minImageExtent()
        contains the smallest valid swapchain extent for the surface on the specified device. The width and height of the extent will each be less than or equal to the corresponding width and height of currentExtent, unless currentExtent has the special value described above.

      • maxImageExtent

        public VkExtent2D maxImageExtent()
        contains the largest valid swapchain extent for the surface on the specified device. The width and height of the extent will each be greater than or equal to the corresponding width and height of minImageExtent. The width and height of the extent will each be greater than or equal to the corresponding width and height of currentExtent, unless currentExtent has the special value described above.

      • maxImageArrayLayers

        public int maxImageArrayLayers()
        the maximum number of layers presentable images can have for a swapchain created for this device and surface, and will be at least one.

      • supportedTransforms

        public int supportedTransforms()
        a bitmask of VkSurfaceTransformFlagBitsKHR indicating the presentation transforms supported for the surface on the specified device. At least one bit will be set.

      • currentTransform

        public int currentTransform()
        VkSurfaceTransformFlagBitsKHR value indicating the surface’s current transform relative to the presentation engine’s natural orientation.

      • supportedCompositeAlpha

        public int supportedCompositeAlpha()
        a bitmask of VkCompositeAlphaFlagBitsKHR, representing the alpha compositing modes supported by the presentation engine for the surface on the specified device, and at least one bit will be set. Opaque composition can be achieved in any alpha compositing mode by either using an image format that has no alpha component, or by ensuring that all pixels in the presentable images have an alpha value of 1.0.

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • malloc

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

      • calloc

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

      • calloc

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

      • nminImageCount

        public static int nminImageCount​(long struct)
        Unsafe version of minImageCount().

      • nmaxImageCount

        public static int nmaxImageCount​(long struct)
        Unsafe version of maxImageCount().

      • nmaxImageArrayLayers

        public static int nmaxImageArrayLayers​(long struct)
        Unsafe version of maxImageArrayLayers().

      • nsupportedTransforms

        public static int nsupportedTransforms​(long struct)
        Unsafe version of supportedTransforms().

      • ncurrentTransform

        public static int ncurrentTransform​(long struct)
        Unsafe version of currentTransform().

      • nsupportedCompositeAlpha

        public static int nsupportedCompositeAlpha​(long struct)
        Unsafe version of supportedCompositeAlpha().

      • nsupportedUsageFlags

        public static int nsupportedUsageFlags​(long struct)
        Unsafe version of supportedUsageFlags().