Detailed Description

Adapter description. Describes hardware driver identificators as well as memory limits.

 
struct AdapterDesc {
    std::array<const char, 256> description{}; 
    uint32_t vendor_id; 
    uint32_t device_id; 
    uint32_t subsys_id; 
    uint32_t revision; 
    uint64_t dedicated_video_memory; 
    uint64_t dedicated_system_memory; 
    uint64_t shared_system_memory; 
    uint64_t adapter_id; 
    std::array<uint8_t, 16> adapter_uuid{}; 
    wis::AdapterFlags flags; 
};

Definition at line 1585 of file api.hpp.

#include <api.hpp>

Public Attributes
std::array< const char, 256 >	description {}
	Adapter description. Contains name of the graphics adapter.

uint32_t	vendor_id
	Vendor ID. Can be used to find the correct adapter.

uint32_t	device_id
	Device ID. Together with wis::AdapterDesc::vendor_id uniquely identifies the device.

uint32_t	subsys_id
	Unused.

uint32_t	revision
	Driver revision. Unused.

uint64_t	dedicated_video_memory
	Dedicated video memory in bytes. Used for Default Memory type.

uint64_t	dedicated_system_memory
	Dedicated system memory in bytes. Used for Upload and Readback Memory types.

uint64_t	shared_system_memory
	Shared system memory in bytes. Used for GPUUpload Memory type.

uint64_t	adapter_id
	Adapter unique ID (LUID). Can be used to find the correct adapter.

std::array< uint8_t, 16 >	adapter_uuid {}
	UUID of the adapter, used only with Vulkan API on systems with no LUID.

wis::AdapterFlags	flags
	Adapter flags. Describe the adapter kind.

Data Members

◆ adapter_id

uint64_t wis::AdapterDesc::adapter_id

Adapter unique ID (LUID). Can be used to find the correct adapter.

Definition at line 1594 of file api.hpp.

◆ adapter_uuid

std::array<uint8_t, 16> wis::AdapterDesc::adapter_uuid {}

UUID of the adapter, used only with Vulkan API on systems with no LUID.

Definition at line 1595 of file api.hpp.

◆ dedicated_system_memory

uint64_t wis::AdapterDesc::dedicated_system_memory

Dedicated system memory in bytes. Used for Upload and Readback Memory types.

Definition at line 1592 of file api.hpp.

◆ dedicated_video_memory

uint64_t wis::AdapterDesc::dedicated_video_memory

Dedicated video memory in bytes. Used for Default Memory type.

Definition at line 1591 of file api.hpp.

◆ description

std::array<const char, 256> wis::AdapterDesc::description {}

Adapter description. Contains name of the graphics adapter.

Definition at line 1586 of file api.hpp.

◆ device_id

uint32_t wis::AdapterDesc::device_id

Device ID. Together with wis::AdapterDesc::vendor_id uniquely identifies the device.

Definition at line 1588 of file api.hpp.

◆ flags

wis::AdapterFlags wis::AdapterDesc::flags

Adapter flags. Describe the adapter kind.

Definition at line 1596 of file api.hpp.

◆ revision

uint32_t wis::AdapterDesc::revision

Driver revision. Unused.

Definition at line 1590 of file api.hpp.

◆ shared_system_memory

uint64_t wis::AdapterDesc::shared_system_memory

Shared system memory in bytes. Used for GPUUpload Memory type.

Definition at line 1593 of file api.hpp.

◆ subsys_id

uint32_t wis::AdapterDesc::subsys_id

Unused.

Definition at line 1589 of file api.hpp.

◆ vendor_id

uint32_t wis::AdapterDesc::vendor_id

Vendor ID. Can be used to find the correct adapter.

Definition at line 1587 of file api.hpp.

The documentation for this struct was generated from the following file:

/home/runner/work/Wisdom/Wisdom/wisdom/include/wisdom/generated/api/api.hpp