Package org.lwjgl.vulkan

Class VkFormatProperties3

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

The bits reported in linearTilingFeatures, optimalTilingFeatures and bufferFeatures must include the bits reported in the corresponding fields of VkFormatProperties2::formatProperties.

Valid Usage (Implicit)

Layout


 struct VkFormatProperties3 {
     VkStructureType sType;
     void * pNext;
     VkFormatFeatureFlags2 linearTilingFeatures();
     VkFormatFeatureFlags2 optimalTilingFeatures();
     VkFormatFeatureFlags2 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.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • 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

    • VkFormatProperties3

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

    • sType

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

    • pNext

      public long pNext()
      Returns:
      the value of the pNext field.

    • linearTilingFeatures

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

    • optimalTilingFeatures

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

    • bufferFeatures

      public long bufferFeatures()
      a bitmask of VkFormatFeatureFlagBits2 specifying features supported by buffers.

    • sType

      public VkFormatProperties3 sType(int value)
      Sets the specified value to the sType field.

    • sType$Default

      public VkFormatProperties3 sType$Default()
      Sets the STRUCTURE_TYPE_FORMAT_PROPERTIES_3 value to the sType field.

    • pNext

      public VkFormatProperties3 pNext(long value)
      Sets the specified value to the pNext field.

    • set

      public VkFormatProperties3 set(int sType, long pNext)
      Initializes this struct with the specified values.

    • set

      public VkFormatProperties3 set(VkFormatProperties3 src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nsType

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

    • npNext

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

    • nlinearTilingFeatures

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

    • noptimalTilingFeatures

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

    • nbufferFeatures

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

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