Package org.lwjgl.vulkan

Class VkPhysicalDeviceProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceProperties>

org.lwjgl.vulkan.VkPhysicalDeviceProperties

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkPhysicalDeviceProperties
extends Struct<VkPhysicalDeviceProperties>
implements NativeResource

 struct VkPhysicalDeviceProperties {
     uint32_t apiVersion;
     uint32_t driverVersion;
     uint32_t vendorID;
     uint32_t deviceID;
     VkPhysicalDeviceType deviceType;
     char deviceName[VK_MAX_PHYSICAL_DEVICE_NAME_SIZE];
     uint8_t pipelineCacheUUID[VK_UUID_SIZE];
     {@link VkPhysicalDeviceLimits VkPhysicalDeviceLimits} limits;
     {@link VkPhysicalDeviceSparseProperties VkPhysicalDeviceSparseProperties} sparseProperties;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceProperties.Buffer	An array of VkPhysicalDeviceProperties structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	APIVERSION	The struct member offsets.
static final int	DEVICEID	The struct member offsets.
static final int	DEVICENAME	The struct member offsets.
static final int	DEVICETYPE	The struct member offsets.
static final int	DRIVERVERSION	The struct member offsets.
static final int	LIMITS	The struct member offsets.
static final int	PIPELINECACHEUUID	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPARSEPROPERTIES	The struct member offsets.
static final int	VENDORID	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	apiVersion()
static VkPhysicalDeviceProperties	calloc()	Returns a new VkPhysicalDeviceProperties instance allocated with memCalloc.
static VkPhysicalDeviceProperties.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceProperties.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceProperties.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceProperties	calloc(MemoryStack stack)	Returns a new VkPhysicalDeviceProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceProperties	callocStack()	Deprecated.
static VkPhysicalDeviceProperties.Buffer	callocStack(int capacity)	Deprecated.
static VkPhysicalDeviceProperties.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPhysicalDeviceProperties	callocStack(MemoryStack stack)	Deprecated.
static VkPhysicalDeviceProperties	create()	Returns a new VkPhysicalDeviceProperties instance allocated with BufferUtils.
static VkPhysicalDeviceProperties.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceProperties.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceProperties	create(long address)	Returns a new VkPhysicalDeviceProperties instance for the specified memory address.
static VkPhysicalDeviceProperties.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceProperties.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	deviceID()
ByteBuffer	deviceName()
String	deviceNameString()
int	deviceType()
int	driverVersion()
VkPhysicalDeviceLimits	limits()
static VkPhysicalDeviceProperties	malloc()	Returns a new VkPhysicalDeviceProperties instance allocated with memAlloc.
static VkPhysicalDeviceProperties.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceProperties.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceProperties.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceProperties.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceProperties	malloc(MemoryStack stack)	Returns a new VkPhysicalDeviceProperties instance allocated on the specified MemoryStack.
static VkPhysicalDeviceProperties	mallocStack()	Deprecated.
static VkPhysicalDeviceProperties.Buffer	mallocStack(int capacity)	Deprecated.
static VkPhysicalDeviceProperties.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPhysicalDeviceProperties	mallocStack(MemoryStack stack)	Deprecated.
static int	napiVersion(long struct)	Unsafe version of apiVersion().
static int	ndeviceID(long struct)	Unsafe version of deviceID().
static ByteBuffer	ndeviceName(long struct)	Unsafe version of deviceName().
static String	ndeviceNameString(long struct)	Unsafe version of deviceNameString().
static int	ndeviceType(long struct)	Unsafe version of deviceType().
static int	ndriverVersion(long struct)	Unsafe version of driverVersion().
static VkPhysicalDeviceLimits	nlimits(long struct)	Unsafe version of limits().
static ByteBuffer	npipelineCacheUUID(long struct)	Unsafe version of pipelineCacheUUID().
static byte	npipelineCacheUUID(long struct, int index)	Unsafe version of pipelineCacheUUID.
static VkPhysicalDeviceSparseProperties	nsparseProperties(long struct)	Unsafe version of sparseProperties().
static int	nvendorID(long struct)	Unsafe version of vendorID().
ByteBuffer	pipelineCacheUUID()
byte	pipelineCacheUUID(int index)
int	sizeof()	Returns sizeof(struct).
VkPhysicalDeviceSparseProperties	sparseProperties()
int	vendorID()

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.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.

APIVERSION

public static final int APIVERSION

The struct member offsets.

DRIVERVERSION

public static final int DRIVERVERSION

The struct member offsets.

VENDORID

public static final int VENDORID

The struct member offsets.

DEVICEID

public static final int DEVICEID

The struct member offsets.

DEVICETYPE

public static final int DEVICETYPE

The struct member offsets.

DEVICENAME

public static final int DEVICENAME

The struct member offsets.

PIPELINECACHEUUID

public static final int PIPELINECACHEUUID

The struct member offsets.

LIMITS

public static final int LIMITS

The struct member offsets.

SPARSEPROPERTIES

public static final int SPARSEPROPERTIES

The struct member offsets.

Constructor Details

VkPhysicalDeviceProperties

public VkPhysicalDeviceProperties(ByteBuffer container)

Creates a VkPhysicalDeviceProperties 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<VkPhysicalDeviceProperties>

apiVersion

public int apiVersion()

Returns:

the value of the apiVersion field.

driverVersion

public int driverVersion()

Returns:

the value of the driverVersion field.

vendorID

public int vendorID()

Returns:

the value of the vendorID field.

deviceID

public int deviceID()

Returns:

the value of the deviceID field.

deviceType

public int deviceType()

Returns:

the value of the deviceType field.

deviceName

public ByteBuffer deviceName()

Returns:

a ByteBuffer view of the deviceName field.

deviceNameString

public String deviceNameString()

Returns:

the null-terminated string stored in the deviceName field.

pipelineCacheUUID

public ByteBuffer pipelineCacheUUID()

Returns:

a ByteBuffer view of the pipelineCacheUUID field.

pipelineCacheUUID

public byte pipelineCacheUUID(int index)

Returns:

the value at the specified index of the pipelineCacheUUID field.

limits

public VkPhysicalDeviceLimits limits()

Returns:

a VkPhysicalDeviceLimits view of the limits field.

sparseProperties

public VkPhysicalDeviceSparseProperties sparseProperties()

Returns:

a VkPhysicalDeviceSparseProperties view of the sparseProperties field.

malloc

public static VkPhysicalDeviceProperties malloc()

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

calloc

public static VkPhysicalDeviceProperties calloc()

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

create

public static VkPhysicalDeviceProperties create()

Returns a new VkPhysicalDeviceProperties instance allocated with BufferUtils.

create

public static VkPhysicalDeviceProperties create(long address)

Returns a new VkPhysicalDeviceProperties instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceProperties.Buffer create(int capacity)

Returns a new VkPhysicalDeviceProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceProperties.Buffer create(long address,
 int capacity)

Create a VkPhysicalDeviceProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPhysicalDeviceProperties mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceProperties callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceProperties mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceProperties callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceProperties.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceProperties.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceProperties.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceProperties.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkPhysicalDeviceProperties malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceProperties calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceProperties.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkPhysicalDeviceProperties.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

napiVersion

public static int napiVersion(long struct)

Unsafe version of apiVersion().

ndriverVersion

public static int ndriverVersion(long struct)

Unsafe version of driverVersion().

nvendorID

public static int nvendorID(long struct)

Unsafe version of vendorID().

ndeviceID

public static int ndeviceID(long struct)

Unsafe version of deviceID().

ndeviceType

public static int ndeviceType(long struct)

Unsafe version of deviceType().

ndeviceName

public static ByteBuffer ndeviceName(long struct)

Unsafe version of deviceName().

ndeviceNameString

public static String ndeviceNameString(long struct)

Unsafe version of deviceNameString().

npipelineCacheUUID

public static ByteBuffer npipelineCacheUUID(long struct)

Unsafe version of pipelineCacheUUID().

npipelineCacheUUID

public static byte npipelineCacheUUID(long struct,
 int index)

Unsafe version of pipelineCacheUUID.

nlimits

public static VkPhysicalDeviceLimits nlimits(long struct)

Unsafe version of limits().

nsparseProperties

public static VkPhysicalDeviceSparseProperties nsparseProperties(long struct)

Unsafe version of sparseProperties().