Package org.lwjgl.vulkan
Class VkPhysicalDeviceProperties
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPhysicalDeviceProperties
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkPhysicalDeviceProperties extends Struct
Khronos Reference Page
Vulkan SpecificationContains general properties of a physical device.
Member documentation
apiVersion
– the version of Vulkan supported by the devicedriverVersion
– the vendor-specified version of the drivervendorID
– a unique identifier for the vendor of the physical devicedeviceID
– a unique identifier for the physical device among devices available from the vendordeviceType
– aVkPhysicalDeviceType
specifying the type of device. One of:PHYSICAL_DEVICE_TYPE_CPU
PHYSICAL_DEVICE_TYPE_DISCRETE_GPU
PHYSICAL_DEVICE_TYPE_INTEGRATED_GPU
PHYSICAL_DEVICE_TYPE_OTHER
PHYSICAL_DEVICE_TYPE_VIRTUAL_GPU
deviceName
– a null-terminated UTF-8 string containing the name of the devicepipelineCacheUUID
– an array of sizeVK_UUID_SIZE
, containing 8-bit values that represent a universally unique identifier for the devicelimits
– theVkPhysicalDeviceLimits
structure which specifies device-specific limits of the physical devicesparseProperties
– theVkPhysicalDeviceSparseProperties
structure which specifies various sparse related properties of the physical device
Layout
struct VkPhysicalDeviceProperties { uint32_t apiVersion; uint32_t driverVersion; uint32_t vendorID; uint32_t deviceID; VkPhysicalDeviceType deviceType; char[256] deviceName; uint8_t[16] pipelineCacheUUID;
VkPhysicalDeviceLimits
limits;VkPhysicalDeviceSparseProperties
sparseProperties; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkPhysicalDeviceProperties.Buffer
An array ofVkPhysicalDeviceProperties
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkPhysicalDeviceProperties(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceProperties
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description int
apiVersion()
Returns the value of theapiVersion
field.static VkPhysicalDeviceProperties
calloc()
Returns a newVkPhysicalDeviceProperties
instance allocated withmemCalloc
.static VkPhysicalDeviceProperties.Buffer
calloc(int capacity)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated withmemCalloc
.static VkPhysicalDeviceProperties
callocStack()
Returns a newVkPhysicalDeviceProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceProperties.Buffer
callocStack(int capacity)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceProperties.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceProperties
callocStack(MemoryStack stack)
Returns a newVkPhysicalDeviceProperties
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPhysicalDeviceProperties
create()
Returns a newVkPhysicalDeviceProperties
instance allocated withBufferUtils
.static VkPhysicalDeviceProperties.Buffer
create(int capacity)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated withBufferUtils
.static VkPhysicalDeviceProperties
create(long address)
Returns a newVkPhysicalDeviceProperties
instance for the specified memory address ornull
if the address isNULL
.static VkPhysicalDeviceProperties.Buffer
create(long address, int capacity)
Create aVkPhysicalDeviceProperties.Buffer
instance at the specified memory.int
deviceID()
Returns the value of thedeviceID
field.java.nio.ByteBuffer
deviceName()
Returns aByteBuffer
view of thedeviceName
field.java.lang.String
deviceNameString()
Decodes the null-terminated string stored in thedeviceName
field.int
deviceType()
Returns the value of thedeviceType
field.int
driverVersion()
Returns the value of thedriverVersion
field.VkPhysicalDeviceLimits
limits()
Returns aVkPhysicalDeviceLimits
view of thelimits
field.static VkPhysicalDeviceProperties
malloc()
Returns a newVkPhysicalDeviceProperties
instance allocated withmemAlloc
.static VkPhysicalDeviceProperties.Buffer
malloc(int capacity)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated withmemAlloc
.static VkPhysicalDeviceProperties
mallocStack()
Returns a newVkPhysicalDeviceProperties
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceProperties.Buffer
mallocStack(int capacity)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated on the thread-localMemoryStack
.static VkPhysicalDeviceProperties.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated on the specifiedMemoryStack
.static VkPhysicalDeviceProperties
mallocStack(MemoryStack stack)
Returns a newVkPhysicalDeviceProperties
instance allocated on the specifiedMemoryStack
.java.nio.ByteBuffer
pipelineCacheUUID()
Returns aByteBuffer
view of thepipelineCacheUUID
field.byte
pipelineCacheUUID(int index)
Returns the value at the specified index of thepipelineCacheUUID
field.int
sizeof()
Returns thesizeof(struct)
.VkPhysicalDeviceSparseProperties
sparseProperties()
Returns aVkPhysicalDeviceSparseProperties
view of thesparseProperties
field.int
vendorID()
Returns the value of thevendorID
field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkPhysicalDeviceProperties
public VkPhysicalDeviceProperties(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceProperties
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()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
apiVersion
public int apiVersion()
Returns the value of theapiVersion
field.
-
driverVersion
public int driverVersion()
Returns the value of thedriverVersion
field.
-
vendorID
public int vendorID()
Returns the value of thevendorID
field.
-
deviceID
public int deviceID()
Returns the value of thedeviceID
field.
-
deviceType
public int deviceType()
Returns the value of thedeviceType
field.
-
deviceName
public java.nio.ByteBuffer deviceName()
Returns aByteBuffer
view of thedeviceName
field.
-
deviceNameString
public java.lang.String deviceNameString()
Decodes the null-terminated string stored in thedeviceName
field.
-
pipelineCacheUUID
public java.nio.ByteBuffer pipelineCacheUUID()
Returns aByteBuffer
view of thepipelineCacheUUID
field.
-
pipelineCacheUUID
public byte pipelineCacheUUID(int index)
Returns the value at the specified index of thepipelineCacheUUID
field.
-
limits
public VkPhysicalDeviceLimits limits()
Returns aVkPhysicalDeviceLimits
view of thelimits
field.
-
sparseProperties
public VkPhysicalDeviceSparseProperties sparseProperties()
Returns aVkPhysicalDeviceSparseProperties
view of thesparseProperties
field.
-
malloc
public static VkPhysicalDeviceProperties malloc()
Returns a newVkPhysicalDeviceProperties
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceProperties calloc()
Returns a newVkPhysicalDeviceProperties
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceProperties create()
Returns a newVkPhysicalDeviceProperties
instance allocated withBufferUtils
.
-
create
public static VkPhysicalDeviceProperties create(long address)
Returns a newVkPhysicalDeviceProperties
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkPhysicalDeviceProperties.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPhysicalDeviceProperties.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceProperties.Buffer create(int capacity)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPhysicalDeviceProperties.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceProperties.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceProperties mallocStack()
Returns a newVkPhysicalDeviceProperties
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPhysicalDeviceProperties callocStack()
Returns a newVkPhysicalDeviceProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPhysicalDeviceProperties mallocStack(MemoryStack stack)
Returns a newVkPhysicalDeviceProperties
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPhysicalDeviceProperties callocStack(MemoryStack stack)
Returns a newVkPhysicalDeviceProperties
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPhysicalDeviceProperties.Buffer mallocStack(int capacity)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceProperties.Buffer callocStack(int capacity)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceProperties.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPhysicalDeviceProperties.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkPhysicalDeviceProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-