Class VkFormatProperties3

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    Direct Known Subclasses:
    VkFormatProperties3KHR

    public class VkFormatProperties3
    extends org.lwjgl.system.Struct
    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 Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, LINEARTILINGFEATURES, OPTIMALTILINGFEATURES, BUFFERFEATURES

        The struct member offsets.
    • Constructor Detail

      • VkFormatProperties3

        public VkFormatProperties3​(java.nio.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 Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • 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.
      • 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.
      • 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

        @Nullable
        public static VkFormatProperties3 createSafe​(long address)
        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:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • 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:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • 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.