Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDeviceGroupDeviceCreateInfo

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

Create a logical device from multiple physical devices.
Description

The elements of the pPhysicalDevices array are an ordered list of the physical devices that the logical device represents. These must be a subset of a single device group, and need not be in the same order as they were enumerated. The order of the physical devices in the pPhysicalDevices array determines the device index of each physical device, with element i being assigned a device index of i. Certain commands and structures refer to one or more physical devices by using device indices or device masks formed using device indices.

A logical device created without using VkDeviceGroupDeviceCreateInfo, or with physicalDeviceCount equal to zero, is equivalent to a physicalDeviceCount of one and pPhysicalDevices pointing to the physicalDevice parameter to CreateDevice. In particular, the device index of that physical device is zero.

Valid Usage
Valid Usage (Implicit)

Layout


struct VkDeviceGroupDeviceCreateInfo {
    VkStructureType sType;
    void const * pNext;
    uint32_t physicalDeviceCount;
    VkPhysicalDevice const * pPhysicalDevices;
}

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
PNEXT

The struct member offsets.

public static final int
PPHYSICALDEVICES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkDeviceGroupDeviceCreateInfo(long address, ByteBuffer container)

public
VkDeviceGroupDeviceCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDeviceGroupDeviceCreateInfo
calloc()

Returns a new VkDeviceGroupDeviceCreateInfo instance allocated with memCalloc.

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

Returns a new VkDeviceGroupDeviceCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDeviceGroupDeviceCreateInfo
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkDeviceGroupDeviceCreateInfo
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 VkDeviceGroupDeviceCreateInfo
create()

Returns a new VkDeviceGroupDeviceCreateInfo instance allocated with BufferUtils.

public static VkDeviceGroupDeviceCreateInfo
create(long address)

Returns a new VkDeviceGroupDeviceCreateInfo instance for the specified memory address.

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

Returns a new VkDeviceGroupDeviceCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkDeviceGroupDeviceCreateInfo.Buffer instance at the specified memory.

public static VkDeviceGroupDeviceCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkDeviceGroupDeviceCreateInfo
malloc()

Returns a new VkDeviceGroupDeviceCreateInfo instance allocated with memAlloc.

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

Returns a new VkDeviceGroupDeviceCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkDeviceGroupDeviceCreateInfo instance allocated on the specified MemoryStack.

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

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

public static VkDeviceGroupDeviceCreateInfo
mallocStack()

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static VkDeviceGroupDeviceCreateInfo.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 void
nphysicalDeviceCount(long struct, int value)

Sets the specified value to the physicalDeviceCount field of the specified struct.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static PointerBuffer
npPhysicalDevices(long struct)

Unsafe version of pPhysicalDevices.

public static void
npPhysicalDevices(long struct, PointerBuffer value)

Unsafe version of pPhysicalDevices.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public int
physicalDeviceCount()

the number of elements in the pPhysicalDevices array.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDeviceGroupDeviceCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public PointerBuffer
pPhysicalDevices()

a pointer to an array of physical device handles belonging to the same device group.

public VkDeviceGroupDeviceCreateInfo
pPhysicalDevices(PointerBuffer value)

Sets the address of the specified PointerBuffer to the pPhysicalDevices field.

public VkDeviceGroupDeviceCreateInfo
set(int sType, long pNext, PointerBuffer pPhysicalDevices)

Initializes this struct with the specified values.

public VkDeviceGroupDeviceCreateInfo

Returns:

