Package org.lwjgl.vulkan

Class VkBindMemoryStatus

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkBindMemoryStatus>
org.lwjgl.vulkan.VkBindMemoryStatus
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkBindMemoryStatusKHR
public class VkBindMemoryStatus extends org.lwjgl.system.Struct<VkBindMemoryStatus> implements org.lwjgl.system.NativeResource
Structure specifying where to return memory binding status.
Description

If the pNext chain of VkBindBufferMemoryInfo or VkBindImageMemoryInfo includes a VkBindMemoryStatus structure, then the VkBindMemoryStatus::pResult will be populated with a value describing the result of the corresponding memory binding operation.

Valid Usage (Implicit)

Layout


 struct VkBindMemoryStatus {
     VkStructureType sType();
     void const * pNext();
     VkResult * pResult(int);
 }

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

    • PRESULT

      public static final int PRESULT
      The struct member offsets.

  • Constructor Details

    • VkBindMemoryStatus

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

    • sType

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

    • pNext

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

    • pResult

      public IntBuffer pResult(int capacity)
      Parameters:
      capacity - the number of elements in the returned buffer
      Returns:
      a pointer to a VkResult value.

    • sType

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

    • sType$Default

      public VkBindMemoryStatus sType$Default()
      Sets the STRUCTURE_TYPE_BIND_MEMORY_STATUS value to the sType() field.

    • pNext

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

    • pResult

      public VkBindMemoryStatus pResult(IntBuffer value)
      Sets the address of the specified IntBuffer to the pResult(int) field.

    • set

      public VkBindMemoryStatus set(int sType, long pNext, IntBuffer pResult)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • npResult

      public static IntBuffer npResult(long struct, int capacity)
      Unsafe version of pResult.

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

    • npResult

      public static void npResult(long struct, IntBuffer value)
      Unsafe version of pResult.

    • validate

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