Package org.lwjgl.vulkan

Class VkFormatProperties

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkFormatProperties>
org.lwjgl.vulkan.VkFormatProperties
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkFormatProperties extends org.lwjgl.system.Struct<VkFormatProperties> implements org.lwjgl.system.NativeResource
Structure specifying image format properties.
Description
Note

If no format feature flags are supported, the format itself is not supported, and images of that format cannot be created.

If format is a block-compressed format, then bufferFeatures must not support any features for the format.

If format is not a multi-plane format then linearTilingFeatures and optimalTilingFeatures must not contain FORMAT_FEATURE_DISJOINT_BIT.

See Also

VkFormatProperties2, GetPhysicalDeviceFormatProperties

Layout


 struct VkFormatProperties {
     VkFormatFeatureFlags linearTilingFeatures();
     VkFormatFeatureFlags optimalTilingFeatures();
     VkFormatFeatureFlags bufferFeatures();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • LINEARTILINGFEATURES

      public static final int LINEARTILINGFEATURES
      The struct member offsets.

    • OPTIMALTILINGFEATURES

      public static final int OPTIMALTILINGFEATURES
      The struct member offsets.

    • BUFFERFEATURES

      public static final int BUFFERFEATURES
      The struct member offsets.

  • Constructor Details

    • VkFormatProperties

      public VkFormatProperties(ByteBuffer container)
      Creates a VkFormatProperties 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<VkFormatProperties>

    • linearTilingFeatures

      public int linearTilingFeatures()
      a bitmask of VkFormatFeatureFlagBits specifying features supported by images created with a tiling parameter of IMAGE_TILING_LINEAR.

    • optimalTilingFeatures

      public int optimalTilingFeatures()
      a bitmask of VkFormatFeatureFlagBits specifying features supported by images created with a tiling parameter of IMAGE_TILING_OPTIMAL.

    • bufferFeatures

      public int bufferFeatures()
      a bitmask of VkFormatFeatureFlagBits specifying features supported by buffers.

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

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

    • callocStack

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

    • mallocStack

      @Deprecated public static VkFormatProperties.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 VkFormatProperties.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 VkFormatProperties malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkFormatProperties instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

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

    • malloc

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

    • calloc

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

    • nlinearTilingFeatures

      public static int nlinearTilingFeatures(long struct)
      Unsafe version of linearTilingFeatures().

    • noptimalTilingFeatures

      public static int noptimalTilingFeatures(long struct)
      Unsafe version of optimalTilingFeatures().

    • nbufferFeatures

      public static int nbufferFeatures(long struct)
      Unsafe version of bufferFeatures().