Package org.lwjgl.vulkan

Class VkExportMetalBufferInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkExportMetalBufferInfoEXT>
org.lwjgl.vulkan.VkExportMetalBufferInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkExportMetalBufferInfoEXT extends org.lwjgl.system.Struct<VkExportMetalBufferInfoEXT> implements org.lwjgl.system.NativeResource
Structure that identifies a VkDeviceMemory object and corresponding Metal MTLBuffer object.
Valid Usage (Implicit)

Layout


 struct VkExportMetalBufferInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkDeviceMemory memory();
     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.

    • MEMORY

      public static final int MEMORY
      The struct member offsets.

    • MTLBUFFER

      public static final int MTLBUFFER
      The struct member offsets.

  • Constructor Details

    • VkExportMetalBufferInfoEXT

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

    • sType

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

    • pNext

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

    • memory

      public long memory()
      a VkDeviceMemory.

    • mtlBuffer

      public long mtlBuffer()
      the Metal id&lt;MTLBuffer&gt; object underlying the VkDeviceMemory object in memory. The implementation will return the MTLBuffer in this member, or it will return NULL if no MTLBuffer could be found underlying the VkDeviceMemory object.

    • sType

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

    • sType$Default

      public VkExportMetalBufferInfoEXT sType$Default()
      Sets the STRUCTURE_TYPE_EXPORT_METAL_BUFFER_INFO_EXT value to the sType() field.

    • pNext

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

    • memory

      public VkExportMetalBufferInfoEXT memory(long value)
      Sets the specified value to the memory() field.

    • mtlBuffer

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

    • set

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

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nmemory

      public static long nmemory(long struct)
      Unsafe version of memory().

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

    • nmemory

      public static void nmemory(long struct, long value)
      Unsafe version of memory.

    • 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