VkPhysicalDeviceIDProperties (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkPhysicalDeviceIDProperties

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkPhysicalDeviceIDPropertiesKHR
```
public class VkPhysicalDeviceIDProperties
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying IDs related to the physical device.
Description

deviceUUID must be immutable for a given device across instances, processes, driver APIs, driver versions, and system reboots.

Applications can compare the driverUUID value across instance and process boundaries, and can make similar queries in external APIs to determine whether they are capable of sharing memory objects and resources using them with the device.

deviceUUID and/or driverUUID must be used to determine whether a particular external object can be shared between driver components, where such a restriction exists as defined in the compatibility table for the particular object type:
If deviceLUIDValid is FALSE, the values of deviceLUID and deviceNodeMask are undefined. If deviceLUIDValid is TRUE and Vulkan is running on the Windows operating system, the contents of deviceLUID can be cast to an LUID object and must be equal to the locally unique identifier of a IDXGIAdapter1 object that corresponds to physicalDevice. If deviceLUIDValid is TRUE, deviceNodeMask must contain exactly one bit. If Vulkan is running on an operating system that supports the Direct3D 12 API and physicalDevice corresponds to an individual device in a linked device adapter, deviceNodeMask identifies the Direct3D 12 node corresponding to physicalDevice. Otherwise, deviceNodeMask must be 1.

Note

Although they have identical descriptions, VkPhysicalDeviceIDProperties::deviceUUID may differ from VkPhysicalDeviceProperties2::pipelineCacheUUID. The former is intended to identify and correlate devices across API and driver boundaries, while the latter is used to identify a compatible device and driver combination to use when serializing and de-serializing pipeline state.

Note

While VkPhysicalDeviceIDProperties::deviceUUID is specified to remain consistent across driver versions and system reboots, it is not intended to be usable as a serializable persistent identifier for a device. It may change when a device is physically added to, removed from, or moved to a different connector in a system while that system is powered down. Further, there is no reasonable way to verify with conformance testing that a given device retains the same UUID in a given system across all driver versions supported in that system. While implementations should make every effort to report consistent device UUIDs across driver versions, applications should avoid relying on the persistence of this value for uses other than identifying compatible devices for external object sharing purposes.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_ID_PROPERTIES
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- deviceUUID[VK_UUID_SIZE] – an array of UUID_SIZE uint8_t values representing a universally unique identifier for the device.
- driverUUID[VK_UUID_SIZE] – an array of UUID_SIZE uint8_t values representing a universally unique identifier for the driver build in use by the device.
- deviceLUID[VK_LUID_SIZE] – an array of LUID_SIZE uint8_t values representing a locally unique identifier for the device.
- deviceNodeMask – a uint32_t bitfield identifying the node within a linked device adapter corresponding to the device.
- deviceLUIDValid – a boolean value that will be TRUE if deviceLUID contains a valid LUID and deviceNodeMask contains a valid node mask, and FALSE if they do not.
Layout
```
 struct VkPhysicalDeviceIDProperties {
     VkStructureType sType;
     void * pNext;
     uint8_t deviceUUID[VK_UUID_SIZE];
     uint8_t driverUUID[VK_UUID_SIZE];
     uint8_t deviceLUID[VK_LUID_SIZE];
     uint32_t deviceNodeMask;
     VkBool32 deviceLUIDValid;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkPhysicalDeviceIDProperties.Buffer
An array of VkPhysicalDeviceIDProperties structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkPhysicalDeviceIDProperties.Buffer` An array of `VkPhysicalDeviceIDProperties` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DEVICELUID` The struct member offsets.
`static int`	`DEVICELUIDVALID` The struct member offsets.
`static int`	`DEVICENODEMASK` The struct member offsets.
`static int`	`DEVICEUUID` The struct member offsets.
`static int`	`DRIVERUUID` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkPhysicalDeviceIDProperties(java.nio.ByteBuffer container)` Creates a `VkPhysicalDeviceIDProperties` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkPhysicalDeviceIDProperties`	`calloc()` Returns a new `VkPhysicalDeviceIDProperties` instance allocated with `memCalloc`.
`static VkPhysicalDeviceIDProperties.Buffer`	`calloc(int capacity)` Returns a new `VkPhysicalDeviceIDProperties.Buffer` instance allocated with `memCalloc`.
`static VkPhysicalDeviceIDProperties`	`callocStack()` Returns a new `VkPhysicalDeviceIDProperties` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceIDProperties.Buffer`	`callocStack(int capacity)` Returns a new `VkPhysicalDeviceIDProperties.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceIDProperties.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceIDProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceIDProperties`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceIDProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceIDProperties`	`create()` Returns a new `VkPhysicalDeviceIDProperties` instance allocated with `BufferUtils`.
`static VkPhysicalDeviceIDProperties.Buffer`	`create(int capacity)` Returns a new `VkPhysicalDeviceIDProperties.Buffer` instance allocated with `BufferUtils`.
`static VkPhysicalDeviceIDProperties`	`create(long address)` Returns a new `VkPhysicalDeviceIDProperties` instance for the specified memory address.
`static VkPhysicalDeviceIDProperties.Buffer`	`create(long address, int capacity)` Create a `VkPhysicalDeviceIDProperties.Buffer` instance at the specified memory.
`static VkPhysicalDeviceIDProperties`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPhysicalDeviceIDProperties.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`java.nio.ByteBuffer`	`deviceLUID()` Returns a `ByteBuffer` view of the `deviceLUID` field.
`byte`	`deviceLUID(int index)` Returns the value at the specified index of the `deviceLUID` field.
`boolean`	`deviceLUIDValid()` Returns the value of the `deviceLUIDValid` field.
`int`	`deviceNodeMask()` Returns the value of the `deviceNodeMask` field.
`java.nio.ByteBuffer`	`deviceUUID()` Returns a `ByteBuffer` view of the `deviceUUID` field.
`byte`	`deviceUUID(int index)` Returns the value at the specified index of the `deviceUUID` field.
`java.nio.ByteBuffer`	`driverUUID()` Returns a `ByteBuffer` view of the `driverUUID` field.
`byte`	`driverUUID(int index)` Returns the value at the specified index of the `driverUUID` field.
`static VkPhysicalDeviceIDProperties`	`malloc()` Returns a new `VkPhysicalDeviceIDProperties` instance allocated with `memAlloc`.
`static VkPhysicalDeviceIDProperties.Buffer`	`malloc(int capacity)` Returns a new `VkPhysicalDeviceIDProperties.Buffer` instance allocated with `memAlloc`.
`static VkPhysicalDeviceIDProperties`	`mallocStack()` Returns a new `VkPhysicalDeviceIDProperties` instance allocated on the thread-local `MemoryStack`.
`static VkPhysicalDeviceIDProperties.Buffer`	`mallocStack(int capacity)` Returns a new `VkPhysicalDeviceIDProperties.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPhysicalDeviceIDProperties.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceIDProperties.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPhysicalDeviceIDProperties`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceIDProperties` instance allocated on the specified `MemoryStack`.
`static java.nio.ByteBuffer`	`ndeviceLUID(long struct)` Unsafe version of `deviceLUID()`.
`static byte`	`ndeviceLUID(long struct, int index)` Unsafe version of `deviceLUID`.
`static int`	`ndeviceLUIDValid(long struct)` Unsafe version of `deviceLUIDValid()`.
`static int`	`ndeviceNodeMask(long struct)` Unsafe version of `deviceNodeMask()`.
`static java.nio.ByteBuffer`	`ndeviceUUID(long struct)` Unsafe version of `deviceUUID()`.
`static byte`	`ndeviceUUID(long struct, int index)` Unsafe version of `deviceUUID`.
`static java.nio.ByteBuffer`	`ndriverUUID(long struct)` Unsafe version of `driverUUID()`.
`static byte`	`ndriverUUID(long struct, int index)` Unsafe version of `driverUUID`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPhysicalDeviceIDProperties`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkPhysicalDeviceIDProperties`	`set(int sType, long pNext)` Initializes this struct with the specified values.
`VkPhysicalDeviceIDProperties`	`set(VkPhysicalDeviceIDProperties src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkPhysicalDeviceIDProperties`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - 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.
  - DEVICEUUID
```
public static final int DEVICEUUID
```
    The struct member offsets.
  - DRIVERUUID
```
public static final int DRIVERUUID
```
    The struct member offsets.
  - DEVICELUID
```
public static final int DEVICELUID
```
    The struct member offsets.
  - DEVICENODEMASK
```
public static final int DEVICENODEMASK
```
    The struct member offsets.
  - DEVICELUIDVALID
```
public static final int DEVICELUIDVALID
```
    The struct member offsets.
- Constructor Detail
  - VkPhysicalDeviceIDProperties
```
public VkPhysicalDeviceIDProperties(java.nio.ByteBuffer container)
```
    Creates a VkPhysicalDeviceIDProperties 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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - deviceUUID
```
public java.nio.ByteBuffer deviceUUID()
```
    Returns a ByteBuffer view of the deviceUUID field.
  - deviceUUID
```
public byte deviceUUID(int index)
```
    Returns the value at the specified index of the deviceUUID field.
  - driverUUID
```
public java.nio.ByteBuffer driverUUID()
```
    Returns a ByteBuffer view of the driverUUID field.
  - driverUUID
```
public byte driverUUID(int index)
```
    Returns the value at the specified index of the driverUUID field.
  - deviceLUID
```
public java.nio.ByteBuffer deviceLUID()
```
    Returns a ByteBuffer view of the deviceLUID field.
  - deviceLUID
```
public byte deviceLUID(int index)
```
    Returns the value at the specified index of the deviceLUID field.
  - deviceNodeMask
```
public int deviceNodeMask()
```
    Returns the value of the deviceNodeMask field.
  - deviceLUIDValid
```
public boolean deviceLUIDValid()
```
    Returns the value of the deviceLUIDValid field.
  - sType
```
public VkPhysicalDeviceIDProperties sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPhysicalDeviceIDProperties pNext(long value)
```
    Sets the specified value to the pNext field.
  - set
```
public VkPhysicalDeviceIDProperties set(int sType,
                                        long pNext)
```
    Initializes this struct with the specified values.
  - set
```
public VkPhysicalDeviceIDProperties set(VkPhysicalDeviceIDProperties src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPhysicalDeviceIDProperties malloc()
```
    Returns a new VkPhysicalDeviceIDProperties instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPhysicalDeviceIDProperties calloc()
```
    Returns a new VkPhysicalDeviceIDProperties instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPhysicalDeviceIDProperties create()
```
    Returns a new VkPhysicalDeviceIDProperties instance allocated with BufferUtils.
  - create
```
public static VkPhysicalDeviceIDProperties create(long address)
```
    Returns a new VkPhysicalDeviceIDProperties instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPhysicalDeviceIDProperties createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPhysicalDeviceIDProperties.Buffer malloc(int capacity)
```
    Returns a new VkPhysicalDeviceIDProperties.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPhysicalDeviceIDProperties.Buffer calloc(int capacity)
```
    Returns a new VkPhysicalDeviceIDProperties.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPhysicalDeviceIDProperties.Buffer create(int capacity)
```
    Returns a new VkPhysicalDeviceIDProperties.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPhysicalDeviceIDProperties.Buffer create(long address,
                                                         int capacity)
```
    Create a VkPhysicalDeviceIDProperties.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPhysicalDeviceIDProperties.Buffer createSafe(long address,
                                                                       int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPhysicalDeviceIDProperties mallocStack()
```
    Returns a new VkPhysicalDeviceIDProperties instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPhysicalDeviceIDProperties callocStack()
```
    Returns a new VkPhysicalDeviceIDProperties instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPhysicalDeviceIDProperties mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceIDProperties instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPhysicalDeviceIDProperties callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceIDProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPhysicalDeviceIDProperties.Buffer mallocStack(int capacity)
```
    Returns a new VkPhysicalDeviceIDProperties.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPhysicalDeviceIDProperties.Buffer callocStack(int capacity)
```
    Returns a new VkPhysicalDeviceIDProperties.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPhysicalDeviceIDProperties.Buffer mallocStack(int capacity,
                                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceIDProperties.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPhysicalDeviceIDProperties.Buffer callocStack(int capacity,
                                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceIDProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - ndeviceUUID
```
public static java.nio.ByteBuffer ndeviceUUID(long struct)
```
    Unsafe version of deviceUUID().
  - ndeviceUUID
```
public static byte ndeviceUUID(long struct,
                               int index)
```
    Unsafe version of deviceUUID.
  - ndriverUUID
```
public static java.nio.ByteBuffer ndriverUUID(long struct)
```
    Unsafe version of driverUUID().
  - ndriverUUID
```
public static byte ndriverUUID(long struct,
                               int index)
```
    Unsafe version of driverUUID.
  - ndeviceLUID
```
public static java.nio.ByteBuffer ndeviceLUID(long struct)
```
    Unsafe version of deviceLUID().
  - ndeviceLUID
```
public static byte ndeviceLUID(long struct,
                               int index)
```
    Unsafe version of deviceLUID.
  - ndeviceNodeMask
```
public static int ndeviceNodeMask(long struct)
```
    Unsafe version of deviceNodeMask().
  - ndeviceLUIDValid
```
public static int ndeviceLUIDValid(long struct)
```
    Unsafe version of deviceLUIDValid().
  - 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.

Class VkPhysicalDeviceIDProperties

Description

Note

Note

Valid Usage (Implicit)

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

DEVICEUUID

DRIVERUUID

DEVICELUID

DEVICENODEMASK

DEVICELUIDVALID

Constructor Detail

VkPhysicalDeviceIDProperties

Method Detail

sizeof

sType

pNext

deviceUUID

deviceUUID

driverUUID

driverUUID

deviceLUID

deviceLUID

deviceNodeMask

deviceLUIDValid

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

ndeviceUUID

ndeviceUUID

ndriverUUID

ndriverUUID

ndeviceLUID

ndeviceLUID

ndeviceNodeMask

ndeviceLUIDValid

nsType

npNext