Package org.lwjgl.vulkan

Class VkDeviceFaultInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDeviceFaultInfoEXT>
org.lwjgl.vulkan.VkDeviceFaultInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkDeviceFaultInfoEXT extends org.lwjgl.system.Struct<VkDeviceFaultInfoEXT> implements org.lwjgl.system.NativeResource
Structure specifying device fault information.
Description

An implementation should populate as many members of VkDeviceFaultInfoEXT as possible, given the information available at the time of the fault and the constraints of the implementation itself.

Due to hardware limitations, pAddressInfos describes ranges of GPU virtual address space, rather than precise addresses. The precise memory address accessed or the precise value of the instruction pointer must lie within the region described.

Note

Each element of pAddressInfos describes either:

  • A memory access which may have triggered a page fault and may have contributed to device loss
  • The value of an active instruction pointer at the time a fault occurred. This value may be indicative of the active pipeline or shader at the time of device loss

Comparison of the GPU virtual addresses described by pAddressInfos to GPU virtual address ranges reported by the VK_EXT_device_address_binding_report extension may allow applications to correlate between these addresses and Vulkan objects. Applications should be aware that these addresses may also correspond to resources internal to an implementation, which will not be reported via the VK_EXT_device_address_binding_report extension.

Valid Usage (Implicit)
See Also

VkDeviceFaultAddressInfoEXT, VkDeviceFaultVendorInfoEXT, GetDeviceFaultInfoEXT

Layout


 struct VkDeviceFaultInfoEXT {
     VkStructureType sType();
     void * pNext();
     char description()[VK_MAX_DESCRIPTION_SIZE];
     VkDeviceFaultAddressInfoEXT * pAddressInfos();
     VkDeviceFaultVendorInfoEXT * pVendorInfos();
     void * pVendorBinaryData();
 }

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

    • DESCRIPTION

      public static final int DESCRIPTION
      The struct member offsets.

    • PADDRESSINFOS

      public static final int PADDRESSINFOS
      The struct member offsets.

    • PVENDORINFOS

      public static final int PVENDORINFOS
      The struct member offsets.

    • PVENDORBINARYDATA

      public static final int PVENDORBINARYDATA
      The struct member offsets.

  • Constructor Details

    • VkDeviceFaultInfoEXT

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

    • sType

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

    • pNext

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

    • description

      public ByteBuffer description()
      an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description of the fault.

    • descriptionString

      public String descriptionString()
      an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which is a human readable description of the fault.

    • pAddressInfos

      public @Nullable VkDeviceFaultAddressInfoEXT pAddressInfos()
      NULL or a pointer to an array of VkDeviceFaultAddressInfoEXT structures describing either memory accesses which may have caused a page fault, or describing active instruction pointers at the time of the fault. If not NULL, each element of pAddressInfos describes the a bounded region of GPU virtual address space containing either the GPU virtual address accessed, or the value of an active instruction pointer.

    • pVendorInfos

      public @Nullable VkDeviceFaultVendorInfoEXT pVendorInfos()
      NULL or a pointer to an array of VkDeviceFaultVendorInfoEXT structures describing vendor-specific fault information.

    • pVendorBinaryData

      public long pVendorBinaryData()
      NULL or a pointer to vendorBinarySize number of bytes of data, which will be populated with a vendor-specific binary crash dump, as described in Vendor Binary Crash Dumps.

    • sType

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

    • sType$Default

      public VkDeviceFaultInfoEXT sType$Default()
      Sets the STRUCTURE_TYPE_DEVICE_FAULT_INFO_EXT value to the sType() field.

    • pNext

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

    • set

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

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • ndescription

      public static ByteBuffer ndescription(long struct)
      Unsafe version of description().

    • ndescriptionString

      public static String ndescriptionString(long struct)
      Unsafe version of descriptionString().

    • npAddressInfos

      public static @Nullable VkDeviceFaultAddressInfoEXT npAddressInfos(long struct)
      Unsafe version of pAddressInfos().

    • npVendorInfos

      public static @Nullable VkDeviceFaultVendorInfoEXT npVendorInfos(long struct)
      Unsafe version of pVendorInfos().

    • npVendorBinaryData

      public static long npVendorBinaryData(long struct)
      Unsafe version of pVendorBinaryData().

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