VkPhysicalDeviceGroupProperties (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPhysicalDeviceGroupPropertiesKHR
```
public class VkPhysicalDeviceGroupProperties
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying physical device group properties.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_GROUP_PROPERTIES
- pNext must be NULL
See Also

EnumeratePhysicalDeviceGroups, EnumeratePhysicalDeviceGroupsKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- physicalDeviceCount – the number of physical devices in the group.
- physicalDevices[VK_MAX_DEVICE_GROUP_SIZE] – an array of MAX_DEVICE_GROUP_SIZE VkPhysicalDevice handles representing all physical devices in the group. The first physicalDeviceCount elements of the array will be valid.
- subsetAllocation – specifies whether logical devices created from the group support allocating device memory on a subset of devices, via the deviceMask member of the VkMemoryAllocateFlagsInfo. If this is FALSE, then all device memory allocations are made across all physical devices in the group. If physicalDeviceCount is 1, then subsetAllocation must be FALSE.
Layout
```
 struct VkPhysicalDeviceGroupProperties {
     VkStructureType sType;
     void * pNext;
     uint32_t physicalDeviceCount;
     VkPhysicalDevice physicalDevices[VK_MAX_DEVICE_GROUP_SIZE];
     VkBool32 subsetAllocation;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkPhysicalDeviceGroupProperties.Buffer
An array of VkPhysicalDeviceGroupProperties 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`	`VkPhysicalDeviceGroupProperties.Buffer` An array of `VkPhysicalDeviceGroupProperties` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PHYSICALDEVICECOUNT` The struct member offsets.
`static int`	`PHYSICALDEVICES` 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.
`static int`	`SUBSETALLOCATION` 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
`VkPhysicalDeviceGroupProperties(java.nio.ByteBuffer container)` Creates a `VkPhysicalDeviceGroupProperties` 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 VkPhysicalDeviceGroupProperties`	`calloc()` Returns a new `VkPhysicalDeviceGroupProperties` instance allocated with `memCalloc`.
`static VkPhysicalDeviceGroupProperties.Buffer`	`calloc(int capacity)` Returns a new `VkPhysicalDeviceGroupProperties.Buffer` instance allocated with `memCalloc`.
`static VkPhysicalDeviceGroupProperties`	`callocStack()` Returns a new `VkPhysicalDeviceGroupProperties` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceGroupProperties.Buffer`	`callocStack(int capacity)` Returns a new `VkPhysicalDeviceGroupProperties.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceGroupProperties.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceGroupProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceGroupProperties`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceGroupProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPhysicalDeviceGroupProperties`	`create()` Returns a new `VkPhysicalDeviceGroupProperties` instance allocated with `BufferUtils`.
`static VkPhysicalDeviceGroupProperties.Buffer`	`create(int capacity)` Returns a new `VkPhysicalDeviceGroupProperties.Buffer` instance allocated with `BufferUtils`.
`static VkPhysicalDeviceGroupProperties`	`create(long address)` Returns a new `VkPhysicalDeviceGroupProperties` instance for the specified memory address.
`static VkPhysicalDeviceGroupProperties.Buffer`	`create(long address, int capacity)` Create a `VkPhysicalDeviceGroupProperties.Buffer` instance at the specified memory.
`static VkPhysicalDeviceGroupProperties`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPhysicalDeviceGroupProperties.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPhysicalDeviceGroupProperties`	`malloc()` Returns a new `VkPhysicalDeviceGroupProperties` instance allocated with `memAlloc`.
`static VkPhysicalDeviceGroupProperties.Buffer`	`malloc(int capacity)` Returns a new `VkPhysicalDeviceGroupProperties.Buffer` instance allocated with `memAlloc`.
`static VkPhysicalDeviceGroupProperties`	`mallocStack()` Returns a new `VkPhysicalDeviceGroupProperties` instance allocated on the thread-local `MemoryStack`.
`static VkPhysicalDeviceGroupProperties.Buffer`	`mallocStack(int capacity)` Returns a new `VkPhysicalDeviceGroupProperties.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPhysicalDeviceGroupProperties.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceGroupProperties.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPhysicalDeviceGroupProperties`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPhysicalDeviceGroupProperties` instance allocated on the specified `MemoryStack`.
`static int`	`nphysicalDeviceCount(long struct)` Unsafe version of `physicalDeviceCount()`.
`static org.lwjgl.PointerBuffer`	`nphysicalDevices(long struct)` Unsafe version of `physicalDevices()`.
`static long`	`nphysicalDevices(long struct, int index)` Unsafe version of `physicalDevices`.
`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`.
`static int`	`nsubsetAllocation(long struct)` Unsafe version of `subsetAllocation()`.
`int`	`physicalDeviceCount()` Returns the value of the `physicalDeviceCount` field.
`org.lwjgl.PointerBuffer`	`physicalDevices()` Returns a `PointerBuffer` view of the `physicalDevices` field.
`long`	`physicalDevices(int index)` Returns the value at the specified index of the `physicalDevices` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPhysicalDeviceGroupProperties`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkPhysicalDeviceGroupProperties`	`set(int sType, long pNext)` Initializes this struct with the specified values.
`VkPhysicalDeviceGroupProperties`	`set(VkPhysicalDeviceGroupProperties src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkPhysicalDeviceGroupProperties`	`sType(int value)` Sets the specified value to the `sType` field.
`boolean`	`subsetAllocation()` Returns the value of the `subsetAllocation` 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.
  - PHYSICALDEVICECOUNT
```
public static final int PHYSICALDEVICECOUNT
```
    The struct member offsets.
  - PHYSICALDEVICES
```
public static final int PHYSICALDEVICES
```
    The struct member offsets.
  - SUBSETALLOCATION
```
public static final int SUBSETALLOCATION
```
    The struct member offsets.
- Constructor Detail
  - VkPhysicalDeviceGroupProperties
```
public VkPhysicalDeviceGroupProperties(java.nio.ByteBuffer container)
```
    Creates a VkPhysicalDeviceGroupProperties 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.
  - physicalDeviceCount
```
public int physicalDeviceCount()
```
    Returns the value of the physicalDeviceCount field.
  - physicalDevices
```
public org.lwjgl.PointerBuffer physicalDevices()
```
    Returns a PointerBuffer view of the physicalDevices field.
  - physicalDevices
```
public long physicalDevices(int index)
```
    Returns the value at the specified index of the physicalDevices field.
  - subsetAllocation
```
public boolean subsetAllocation()
```
    Returns the value of the subsetAllocation field.
  - sType
```
public VkPhysicalDeviceGroupProperties sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPhysicalDeviceGroupProperties pNext(long value)
```
    Sets the specified value to the pNext field.
  - set
```
public VkPhysicalDeviceGroupProperties set(int sType,
                                           long pNext)
```
    Initializes this struct with the specified values.
  - set
```
public VkPhysicalDeviceGroupProperties set(VkPhysicalDeviceGroupProperties src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPhysicalDeviceGroupProperties malloc()
```
    Returns a new VkPhysicalDeviceGroupProperties instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPhysicalDeviceGroupProperties calloc()
```
    Returns a new VkPhysicalDeviceGroupProperties instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPhysicalDeviceGroupProperties create()
```
    Returns a new VkPhysicalDeviceGroupProperties instance allocated with BufferUtils.
  - create
```
public static VkPhysicalDeviceGroupProperties create(long address)
```
    Returns a new VkPhysicalDeviceGroupProperties instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkPhysicalDeviceGroupProperties createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkPhysicalDeviceGroupProperties.Buffer malloc(int capacity)
```
    Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPhysicalDeviceGroupProperties.Buffer calloc(int capacity)
```
    Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPhysicalDeviceGroupProperties.Buffer create(int capacity)
```
    Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPhysicalDeviceGroupProperties.Buffer create(long address,
                                                            int capacity)
```
    Create a VkPhysicalDeviceGroupProperties.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkPhysicalDeviceGroupProperties.Buffer createSafe(long address,
                                                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkPhysicalDeviceGroupProperties mallocStack()
```
    Returns a new VkPhysicalDeviceGroupProperties instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPhysicalDeviceGroupProperties callocStack()
```
    Returns a new VkPhysicalDeviceGroupProperties instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPhysicalDeviceGroupProperties mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceGroupProperties instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPhysicalDeviceGroupProperties callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceGroupProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPhysicalDeviceGroupProperties.Buffer mallocStack(int capacity)
```
    Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPhysicalDeviceGroupProperties.Buffer callocStack(int capacity)
```
    Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPhysicalDeviceGroupProperties.Buffer mallocStack(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPhysicalDeviceGroupProperties.Buffer callocStack(int capacity,
                                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkPhysicalDeviceGroupProperties.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().
  - nphysicalDeviceCount
```
public static int nphysicalDeviceCount(long struct)
```
    Unsafe version of physicalDeviceCount().
  - nphysicalDevices
```
public static org.lwjgl.PointerBuffer nphysicalDevices(long struct)
```
    Unsafe version of physicalDevices().
  - nphysicalDevices
```
public static long nphysicalDevices(long struct,
                                    int index)
```
    Unsafe version of physicalDevices.
  - nsubsetAllocation
```
public static int nsubsetAllocation(long struct)
```
    Unsafe version of subsetAllocation().
  - 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 VkPhysicalDeviceGroupProperties

Valid Usage (Implicit)

See Also

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

PHYSICALDEVICECOUNT

PHYSICALDEVICES

SUBSETALLOCATION

Constructor Detail

VkPhysicalDeviceGroupProperties

Method Detail

sizeof

sType

pNext

physicalDeviceCount

physicalDevices

physicalDevices

subsetAllocation

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nphysicalDeviceCount

nphysicalDevices

nphysicalDevices

nsubsetAllocation

nsType

npNext