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– aVkPhysicalDeviceTypespecifying the type of device. One of:PHYSICAL_DEVICE_TYPE_CPUPHYSICAL_DEVICE_TYPE_DISCRETE_GPUPHYSICAL_DEVICE_TYPE_INTEGRATED_GPUPHYSICAL_DEVICE_TYPE_OTHERPHYSICAL_DEVICE_TYPE_VIRTUAL_GPUdeviceName– 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– theVkPhysicalDeviceLimitsstructure which specifies device-specific limits of the physical devicesparseProperties– theVkPhysicalDeviceSparsePropertiesstructure 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;VkPhysicalDeviceLimitslimits;VkPhysicalDeviceSparsePropertiessparseProperties; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkPhysicalDeviceProperties.BufferAn array ofVkPhysicalDevicePropertiesstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe 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 aVkPhysicalDevicePropertiesinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description intapiVersion()Returns the value of theapiVersionfield.static VkPhysicalDevicePropertiescalloc()Returns a newVkPhysicalDevicePropertiesinstance allocated withmemCalloc.static VkPhysicalDeviceProperties.Buffercalloc(int capacity)Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated withmemCalloc.static VkPhysicalDevicePropertiescallocStack()Returns a newVkPhysicalDevicePropertiesinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceProperties.BuffercallocStack(int capacity)Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceProperties.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDevicePropertiescallocStack(MemoryStack stack)Returns a newVkPhysicalDevicePropertiesinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDevicePropertiescreate()Returns a newVkPhysicalDevicePropertiesinstance allocated withBufferUtils.static VkPhysicalDeviceProperties.Buffercreate(int capacity)Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated withBufferUtils.static VkPhysicalDevicePropertiescreate(long address)Returns a newVkPhysicalDevicePropertiesinstance for the specified memory address ornullif the address isNULL.static VkPhysicalDeviceProperties.Buffercreate(long address, int capacity)Create aVkPhysicalDeviceProperties.Bufferinstance at the specified memory.intdeviceID()Returns the value of thedeviceIDfield.java.nio.ByteBufferdeviceName()Returns aByteBufferview of thedeviceNamefield.java.lang.StringdeviceNameString()Decodes the null-terminated string stored in thedeviceNamefield.intdeviceType()Returns the value of thedeviceTypefield.intdriverVersion()Returns the value of thedriverVersionfield.VkPhysicalDeviceLimitslimits()Returns aVkPhysicalDeviceLimitsview of thelimitsfield.static VkPhysicalDevicePropertiesmalloc()Returns a newVkPhysicalDevicePropertiesinstance allocated withmemAlloc.static VkPhysicalDeviceProperties.Buffermalloc(int capacity)Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated withmemAlloc.static VkPhysicalDevicePropertiesmallocStack()Returns a newVkPhysicalDevicePropertiesinstance allocated on the thread-localMemoryStack.static VkPhysicalDeviceProperties.BuffermallocStack(int capacity)Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated on the thread-localMemoryStack.static VkPhysicalDeviceProperties.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated on the specifiedMemoryStack.static VkPhysicalDevicePropertiesmallocStack(MemoryStack stack)Returns a newVkPhysicalDevicePropertiesinstance allocated on the specifiedMemoryStack.java.nio.ByteBufferpipelineCacheUUID()Returns aByteBufferview of thepipelineCacheUUIDfield.bytepipelineCacheUUID(int index)Returns the value at the specified index of thepipelineCacheUUIDfield.intsizeof()Returns thesizeof(struct).VkPhysicalDeviceSparsePropertiessparseProperties()Returns aVkPhysicalDeviceSparsePropertiesview of thesparsePropertiesfield.intvendorID()Returns the value of thevendorIDfield.-
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 aVkPhysicalDevicePropertiesinstance 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 Detail
-
sizeof
public int sizeof()
Description copied from class:StructReturns thesizeof(struct).
-
apiVersion
public int apiVersion()
Returns the value of theapiVersionfield.
-
driverVersion
public int driverVersion()
Returns the value of thedriverVersionfield.
-
vendorID
public int vendorID()
Returns the value of thevendorIDfield.
-
deviceID
public int deviceID()
Returns the value of thedeviceIDfield.
-
deviceType
public int deviceType()
Returns the value of thedeviceTypefield.
-
deviceName
public java.nio.ByteBuffer deviceName()
Returns aByteBufferview of thedeviceNamefield.
-
deviceNameString
public java.lang.String deviceNameString()
Decodes the null-terminated string stored in thedeviceNamefield.
-
pipelineCacheUUID
public java.nio.ByteBuffer pipelineCacheUUID()
Returns aByteBufferview of thepipelineCacheUUIDfield.
-
pipelineCacheUUID
public byte pipelineCacheUUID(int index)
Returns the value at the specified index of thepipelineCacheUUIDfield.
-
limits
public VkPhysicalDeviceLimits limits()
Returns aVkPhysicalDeviceLimitsview of thelimitsfield.
-
sparseProperties
public VkPhysicalDeviceSparseProperties sparseProperties()
Returns aVkPhysicalDeviceSparsePropertiesview of thesparsePropertiesfield.
-
malloc
public static VkPhysicalDeviceProperties malloc()
Returns a newVkPhysicalDevicePropertiesinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceProperties calloc()
Returns a newVkPhysicalDevicePropertiesinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceProperties create()
Returns a newVkPhysicalDevicePropertiesinstance allocated withBufferUtils.
-
create
public static VkPhysicalDeviceProperties create(long address)
Returns a newVkPhysicalDevicePropertiesinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkPhysicalDeviceProperties.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPhysicalDeviceProperties.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceProperties.Buffer create(int capacity)
Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceProperties.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceProperties.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceProperties mallocStack()
Returns a newVkPhysicalDevicePropertiesinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPhysicalDeviceProperties callocStack()
Returns a newVkPhysicalDevicePropertiesinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPhysicalDeviceProperties mallocStack(MemoryStack stack)
Returns a newVkPhysicalDevicePropertiesinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPhysicalDeviceProperties callocStack(MemoryStack stack)
Returns a newVkPhysicalDevicePropertiesinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPhysicalDeviceProperties.Buffer callocStack(int capacity)
Returns a newVkPhysicalDeviceProperties.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceProperties.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPhysicalDeviceProperties.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-