AzFramework::DeviceAttributeRAM Class Reference

#include <DeviceAttributeRAM.h>

Inherits AzFramework::DeviceAttribute.

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

Protected Attributes
AZStd::string	m_name = "RAM"
AZStd::string	m_description = "RAM available to OS in GiB, usually less than the physically installed RAM."
float	m_valueInGiB = 0.f
AZStd::string	m_value

Detailed Description

Device attribute for getting RAM available to OS in GiB which is usually less than the physically installed RAM For this reason, instead of checking if a device has e.g. 8GiB of RAM, it is better to check that the amount of available RAM is equal to or greater than the actual amount of RAM needed by your application e.g. 5.5GiB plus some small margin. Note: some mobile devices set this value based on the amount physical RAM installed which may be more than is actually available for use.

Member Function Documentation

Evaluate()

bool AzFramework::DeviceAttributeRAM::Evaluate ( AZStd::string_view  rule ) const

overridevirtual

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

Implements AzFramework::DeviceAttribute.

GetDescription()

AZStd::string_view AzFramework::DeviceAttributeRAM::GetDescription ( ) const

overridevirtual

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

Implements AzFramework::DeviceAttribute.

GetName()

AZStd::string_view AzFramework::DeviceAttributeRAM::GetName ( ) const

overridevirtual

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

Implements AzFramework::DeviceAttribute.

GetValue()

AZStd::any AzFramework::DeviceAttributeRAM::GetValue ( ) const

overridevirtual

Get the value of this attribute.

Implements AzFramework::DeviceAttribute.

---

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

• Code/Framework/AzFramework/AzFramework/Device/DeviceAttributeRAM.h