Class VkPhysicalDeviceGroupProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceGroupProperties>

org.lwjgl.vulkan.VkPhysicalDeviceGroupProperties

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkPhysicalDeviceGroupPropertiesKHR

public class VkPhysicalDeviceGroupProperties
extends Struct<VkPhysicalDeviceGroupProperties>
implements NativeResource

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 of VkPhysicalDeviceGroupProperties structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PHYSICALDEVICECOUNT	The struct member offsets.
static final int	PHYSICALDEVICES	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	SUBSETALLOCATION	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkPhysicalDeviceGroupProperties(ByteBuffer container)	Creates a VkPhysicalDeviceGroupProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceGroupProperties	calloc(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 @Nullable VkPhysicalDeviceGroupProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable 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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceGroupProperties.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceGroupProperties	malloc(MemoryStack stack)	Returns a new VkPhysicalDeviceGroupProperties instance allocated on the specified MemoryStack.
static int	nphysicalDeviceCount(long struct)	Unsafe version of physicalDeviceCount().
static 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()
PointerBuffer	physicalDevices()
long	physicalDevices(int index)
long	pNext()
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()	Returns sizeof(struct).
int	sType()
VkPhysicalDeviceGroupProperties	sType(int value)	Sets the specified value to the sType field.
VkPhysicalDeviceGroupProperties	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_GROUP_PROPERTIES value to the sType field.
boolean	subsetAllocation()

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

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 Details

VkPhysicalDeviceGroupProperties

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkPhysicalDeviceGroupProperties>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void *")
public long pNext()

Returns:

the value of the pNext field.

physicalDeviceCount

@NativeType("uint32_t")
public int physicalDeviceCount()

Returns:

the value of the physicalDeviceCount field.

physicalDevices

@NativeType("VkPhysicalDevice[VK_MAX_DEVICE_GROUP_SIZE]")
public PointerBuffer physicalDevices()

Returns:

a PointerBuffer view of the physicalDevices field.

physicalDevices

@NativeType("VkPhysicalDevice")
public long physicalDevices(int index)

Returns:

the value at the specified index of the physicalDevices field.

subsetAllocation

@NativeType("VkBool32")
public boolean subsetAllocation()

Returns:

the value of the subsetAllocation field.

sType

public VkPhysicalDeviceGroupProperties sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkPhysicalDeviceGroupProperties sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_GROUP_PROPERTIES value to the sType field.

pNext

public VkPhysicalDeviceGroupProperties pNext(@NativeType("void *")
 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

public static @Nullable 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

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

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceGroupProperties malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceGroupProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

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 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.