Package org.lwjgl.vulkan

Class VkExportMetalIOSurfaceInfoEXT

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

Layout


 struct VkExportMetalIOSurfaceInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkImage image();
     IOSurfaceRef ioSurface();
 }

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

    • IOSURFACE

      public static final int IOSURFACE
      The struct member offsets.

  • Constructor Details

    • VkExportMetalIOSurfaceInfoEXT

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

    • 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()
      a VkImage.

    • ioSurface

      public long ioSurface()
      the Metal IOSurfaceRef object underlying the VkImage object in image. The implementation will return the IOSurfaceRef in this member, or it will return NULL if no IOSurfaceRef could be found underlying the VkImage object.

    • sType

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

    • sType$Default

      public VkExportMetalIOSurfaceInfoEXT sType$Default()
      Sets the STRUCTURE_TYPE_EXPORT_METAL_IO_SURFACE_INFO_EXT value to the sType() field.

    • pNext

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

    • image

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

    • ioSurface

      public VkExportMetalIOSurfaceInfoEXT ioSurface(long value)
      Sets the specified value to the ioSurface() field.

    • set

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

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nioSurface

      public static long nioSurface(long struct)
      Unsafe version of ioSurface().

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

    • nioSurface

      public static void nioSurface(long struct, long value)
      Unsafe version of ioSurface.

    • validate

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