Package org.lwjgl.vulkan

Class VkImportMetalBufferInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkImportMetalBufferInfoEXT>
org.lwjgl.vulkan.VkImportMetalBufferInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkImportMetalBufferInfoEXT extends org.lwjgl.system.Struct<VkImportMetalBufferInfoEXT> implements org.lwjgl.system.NativeResource
Structure that identifies a Metal MTLBuffer object to use when creating a VkDeviceMemory object.
Description

The application must ensure that the configuration of the id&lt;MTLBuffer&gt; object is compatible with the configuration of the VkDeviceMemory. Failure to do so results in undefined behavior.

Valid Usage (Implicit)

Layout


 struct VkImportMetalBufferInfoEXT {
     VkStructureType sType();
     void const * pNext();
     MTLBuffer_id mtlBuffer();
 }

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

    • MTLBUFFER

      public static final int MTLBUFFER
      The struct member offsets.

  • Constructor Details

    • VkImportMetalBufferInfoEXT

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

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

      public long pNext()
      NULL or a pointer to a structure extending this structure.

    • mtlBuffer

      public long mtlBuffer()
      the Metal id&lt;MTLBuffer&gt; object that is to underlie the VkDeviceMemory.

    • sType

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

    • sType$Default

      public VkImportMetalBufferInfoEXT sType$Default()
      Sets the STRUCTURE_TYPE_IMPORT_METAL_BUFFER_INFO_EXT value to the sType() field.

    • pNext

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

    • mtlBuffer

      public VkImportMetalBufferInfoEXT mtlBuffer(long value)
      Sets the specified value to the mtlBuffer() field.

    • set

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

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nmtlBuffer

      public static long nmtlBuffer(long struct)
      Unsafe version of mtlBuffer().

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

    • nmtlBuffer

      public static void nmtlBuffer(long struct, long value)
      Unsafe version of mtlBuffer.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate