Package org.lwjgl.vulkan

Class VkPhysicalDeviceToolProperties

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPhysicalDeviceToolProperties>
org.lwjgl.vulkan.VkPhysicalDeviceToolProperties
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkPhysicalDeviceToolPropertiesEXT
public class VkPhysicalDeviceToolProperties extends org.lwjgl.system.Struct<VkPhysicalDeviceToolProperties> implements org.lwjgl.system.NativeResource
Structure providing information about an active tool.
Valid Usage (Implicit)
See Also

GetPhysicalDeviceToolProperties, GetPhysicalDeviceToolPropertiesEXT

Layout


 struct VkPhysicalDeviceToolProperties {
     VkStructureType sType();
     void * pNext();
     char name()[VK_MAX_EXTENSION_NAME_SIZE];
     char version()[VK_MAX_EXTENSION_NAME_SIZE];
     VkToolPurposeFlags purposes();
     char description()[VK_MAX_DESCRIPTION_SIZE];
     char layer()[VK_MAX_EXTENSION_NAME_SIZE];
 }

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

    • NAME

      public static final int NAME
      The struct member offsets.

    • VERSION

      public static final int VERSION
      The struct member offsets.

    • PURPOSES

      public static final int PURPOSES
      The struct member offsets.

    • DESCRIPTION

      public static final int DESCRIPTION
      The struct member offsets.

    • LAYER

      public static final int LAYER
      The struct member offsets.

  • Constructor Details

    • VkPhysicalDeviceToolProperties

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

    • sType

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

    • pNext

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

    • name

      public ByteBuffer name()
      a null-terminated UTF-8 string containing the name of the tool.

    • nameString

      public String nameString()
      a null-terminated UTF-8 string containing the name of the tool.

    • version

      public ByteBuffer version()
      a null-terminated UTF-8 string containing the version of the tool.

    • versionString

      public String versionString()
      a null-terminated UTF-8 string containing the version of the tool.

    • purposes

      public int purposes()
      a bitmask of VkToolPurposeFlagBits which is populated with purposes supported by the tool.

    • description

      public ByteBuffer description()
      a null-terminated UTF-8 string containing a description of the tool.

    • descriptionString

      public String descriptionString()
      a null-terminated UTF-8 string containing a description of the tool.

    • layer

      public ByteBuffer layer()
      a null-terminated UTF-8 string containing the name of the layer implementing the tool, if the tool is implemented in a layer - otherwise it may be an empty string.

    • layerString

      public String layerString()
      a null-terminated UTF-8 string containing the name of the layer implementing the tool, if the tool is implemented in a layer - otherwise it may be an empty string.

    • sType

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

    • sType$Default

      public VkPhysicalDeviceToolProperties sType$Default()
      Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_TOOL_PROPERTIES value to the sType() field.

    • pNext

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

    • set

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

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nname

      public static ByteBuffer nname(long struct)
      Unsafe version of name().

    • nnameString

      public static String nnameString(long struct)
      Unsafe version of nameString().

    • nversion

      public static ByteBuffer nversion(long struct)
      Unsafe version of version().

    • nversionString

      public static String nversionString(long struct)
      Unsafe version of versionString().

    • npurposes

      public static int npurposes(long struct)
      Unsafe version of purposes().

    • ndescription

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

    • ndescriptionString

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

    • nlayer

      public static ByteBuffer nlayer(long struct)
      Unsafe version of layer().

    • nlayerString

      public static String nlayerString(long struct)
      Unsafe version of layerString().

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