Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceGroupProperties

extends Struct<VkPhysicalDeviceGroupProperties>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceGroupPropertiesKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying physical device group properties.
Valid Usage (Implicit)
See Also

EnumeratePhysicalDeviceGroups, EnumeratePhysicalDeviceGroupsKHR

Layout


struct VkPhysicalDeviceGroupProperties {
    VkStructureType sType;
    void * pNext;
    uint32_t physicalDeviceCount;
    VkPhysicalDevice physicalDevices[VK_MAX_DEVICE_GROUP_SIZE];
    VkBool32 subsetAllocation;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PHYSICALDEVICECOUNT

The struct member offsets.

public static final int
PHYSICALDEVICES

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
SUBSETALLOCATION

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkPhysicalDeviceGroupProperties(ByteBuffer container)

Creates a VkPhysicalDeviceGroupProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceGroupProperties
calloc()

Returns a new VkPhysicalDeviceGroupProperties instance allocated with memCalloc.

public static VkPhysicalDeviceGroupProperties.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated with memCalloc.

public static VkPhysicalDeviceGroupProperties
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPhysicalDeviceGroupProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkPhysicalDeviceGroupProperties.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkPhysicalDeviceGroupProperties
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceGroupProperties
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceGroupProperties.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceGroupProperties.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkPhysicalDeviceGroupProperties
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkPhysicalDeviceGroupProperties
create()

Returns a new VkPhysicalDeviceGroupProperties instance allocated with BufferUtils.

public static VkPhysicalDeviceGroupProperties
create(long address)

Returns a new VkPhysicalDeviceGroupProperties instance for the specified memory address.

public static VkPhysicalDeviceGroupProperties.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated with BufferUtils.

public static VkPhysicalDeviceGroupProperties.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkPhysicalDeviceGroupProperties.Buffer instance at the specified memory.

public static VkPhysicalDeviceGroupProperties
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkPhysicalDeviceGroupProperties.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkPhysicalDeviceGroupProperties
malloc()

Returns a new VkPhysicalDeviceGroupProperties instance allocated with memAlloc.

public static VkPhysicalDeviceGroupProperties.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated with memAlloc.

public static VkPhysicalDeviceGroupProperties
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPhysicalDeviceGroupProperties instance allocated on the specified MemoryStack.

public static VkPhysicalDeviceGroupProperties.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated on the specified MemoryStack.

public static VkPhysicalDeviceGroupProperties
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceGroupProperties
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceGroupProperties.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceGroupProperties.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nphysicalDeviceCount(long struct)

Unsafe version of physicalDeviceCount.

public static PointerBuffer
nphysicalDevices(long struct)

Unsafe version of physicalDevices.

public static long
nphysicalDevices(long struct, int index)

Unsafe version of physicalDevices.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nsubsetAllocation(long struct)

Unsafe version of subsetAllocation.

public int
physicalDeviceCount()

the number of physical devices in the group.

public PointerBuffer
physicalDevices()

an array of MAX_DEVICE_GROUP_SIZE VkPhysicalDevice handles representing all physical devices in the group.

public long
physicalDevices(int index)

an array of MAX_DEVICE_GROUP_SIZE VkPhysicalDevice handles representing all physical devices in the group.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPhysicalDeviceGroupProperties
pNext(long value)

Sets the specified value to the pNext field.

public VkPhysicalDeviceGroupProperties
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkPhysicalDeviceGroupProperties

Returns:

this struct
set
(VkPhysicalDeviceGroupProperties
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkPhysicalDeviceGroupProperties
sType(int value)

Sets the specified value to the sType field.

public VkPhysicalDeviceGroupProperties
public boolean
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.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PHYSICALDEVICECOUNTback to summary
public static final int PHYSICALDEVICECOUNT

The struct member offsets.

PHYSICALDEVICESback to summary
public static final int PHYSICALDEVICES

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

SUBSETALLOCATIONback to summary
public static final int SUBSETALLOCATION

The struct member offsets.

Constructor Detail

VkPhysicalDeviceGroupPropertiesback to summary
protected VkPhysicalDeviceGroupProperties(long address, ByteBuffer container)
VkPhysicalDeviceGroupPropertiesback to summary
public VkPhysicalDeviceGroupProperties(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

callocback to summary
public static VkPhysicalDeviceGroupProperties calloc()

Returns a new VkPhysicalDeviceGroupProperties instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkPhysicalDeviceGroupProperties.Buffer calloc(int capacity)

Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceGroupProperties calloc(MemoryStack stack)

Returns a new VkPhysicalDeviceGroupProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkPhysicalDeviceGroupProperties.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkPhysicalDeviceGroupProperties callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkPhysicalDeviceGroupProperties callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkPhysicalDeviceGroupProperties.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkPhysicalDeviceGroupProperties.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkPhysicalDeviceGroupProperties create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkPhysicalDeviceGroupProperties create()

Returns a new VkPhysicalDeviceGroupProperties instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceGroupProperties create(long address)

Returns a new VkPhysicalDeviceGroupProperties instance for the specified memory address.

createback to summary
public static VkPhysicalDeviceGroupProperties.Buffer create(int capacity)

Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkPhysicalDeviceGroupProperties.Buffer create(long address, int capacity)

Create a VkPhysicalDeviceGroupProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceGroupProperties createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkPhysicalDeviceGroupProperties.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkPhysicalDeviceGroupProperties malloc()

Returns a new VkPhysicalDeviceGroupProperties instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkPhysicalDeviceGroupProperties.Buffer malloc(int capacity)

Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceGroupProperties malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceGroupProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkPhysicalDeviceGroupProperties.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkPhysicalDeviceGroupProperties mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkPhysicalDeviceGroupProperties mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkPhysicalDeviceGroupProperties.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkPhysicalDeviceGroupProperties.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nphysicalDeviceCountback to summary
public static int nphysicalDeviceCount(long struct)

Unsafe version of physicalDeviceCount.

nphysicalDevicesback to summary
public static PointerBuffer nphysicalDevices(long struct)

Unsafe version of physicalDevices.

nphysicalDevicesback to summary
public static long nphysicalDevices(long struct, int index)

Unsafe version of physicalDevices.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

nsubsetAllocationback to summary
public static int nsubsetAllocation(long struct)

Unsafe version of subsetAllocation.

physicalDeviceCountback to summary
public int physicalDeviceCount()

the number of physical devices in the group.

Annotations
@NativeType:uint32_t
physicalDevicesback to summary
public PointerBuffer physicalDevices()

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.

Annotations
@NativeType:VkPhysicalDevice[VK_MAX_DEVICE_GROUP_SIZE]
physicalDevicesback to summary
public long physicalDevices(int index)

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.

Annotations
@NativeType:VkPhysicalDevice
pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkPhysicalDeviceGroupProperties pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkPhysicalDeviceGroupProperties set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceGroupProperties set(VkPhysicalDeviceGroupProperties src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceGroupProperties

the source struct

Returns:VkPhysicalDeviceGroupProperties

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPhysicalDeviceGroupProperties sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkPhysicalDeviceGroupProperties sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_GROUP_PROPERTIES value to the sType field.

subsetAllocationback to summary
public boolean 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.

Annotations
@NativeType:VkBool32
org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceGroupProperties.Buffer

extends StructBuffer<VkPhysicalDeviceGroupProperties, VkPhysicalDeviceGroupProperties.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceGroupPropertiesKHR.Buffer

An array of VkPhysicalDeviceGroupProperties structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceGroupProperties

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceGroupProperties.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkPhysicalDeviceGroupProperties
public int
public PointerBuffer
public long

Returns:

the value at the specified index of the VkPhysicalDeviceGroupProperties#physicalDevices field.
physicalDevices
(int index)

public long

Returns:

the value of the VkPhysicalDeviceGroupProperties#pNext field.
pNext
()

public VkPhysicalDeviceGroupProperties.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceGroupProperties#pNext field.

protected VkPhysicalDeviceGroupProperties.Buffer
public int

Returns:

the value of the VkPhysicalDeviceGroupProperties#sType field.
sType
()

public VkPhysicalDeviceGroupProperties.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceGroupProperties#sType field.

public VkPhysicalDeviceGroupProperties.Buffer
public boolean
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceGroupProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceGroupProperties.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkPhysicalDeviceGroupProperties#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkPhysicalDeviceGroupProperties getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
physicalDeviceCountback to summary
public int physicalDeviceCount()
Returns:int

the value of the VkPhysicalDeviceGroupProperties#physicalDeviceCount field.

Annotations
@NativeType:uint32_t
physicalDevicesback to summary
public PointerBuffer physicalDevices()
Returns:PointerBuffer

a PointerBuffer view of the VkPhysicalDeviceGroupProperties#physicalDevices field.

Annotations
@NativeType:VkPhysicalDevice[VK_MAX_DEVICE_GROUP_SIZE]
physicalDevicesback to summary
public long physicalDevices(int index)
Returns:long

the value at the specified index of the VkPhysicalDeviceGroupProperties#physicalDevices field.

Annotations
@NativeType:VkPhysicalDevice
pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceGroupProperties#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkPhysicalDeviceGroupProperties.Buffer pNext(long value)

Sets the specified value to the VkPhysicalDeviceGroupProperties#pNext field.

selfback to summary
protected VkPhysicalDeviceGroupProperties.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkPhysicalDeviceGroupProperties#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPhysicalDeviceGroupProperties.Buffer sType(int value)

Sets the specified value to the VkPhysicalDeviceGroupProperties#sType field.

sType$Defaultback to summary
public VkPhysicalDeviceGroupProperties.Buffer sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_GROUP_PROPERTIES value to the VkPhysicalDeviceGroupProperties#sType field.

subsetAllocationback to summary
public boolean subsetAllocation()
Returns:boolean

the value of the VkPhysicalDeviceGroupProperties#subsetAllocation field.

Annotations
@NativeType:VkBool32