Package org.lwjgl.vulkan

Class VkExternalFormatANDROID

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkExternalFormatANDROID>
org.lwjgl.vulkan.VkExternalFormatANDROID
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkExternalFormatANDROID extends org.lwjgl.system.Struct<VkExternalFormatANDROID> implements org.lwjgl.system.NativeResource
Structure containing an Android hardware buffer external format.
Description

When included in the pNext chain of another structure, it indicates additional format information beyond what is provided by VkFormat values for an Android hardware buffer. If externalFormat is zero, it indicates that no external format is used, and implementations should rely only on other format information. If this structure is not present, it is equivalent to setting externalFormat to zero.

Valid Usage
Valid Usage (Implicit)

Layout


 struct VkExternalFormatANDROID {
     VkStructureType sType();
     void * pNext();
     uint64_t externalFormat();
 }

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

    • EXTERNALFORMAT

      public static final int EXTERNALFORMAT
      The struct member offsets.

  • Constructor Details

    • VkExternalFormatANDROID

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

    • sType

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

    • pNext

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

    • externalFormat

      public long externalFormat()
      an implementation-defined identifier for the external format

    • sType

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

    • sType$Default

      public VkExternalFormatANDROID sType$Default()
      Sets the STRUCTURE_TYPE_EXTERNAL_FORMAT_ANDROID value to the sType() field.

    • pNext

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

    • externalFormat

      public VkExternalFormatANDROID externalFormat(long value)
      Sets the specified value to the externalFormat() field.

    • set

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

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nexternalFormat

      public static long nexternalFormat(long struct)
      Unsafe version of externalFormat().

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

    • nexternalFormat

      public static void nexternalFormat(long struct, long value)
      Unsafe version of externalFormat.