Package org.lwjgl.vulkan

Class VkSurfaceFormatKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkSurfaceFormatKHR>
org.lwjgl.vulkan.VkSurfaceFormatKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkSurfaceFormatKHR extends org.lwjgl.system.Struct<VkSurfaceFormatKHR> implements org.lwjgl.system.NativeResource
Structure describing a supported swapchain format-color space pair.
See Also

VkSurfaceFormat2KHR, GetPhysicalDeviceSurfaceFormatsKHR

Layout


 struct VkSurfaceFormatKHR {
     VkFormat format();
     VkColorSpaceKHR colorSpace();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • FORMAT

      public static final int FORMAT
      The struct member offsets.

    • COLORSPACE

      public static final int COLORSPACE
      The struct member offsets.

  • Constructor Details

    • VkSurfaceFormatKHR

      public VkSurfaceFormatKHR(ByteBuffer container)
      Creates a VkSurfaceFormatKHR 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()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<VkSurfaceFormatKHR>

    • format

      public int format()
      a VkFormat that is compatible with the specified surface.

    • colorSpace

      public int colorSpace()
      a presentation VkColorSpaceKHR that is compatible with the surface.

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • mallocStack

      @Deprecated public static VkSurfaceFormatKHR mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkSurfaceFormatKHR callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

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

    • callocStack

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

    • mallocStack

      @Deprecated public static VkSurfaceFormatKHR.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkSurfaceFormatKHR.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkSurfaceFormatKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkSurfaceFormatKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nformat

      public static int nformat(long struct)
      Unsafe version of format().

    • ncolorSpace

      public static int ncolorSpace(long struct)
      Unsafe version of colorSpace().