Package org.lwjgl.vulkan

Class VkExportMetalTextureInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkExportMetalTextureInfoEXT>
org.lwjgl.vulkan.VkExportMetalTextureInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkExportMetalTextureInfoEXT extends org.lwjgl.system.Struct<VkExportMetalTextureInfoEXT> implements org.lwjgl.system.NativeResource
Structure that identifies a VkImage, VkImageView, or VkBufferView object and corresponding Metal MTLTexture object.
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_EXPORT_METAL_TEXTURE_INFO_EXT
  • If image is not NULL_HANDLE, image must be a valid VkImage handle
  • If imageView is not NULL_HANDLE, imageView must be a valid VkImageView handle
  • If bufferView is not NULL_HANDLE, bufferView must be a valid VkBufferView handle
  • plane must be a valid VkImageAspectFlagBits value
  • Each of bufferView, image, and imageView that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice

Layout


 struct VkExportMetalTextureInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkImage image();
     VkImageView imageView();
     VkBufferView bufferView();
     VkImageAspectFlagBits plane();
     MTLTexture_id mtlTexture();
 }

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

    • IMAGE

      public static final int IMAGE
      The struct member offsets.

    • IMAGEVIEW

      public static final int IMAGEVIEW
      The struct member offsets.

    • BUFFERVIEW

      public static final int BUFFERVIEW
      The struct member offsets.

    • PLANE

      public static final int PLANE
      The struct member offsets.

    • MTLTEXTURE

      public static final int MTLTEXTURE
      The struct member offsets.

  • Constructor Details

    • VkExportMetalTextureInfoEXT

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

    • sType

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

    • pNext

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

    • image

      public long image()
      NULL_HANDLE or a VkImage.

    • imageView

      public long imageView()
      NULL_HANDLE or a VkImageView.

    • bufferView

      public long bufferView()
      NULL_HANDLE or a VkBufferView.

    • plane

      public int plane()
      specifies the plane of a multi-planar VkImage or VkImageView.

    • mtlTexture

      public long mtlTexture()
      the Metal id&lt;MTLTexture&gt; object underlying the VkImage, VkImageView, or VkBufferView object in image, imageView, or bufferView, respectively, at the plane indicated in aspectMask. The implementation will return the MTLTexture in this member, or it will return NULL if no MTLTexture could be found underlying the VkImage, VkImageView, or VkBufferView object, at the plane indicated in aspectMask.

    • sType

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

    • sType$Default

      public VkExportMetalTextureInfoEXT sType$Default()
      Sets the STRUCTURE_TYPE_EXPORT_METAL_TEXTURE_INFO_EXT value to the sType() field.

    • pNext

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

    • image

      public VkExportMetalTextureInfoEXT image(long value)
      Sets the specified value to the image() field.

    • imageView

      public VkExportMetalTextureInfoEXT imageView(long value)
      Sets the specified value to the imageView() field.

    • bufferView

      public VkExportMetalTextureInfoEXT bufferView(long value)
      Sets the specified value to the bufferView() field.

    • plane

      public VkExportMetalTextureInfoEXT plane(int value)
      Sets the specified value to the plane() field.

    • mtlTexture

      public VkExportMetalTextureInfoEXT mtlTexture(long value)
      Sets the specified value to the mtlTexture() field.

    • set

      public VkExportMetalTextureInfoEXT set(int sType, long pNext, long image, long imageView, long bufferView, int plane, long mtlTexture)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nimage

      public static long nimage(long struct)
      Unsafe version of image().

    • nimageView

      public static long nimageView(long struct)
      Unsafe version of imageView().

    • nbufferView

      public static long nbufferView(long struct)
      Unsafe version of bufferView().

    • nplane

      public static int nplane(long struct)
      Unsafe version of plane().

    • nmtlTexture

      public static long nmtlTexture(long struct)
      Unsafe version of mtlTexture().

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

    • nimage

      public static void nimage(long struct, long value)
      Unsafe version of image.

    • nimageView

      public static void nimageView(long struct, long value)
      Unsafe version of imageView.

    • nbufferView

      public static void nbufferView(long struct, long value)
      Unsafe version of bufferView.

    • nplane

      public static void nplane(long struct, int value)
      Unsafe version of plane.

    • nmtlTexture

      public static void nmtlTexture(long struct, long value)
      Unsafe version of mtlTexture.

    • validate

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