Package org.lwjgl.vulkan
Class VkPhysicalDeviceGroupProperties
- 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 beSTRUCTURE_TYPE_PHYSICAL_DEVICE_GROUP_PROPERTIES
pNext
must beNULL
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 physical device handles representing all physical devices in the group. The firstphysicalDeviceCount
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 thedeviceMask
member of theVkMemoryAllocateFlagsInfo
. If this isFALSE
, then all device memory allocations are made across all physical devices in the group. IfphysicalDeviceCount
is 1, thensubsetAllocation
must beFALSE
.
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 Description static class
VkPhysicalDeviceGroupProperties.Buffer
An array ofVkPhysicalDeviceGroupProperties
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
PHYSICALDEVICECOUNT
PHYSICALDEVICES
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
SUBSETALLOCATIONThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPhysicalDeviceGroupProperties(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceGroupProperties
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPhysicalDeviceGroupProperties
calloc()
Returns a newVkPhysicalDeviceGroupProperties
instance allocated withmemCalloc
.static VkPhysicalDeviceGroupProperties.Buffer
calloc(int capacity)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated withmemCalloc
.static VkPhysicalDeviceGroupProperties
callocStack()
Returns a newVkPhysicalDeviceGroupProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceGroupProperties.Buffer
callocStack(int capacity)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceGroupProperties.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceGroupProperties
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceGroupProperties
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceGroupProperties
create()
Returns a newVkPhysicalDeviceGroupProperties
instance allocated withBufferUtils
.static VkPhysicalDeviceGroupProperties.Buffer
create(int capacity)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated withBufferUtils
.static VkPhysicalDeviceGroupProperties
create(long address)
Returns a newVkPhysicalDeviceGroupProperties
instance for the specified memory address.static VkPhysicalDeviceGroupProperties.Buffer
create(long address, int capacity)
Create aVkPhysicalDeviceGroupProperties.Buffer
instance at the specified memory.static VkPhysicalDeviceGroupProperties
createSafe(long address)
static VkPhysicalDeviceGroupProperties.Buffer
createSafe(long address, int capacity)
static VkPhysicalDeviceGroupProperties
malloc()
Returns a newVkPhysicalDeviceGroupProperties
instance allocated withmemAlloc
.static VkPhysicalDeviceGroupProperties.Buffer
malloc(int capacity)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated withmemAlloc
.static VkPhysicalDeviceGroupProperties
mallocStack()
Returns a newVkPhysicalDeviceGroupProperties
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceGroupProperties.Buffer
mallocStack(int capacity)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceGroupProperties.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated on the specifiedMemoryStack
.static VkPhysicalDeviceGroupProperties
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceGroupProperties
instance allocated on the specifiedMemoryStack
.static int
nphysicalDeviceCount(long struct)
Unsafe version ofphysicalDeviceCount()
.static org.lwjgl.PointerBuffer
nphysicalDevices(long struct)
Unsafe version ofphysicalDevices()
.static long
nphysicalDevices(long struct, int index)
Unsafe version ofphysicalDevices
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
nsubsetAllocation(long struct)
Unsafe version ofsubsetAllocation()
.int
physicalDeviceCount()
Returns the value of thephysicalDeviceCount
field.org.lwjgl.PointerBuffer
physicalDevices()
Returns aPointerBuffer
view of thephysicalDevices
field.long
physicalDevices(int index)
Returns the value at the specified index of thephysicalDevices
field.long
pNext()
Returns the value of thepNext
field.VkPhysicalDeviceGroupProperties
pNext(long value)
Sets the specified value to thepNext
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 thesType
field.VkPhysicalDeviceGroupProperties
sType(int value)
Sets the specified value to thesType
field.boolean
subsetAllocation()
Returns the value of thesubsetAllocation
field.
-
-
-
Constructor Detail
-
VkPhysicalDeviceGroupProperties
public VkPhysicalDeviceGroupProperties(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceGroupProperties
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
physicalDeviceCount
public int physicalDeviceCount()
Returns the value of thephysicalDeviceCount
field.
-
physicalDevices
public org.lwjgl.PointerBuffer physicalDevices()
Returns aPointerBuffer
view of thephysicalDevices
field.
-
physicalDevices
public long physicalDevices(int index)
Returns the value at the specified index of thephysicalDevices
field.
-
subsetAllocation
public boolean subsetAllocation()
Returns the value of thesubsetAllocation
field.
-
sType
public VkPhysicalDeviceGroupProperties sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPhysicalDeviceGroupProperties pNext(long value)
Sets the specified value to thepNext
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 newVkPhysicalDeviceGroupProperties
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceGroupProperties calloc()
Returns a newVkPhysicalDeviceGroupProperties
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceGroupProperties create()
Returns a newVkPhysicalDeviceGroupProperties
instance allocated withBufferUtils
.
-
create
public static VkPhysicalDeviceGroupProperties create(long address)
Returns a newVkPhysicalDeviceGroupProperties
instance for the specified memory address.
-
createSafe
@Nullable public static VkPhysicalDeviceGroupProperties createSafe(long address)
-
malloc
public static VkPhysicalDeviceGroupProperties.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPhysicalDeviceGroupProperties.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceGroupProperties.Buffer create(int capacity)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceGroupProperties.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceGroupProperties.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPhysicalDeviceGroupProperties.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPhysicalDeviceGroupProperties mallocStack()
Returns a newVkPhysicalDeviceGroupProperties
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPhysicalDeviceGroupProperties callocStack()
Returns a newVkPhysicalDeviceGroupProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPhysicalDeviceGroupProperties mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceGroupProperties
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPhysicalDeviceGroupProperties callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceGroupProperties
instance allocated on the specifiedMemoryStack
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 newVkPhysicalDeviceGroupProperties.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceGroupProperties.Buffer callocStack(int capacity)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated on the thread-localMemoryStack
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 newVkPhysicalDeviceGroupProperties.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceGroupProperties.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPhysicalDeviceGroupProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
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()
.
-
nphysicalDevices
public static org.lwjgl.PointerBuffer nphysicalDevices(long struct)
Unsafe version ofphysicalDevices()
.
-
nphysicalDevices
public static long nphysicalDevices(long struct, int index)
Unsafe version ofphysicalDevices
.
-
nsubsetAllocation
public static int nsubsetAllocation(long struct)
Unsafe version ofsubsetAllocation()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
-