Class VkDeviceGroupDeviceCreateInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkDeviceGroupDeviceCreateInfoKHR
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
- Each element of
pPhysicalDevicesmust be unique - All elements of
pPhysicalDevicesmust be in the same device group as enumerated byEnumeratePhysicalDeviceGroups - If
physicalDeviceCountis not 0, thephysicalDeviceparameter ofCreateDevicemust be an element ofpPhysicalDevices
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DEVICE_GROUP_DEVICE_CREATE_INFO- If
physicalDeviceCountis not 0,pPhysicalDevicesmust be a valid pointer to an array ofphysicalDeviceCountvalidVkPhysicalDevicehandles
Layout
struct VkDeviceGroupDeviceCreateInfo {
VkStructureType sType();
void const * pNext();
uint32_t physicalDeviceCount();
VkPhysicalDevice const * pPhysicalDevices();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkDeviceGroupDeviceCreateInfo(ByteBuffer container) Creates aVkDeviceGroupDeviceCreateInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkDeviceGroupDeviceCreateInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkDeviceGroupDeviceCreateInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceGroupDeviceCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceGroupDeviceCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkDeviceGroupDeviceCreateInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkDeviceGroupDeviceCreateInfo.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkDeviceGroupDeviceCreateInfoinstance for the specified memory address.create(long address, int capacity) Create aVkDeviceGroupDeviceCreateInfo.Bufferinstance at the specified memory.static @Nullable VkDeviceGroupDeviceCreateInfocreateSafe(long address) static @Nullable VkDeviceGroupDeviceCreateInfo.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkDeviceGroupDeviceCreateInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkDeviceGroupDeviceCreateInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceGroupDeviceCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceGroupDeviceCreateInfoinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnphysicalDeviceCount(long struct) Unsafe version ofphysicalDeviceCount().static voidnphysicalDeviceCount(long struct, int value) Sets the specified value to thephysicalDeviceCountfield of the specifiedstruct.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable org.lwjgl.PointerBuffernpPhysicalDevices(long struct) Unsafe version ofpPhysicalDevices.static voidnpPhysicalDevices(long struct, @Nullable org.lwjgl.PointerBuffer value) Unsafe version ofpPhysicalDevices.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.intthe number of elements in thepPhysicalDevicesarray.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.@Nullable org.lwjgl.PointerBuffera pointer to an array of physical device handles belonging to the same device group.pPhysicalDevices(@Nullable org.lwjgl.PointerBuffer value) Sets the address of the specifiedPointerBufferto thepPhysicalDevices()field.set(int sType, long pNext, @Nullable org.lwjgl.PointerBuffer pPhysicalDevices) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_DEVICE_GROUP_DEVICE_CREATE_INFOvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
PHYSICALDEVICECOUNT
public static final int PHYSICALDEVICECOUNTThe struct member offsets. -
PPHYSICALDEVICES
public static final int PPHYSICALDEVICESThe struct member offsets.
-
-
Constructor Details
-
VkDeviceGroupDeviceCreateInfo
Creates aVkDeviceGroupDeviceCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkDeviceGroupDeviceCreateInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
physicalDeviceCount
public int physicalDeviceCount()the number of elements in thepPhysicalDevicesarray. -
pPhysicalDevices
public @Nullable org.lwjgl.PointerBuffer pPhysicalDevices()a pointer to an array of physical device handles belonging to the same device group. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_DEVICE_GROUP_DEVICE_CREATE_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pPhysicalDevices
Sets the address of the specifiedPointerBufferto thepPhysicalDevices()field. -
set
public VkDeviceGroupDeviceCreateInfo set(int sType, long pNext, @Nullable org.lwjgl.PointerBuffer pPhysicalDevices) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkDeviceGroupDeviceCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkDeviceGroupDeviceCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkDeviceGroupDeviceCreateInfoinstance allocated withBufferUtils. -
create
Returns a newVkDeviceGroupDeviceCreateInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkDeviceGroupDeviceCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkDeviceGroupDeviceCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkDeviceGroupDeviceCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkDeviceGroupDeviceCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkDeviceGroupDeviceCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkDeviceGroupDeviceCreateInfo callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkDeviceGroupDeviceCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkDeviceGroupDeviceCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkDeviceGroupDeviceCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkDeviceGroupDeviceCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDeviceGroupDeviceCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceGroupDeviceCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkDeviceGroupDeviceCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDeviceGroupDeviceCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nphysicalDeviceCount
public static int nphysicalDeviceCount(long struct) Unsafe version ofphysicalDeviceCount(). -
npPhysicalDevices
public static @Nullable org.lwjgl.PointerBuffer npPhysicalDevices(long struct) Unsafe version ofpPhysicalDevices. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nphysicalDeviceCount
public static void nphysicalDeviceCount(long struct, int value) Sets the specified value to thephysicalDeviceCountfield of the specifiedstruct. -
npPhysicalDevices
public static void npPhysicalDevices(long struct, @Nullable org.lwjgl.PointerBuffer value) Unsafe version ofpPhysicalDevices. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-