Package org.lwjgl.vulkan

Class VkSurfaceCapabilitiesKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSurfaceCapabilitiesKHR>
org.lwjgl.vulkan.VkSurfaceCapabilitiesKHR
All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer
public class VkSurfaceCapabilitiesKHR extends Struct<VkSurfaceCapabilitiesKHR> implements NativeResource

 struct VkSurfaceCapabilitiesKHR {
     uint32_t minImageCount;
     uint32_t maxImageCount;
     VkExtent2D currentExtent;
     VkExtent2D minImageExtent;
     VkExtent2D maxImageExtent;
     uint32_t maxImageArrayLayers;
     VkSurfaceTransformFlagsKHR supportedTransforms;
     VkSurfaceTransformFlagBitsKHR currentTransform;
     VkCompositeAlphaFlagsKHR supportedCompositeAlpha;
     VkImageUsageFlags supportedUsageFlags;
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • MINIMAGECOUNT

      public static final int MINIMAGECOUNT
      The struct member offsets.

    • MAXIMAGECOUNT

      public static final int MAXIMAGECOUNT
      The struct member offsets.

    • CURRENTEXTENT

      public static final int CURRENTEXTENT
      The struct member offsets.

    • MINIMAGEEXTENT

      public static final int MINIMAGEEXTENT
      The struct member offsets.

    • MAXIMAGEEXTENT

      public static final int MAXIMAGEEXTENT
      The struct member offsets.

    • MAXIMAGEARRAYLAYERS

      public static final int MAXIMAGEARRAYLAYERS
      The struct member offsets.

    • SUPPORTEDTRANSFORMS

      public static final int SUPPORTEDTRANSFORMS
      The struct member offsets.

    • CURRENTTRANSFORM

      public static final int CURRENTTRANSFORM
      The struct member offsets.

    • SUPPORTEDCOMPOSITEALPHA

      public static final int SUPPORTEDCOMPOSITEALPHA
      The struct member offsets.

    • SUPPORTEDUSAGEFLAGS

      public static final int SUPPORTEDUSAGEFLAGS
      The struct member offsets.

  • Constructor Details

    • VkSurfaceCapabilitiesKHR

      public VkSurfaceCapabilitiesKHR(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 Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<VkSurfaceCapabilitiesKHR>

    • minImageCount

      public int minImageCount()
      Returns:
      the value of the minImageCount field.

    • maxImageCount

      public int maxImageCount()
      Returns:
      the value of the maxImageCount field.

    • currentExtent

      public VkExtent2D currentExtent()
      Returns:
      a VkExtent2D view of the currentExtent field.

    • minImageExtent

      public VkExtent2D minImageExtent()
      Returns:
      a VkExtent2D view of the minImageExtent field.

    • maxImageExtent

      public VkExtent2D maxImageExtent()
      Returns:
      a VkExtent2D view of the maxImageExtent field.

    • maxImageArrayLayers

      public int maxImageArrayLayers()
      Returns:
      the value of the maxImageArrayLayers field.

    • supportedTransforms

      public int supportedTransforms()
      Returns:
      the value of the supportedTransforms field.

    • currentTransform

      public int currentTransform()
      Returns:
      the value of the currentTransform field.

    • supportedCompositeAlpha

      public int supportedCompositeAlpha()
      Returns:
      the value of the supportedCompositeAlpha field.

    • supportedUsageFlags

      public int supportedUsageFlags()
      Returns:
      the value of the supportedUsageFlags field.

    • 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.

    • createSafe

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

    • malloc

      public static VkSurfaceCapabilitiesKHR.Buffer malloc(int capacity)
      Returns a new VkSurfaceCapabilitiesKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkSurfaceCapabilitiesKHR.Buffer calloc(int capacity)
      Returns a new VkSurfaceCapabilitiesKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkSurfaceCapabilitiesKHR.Buffer create(int capacity)
      Returns a new VkSurfaceCapabilitiesKHR.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkSurfaceCapabilitiesKHR.Buffer create(long address, int capacity)
      Create a VkSurfaceCapabilitiesKHR.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

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

    • malloc

      public static VkSurfaceCapabilitiesKHR malloc(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(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

    • malloc

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

    • calloc

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

    • nminImageCount

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

    • nmaxImageCount

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

    • ncurrentExtent

      public static VkExtent2D ncurrentExtent(long struct)
      Unsafe version of currentExtent().

    • nminImageExtent

      public static VkExtent2D nminImageExtent(long struct)
      Unsafe version of minImageExtent().

    • nmaxImageExtent

      public static VkExtent2D nmaxImageExtent(long struct)
      Unsafe version of maxImageExtent().

    • 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().