Skip to main content

PerformanceIndexes

Class

Provides information about the device running the Lens.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Provides information about the device running the Lens. Accessible through global.deviceInfoSystem.performanceIndexes.

Index

Example

var devicePerformanceIndex = global.deviceInfoSystem.performanceIndexes.general
// X is an arbitrary value that is related to a device threshold.
if(devicePerformanceIndex > X){
// Load high fidelity model from remote assets.
}else{
// Load low poly model from remote assets.
}

Extends

Properties

general

readonly general: number

Provides a number denoting a devices performance capability. See phone clustering.

Methods

getTypeName()

static getTypeName(): TypeName<PerformanceIndexes>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<PerformanceIndexes>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame