Platform Helper is an utility class that can be used to retrieve platform related information. More...
#include <PlatformDefaults.h>
Static Public Member Functions | |
static const char * | GetPlatformName (PlatformId platform) |
Given a platformIndex returns the platform name. | |
static void | AppendPlatformCodeNames (AZStd::fixed_vector< AZStd::string_view, MaxPlatformCodeNames > &platformCodes, AZStd::string_view platformName) |
Converts the platform name to the platform code names as defined in AZ_TRAIT_OS_PLATFORM_CODENAME. | |
static void | AppendPlatformCodeNames (AZStd::fixed_vector< AZStd::string_view, MaxPlatformCodeNames > &platformCodes, PlatformId platformId) |
Converts the platform name to the platform code names as defined in AZ_TRAIT_OS_PLATFORM_CODENAME. | |
static int | GetPlatformIndexFromName (AZStd::string_view platformName) |
static PlatformId | GetPlatformIdFromName (AZStd::string_view platformName) |
static PlatformFlags | GetPlatformFlagFromPlatformIndex (PlatformId platform) |
Given a platformIndex returns the platformFlags. | |
static AZStd::fixed_vector< AZStd::string_view, PlatformId::NumPlatformIds > | GetPlatforms (PlatformFlags platformFlags) |
Given a platformFlags returns all the platform identifiers that are set. | |
static AZStd::fixed_vector< AZStd::string_view, PlatformId::NumPlatformIds > | GetPlatformsInterpreted (PlatformFlags platformFlags) |
Given a platformFlags returns all the platform identifiers that are set, with special flags interpreted. Do not use the result for saving. | |
static AZStd::fixed_vector< PlatformId, PlatformId::NumPlatformIds > | GetPlatformIndices (PlatformFlags platformFlags) |
Given a platformFlags return a list of PlatformId indices. | |
static AZStd::fixed_vector< PlatformId, PlatformId::NumPlatformIds > | GetPlatformIndicesInterpreted (PlatformFlags platformFlags) |
Given a platformFlags return a list of PlatformId indices, with special flags interpreted. Do not use the result for saving. | |
static PlatformFlags | GetPlatformFlag (AZStd::string_view platform) |
Given a platform identifier returns its corresponding platform flag. | |
static AssetPlatformCombinedString | GetCommaSeparatedPlatformList (PlatformFlags platformFlags) |
Given any platformFlags returns a string listing the input platforms. | |
static PlatformFlags | GetPlatformFlagsInterpreted (PlatformFlags platformFlags) |
If platformFlags contains any special flags, they are removed and replaced with the normal flags they represent. | |
static bool | IsSpecialPlatform (PlatformFlags platformFlags) |
Returns true if platformFlags contains any special flags. | |
static bool | HasPlatformFlag (PlatformFlags platformFlags, PlatformId checkPlatform) |
Returns true if platformFlags has checkPlatform flag set. | |
Platform Helper is an utility class that can be used to retrieve platform related information.
|
static |
Given a platform name returns a platform id. If the platform is not found, the method returns -1.
|
static |
Given a platform name returns a platform index. If the platform is not found, the method returns -1.