Open 3D Engine AzFramework API Reference 24.09.2
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AzFramework::DeviceAttribute Class Referenceabstract

Inherited by AzFramework::DeviceAttributeDeviceModel, AzFramework::DeviceAttributeGPUModel, and AzFramework::DeviceAttributeRAM.

Public Member Functions

 AZ_RTTI (DeviceAttribute, "{8B7AF778-DD8A-4AFA-8416-EA2D03080F29}")
 
virtual AZStd::string_view GetName () const =0
 Get the name of the device attribute e.g. gpuMemory, gpuVendor, customAttribute42.
 
virtual AZStd::string_view GetDescription () const =0
 Get a description of this device attribute, used for help text and eventual UI.
 
virtual bool Evaluate (AZStd::string_view rule) const =0
 Evaluate a rule and return true if there is a match for this device attribute.
 
virtual AZStd::any GetValue () const =0
 Get the value of this attribute.
 

Member Function Documentation

◆ Evaluate()

virtual bool AzFramework::DeviceAttribute::Evaluate ( AZStd::string_view rule) const
pure virtual

Evaluate a rule and return true if there is a match for this device attribute.

Implemented in AzFramework::DeviceAttributeDeviceModel, AzFramework::DeviceAttributeGPUModel, and AzFramework::DeviceAttributeRAM.

◆ GetDescription()

virtual AZStd::string_view AzFramework::DeviceAttribute::GetDescription ( ) const
pure virtual

Get a description of this device attribute, used for help text and eventual UI.

Implemented in AzFramework::DeviceAttributeDeviceModel, AzFramework::DeviceAttributeGPUModel, and AzFramework::DeviceAttributeRAM.

◆ GetName()

virtual AZStd::string_view AzFramework::DeviceAttribute::GetName ( ) const
pure virtual

Get the name of the device attribute e.g. gpuMemory, gpuVendor, customAttribute42.

Implemented in AzFramework::DeviceAttributeDeviceModel, AzFramework::DeviceAttributeGPUModel, and AzFramework::DeviceAttributeRAM.

◆ GetValue()

virtual AZStd::any AzFramework::DeviceAttribute::GetValue ( ) const
pure virtual

Get the value of this attribute.

Implemented in AzFramework::DeviceAttributeDeviceModel, AzFramework::DeviceAttributeGPUModel, and AzFramework::DeviceAttributeRAM.

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