this struct
set
(VkDeviceGroupDeviceCreateInfo
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 VkDeviceGroupDeviceCreateInfo
sType(int value)

Sets the specified value to the sType field.

public VkDeviceGroupDeviceCreateInfo
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PPHYSICALDEVICESback to summary
public static final int PPHYSICALDEVICES

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.

Constructor Detail

VkDeviceGroupDeviceCreateInfoback to summary
protected VkDeviceGroupDeviceCreateInfo(long address, ByteBuffer container)
VkDeviceGroupDeviceCreateInfoback to summary
public VkDeviceGroupDeviceCreateInfo(ByteBuffer container)

Creates a VkDeviceGroupDeviceCreateInfo 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 VkDeviceGroupDeviceCreateInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDeviceGroupDeviceCreateInfo calloc(MemoryStack stack)

Returns a new VkDeviceGroupDeviceCreateInfo 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 VkDeviceGroupDeviceCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkDeviceGroupDeviceCreateInfo.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 VkDeviceGroupDeviceCreateInfo callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDeviceGroupDeviceCreateInfo.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 VkDeviceGroupDeviceCreateInfo 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 VkDeviceGroupDeviceCreateInfo create()

Returns a new VkDeviceGroupDeviceCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkDeviceGroupDeviceCreateInfo create(long address)

Returns a new VkDeviceGroupDeviceCreateInfo instance for the specified memory address.

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

Returns a new VkDeviceGroupDeviceCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDeviceGroupDeviceCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDeviceGroupDeviceCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDeviceGroupDeviceCreateInfo malloc(MemoryStack stack)

Returns a new VkDeviceGroupDeviceCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkDeviceGroupDeviceCreateInfo.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 VkDeviceGroupDeviceCreateInfo mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkDeviceGroupDeviceCreateInfo.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.

nphysicalDeviceCountback to summary
public static void nphysicalDeviceCount(long struct, int value)

Sets the specified value to the physicalDeviceCount field of the specified struct.

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.

npPhysicalDevicesback to summary
public static PointerBuffer npPhysicalDevices(long struct)

Unsafe version of pPhysicalDevices.

Annotations
@Nullable
npPhysicalDevicesback to summary
public static void npPhysicalDevices(long struct, PointerBuffer value)

Unsafe version of pPhysicalDevices.

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.

physicalDeviceCountback to summary
public int physicalDeviceCount()

the number of elements in the pPhysicalDevices array.

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

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

pPhysicalDevicesback to summary
public PointerBuffer pPhysicalDevices()

a pointer to an array of physical device handles belonging to the same device group.

Annotations
@Nullable
@NativeType:VkPhysicalDevice const *
pPhysicalDevicesback to summary
public VkDeviceGroupDeviceCreateInfo pPhysicalDevices(PointerBuffer value)

Sets the address of the specified PointerBuffer to the pPhysicalDevices field.

setback to summary
public VkDeviceGroupDeviceCreateInfo set(int sType, long pNext, PointerBuffer pPhysicalDevices)

Initializes this struct with the specified values.

setback to summary
public VkDeviceGroupDeviceCreateInfo set(VkDeviceGroupDeviceCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkDeviceGroupDeviceCreateInfo

the source struct

Returns:VkDeviceGroupDeviceCreateInfo

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 VkDeviceGroupDeviceCreateInfo sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_GROUP_DEVICE_CREATE_INFO value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkDeviceGroupDeviceCreateInfo.Buffer

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

An array of VkDeviceGroupDeviceCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkDeviceGroupDeviceCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDeviceGroupDeviceCreateInfo.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 VkDeviceGroupDeviceCreateInfo
public int
public long

Returns:

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

public VkDeviceGroupDeviceCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkDeviceGroupDeviceCreateInfo#pNext field.

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the VkDeviceGroupDeviceCreateInfo#pPhysicalDevices field.
pPhysicalDevices
()

public VkDeviceGroupDeviceCreateInfo.Buffer
protected VkDeviceGroupDeviceCreateInfo.Buffer
public int

Returns:

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

public VkDeviceGroupDeviceCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkDeviceGroupDeviceCreateInfo#sType field.

public VkDeviceGroupDeviceCreateInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDeviceGroupDeviceCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDeviceGroupDeviceCreateInfo.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 VkDeviceGroupDeviceCreateInfo#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 VkDeviceGroupDeviceCreateInfo getElementFactory()

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

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

the value of the VkDeviceGroupDeviceCreateInfo#physicalDeviceCount field.

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

the value of the VkDeviceGroupDeviceCreateInfo#pNext field.

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

Sets the specified value to the VkDeviceGroupDeviceCreateInfo#pNext field.

pPhysicalDevicesback to summary
public PointerBuffer pPhysicalDevices()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the VkDeviceGroupDeviceCreateInfo#pPhysicalDevices field.

Annotations
@Nullable
@NativeType:VkPhysicalDevice const *
pPhysicalDevicesback to summary
public VkDeviceGroupDeviceCreateInfo.Buffer pPhysicalDevices(PointerBuffer value)

Sets the address of the specified PointerBuffer to the VkDeviceGroupDeviceCreateInfo#pPhysicalDevices field.

selfback to summary
protected VkDeviceGroupDeviceCreateInfo.Buffer self()

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

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

the value of the VkDeviceGroupDeviceCreateInfo#sType field.

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

Sets the specified value to the VkDeviceGroupDeviceCreateInfo#sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_GROUP_DEVICE_CREATE_INFO value to the VkDeviceGroupDeviceCreateInfo#sType field.