Package org.lwjgl.vulkan

Class VkDescriptorAddressInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDescriptorAddressInfoEXT>
org.lwjgl.vulkan.VkDescriptorAddressInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkDescriptorAddressInfoEXT extends org.lwjgl.system.Struct<VkDescriptorAddressInfoEXT> implements org.lwjgl.system.NativeResource
Structure specifying descriptor buffer address info.
Valid Usage
Valid Usage (Implicit)

If the nullDescriptor feature is enabled, address can be zero. Loads from a null descriptor return zero values and stores and atomics to a null descriptor are discarded.

See Also

VkDescriptorDataEXT

Layout


 struct VkDescriptorAddressInfoEXT {
     VkStructureType sType();
     void * pNext();
     VkDeviceAddress address;
     VkDeviceSize range();
     VkFormat format();
 }

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

    • ADDRESS

      public static final int ADDRESS
      The struct member offsets.

    • RANGE

      public static final int RANGE
      The struct member offsets.

    • FORMAT

      public static final int FORMAT
      The struct member offsets.

  • Constructor Details

    • VkDescriptorAddressInfoEXT

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

    • sType

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

    • pNext

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

    • address$

      public long address$()
      either 0 or a device address at an offset in a buffer, where the base address can be queried from GetBufferDeviceAddress.

    • range

      public long range()
      the size in bytes of the buffer or buffer view used by the descriptor.

    • format

      public int format()
      the format of the data elements in the buffer view and is ignored for buffers.

    • sType

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

    • sType$Default

      public VkDescriptorAddressInfoEXT sType$Default()
      Sets the STRUCTURE_TYPE_DESCRIPTOR_ADDRESS_INFO_EXT value to the sType() field.

    • pNext

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

    • address$

      public VkDescriptorAddressInfoEXT address$(long value)
      Sets the specified value to the address$() field.

    • range

      public VkDescriptorAddressInfoEXT range(long value)
      Sets the specified value to the range() field.

    • format

      public VkDescriptorAddressInfoEXT format(int value)
      Sets the specified value to the format() field.

    • set

      public VkDescriptorAddressInfoEXT set(int sType, long pNext, long address$, long range, int format)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • naddress$

      public static long naddress$(long struct)
      Unsafe version of address$().

    • nrange

      public static long nrange(long struct)
      Unsafe version of range().

    • nformat

      public static int nformat(long struct)
      Unsafe version of format().

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

    • naddress$

      public static void naddress$(long struct, long value)
      Unsafe version of address$.

    • nrange

      public static void nrange(long struct, long value)
      Unsafe version of range.

    • nformat

      public static void nformat(long struct, int value)
      Unsafe version of format.