- Overview
- Align - (align.h)
- Array - (array.h)
- Atomic - (atomic.h)
- dmAndroid - (android.h)
- dmBuffer - (buffer.h)
- dmConditionVariable - (condition_variable.h)
- dmConfigFile - (configfile.h)
- dmConfigFile - (configfile_gen.hpp)
- dmConnectionPool - (connection_pool.h)
- dmCrypt - (crypt.h)
- dmDDF - (ddf.h)
- dmEngine - (extension.hpp)
- dmExtension - (extension_gen.hpp)
- dmFileDescriptor - (file_descriptor.h)
- dmFont - (font.h)
- dmGameObject - (component.h)
- dmGameObject - (gameobject.h)
- dmGameObject - (gameobject_props.h)
- dmGameObject - (script.h)
- dmGameSystem - (comp_collection_factory.h)
- dmGameSystem - (render_constants.h)
- dmGameSystem - (comp_factory.h)
- dmGameSystem - (res_font.h)
- dmGameSystem - (gui.h)
- dmGameSystem - (property.h)
- dmGraphics - (graphics_opengl.h)
- dmGraphics - (graphics_vulkan.h)
- dmGraphics - (graphics.h)
- dmGraphics - (graphics_native.h)
- dmGui - (gui.h)
- dmHid - (hid.h)
- dmHttpClient - (http_client.h)
- dmImage - (image.h)
- dmIntersection - (intersection.h)
- dmMath - (math.h)
- dmMemory - (memory.h)
- dmMessage - (message.h)
- dmMutex - (mutex.h)
- dmPhysics - (physics.h)
- dmProfile - (profile.h)
- dmRender - (render.h)
- dmResource - (resource.hpp)
- dmResource - (resource_gen.hpp)
- dmScript - (script.h)
- dmScript - (script.h)
- dmSocket - (socket.h)
- dmSpinlock - (spinlock.h)
- dmSSLSocket - (sslsocket.h)
- dmStaticAssert - (static_assert.h)
- dmSys - (sys.h)
- dmThread - (thread.h)
- dmTime - (time.h)
- dmTransform - (transform.h)
- dmURI - (uri.h)
- dmUtf8 - (utf8.h)
- dmVMath - (vmath.h)
- dmWebServer - (webserver.h)
- DStrings - (dstrings.h)
- engine - (engine_doc.h)
- Extension - (extension.h)
- Hash - (hash.h)
- Hashtable - (hashtable.h)
- Log - (log.h)
- ObjectPool - (object_pool.h)
- Resource - (resource.h)
- Resource - (resource_doc.h)
- Overview
- b2d
- b2d.body
- base
- bit
- buffer
- builtins
- camera
- collectionfactory
- collectionproxy
- coroutine
- crash
- debug
- editor
- factory
- go
- graphics
- gui
- html5
- http
- image
- io
- json
- label
- liveupdate
- math
- model
- msg
- os
- package
- particlefx
- physics
- profiler
- render
- resource
- scripts-script_font.cpp_doc.json
- socket
- sound
- sprite
- string
- sys
- table
- tilemap
- timer
- types
- vmath
- window
- zlib
- Overview
- adinfo - (extension-adinfo)
- admob - (extension-admob)
- adpf - (extension-adpf)
- camera - (extension-camera)
- crazygames - (extension-crazygames)
- crypt - (extension-crypt)
- facebook - (extension-facebook)
- firebase - (extension-firebase-analytics)
- firebase - (extension-firebase-remoteconfig)
- firebase - (extension-firebase)
- fontgen - (extension-fontgen)
- gpgs - (extension-gpgs)
- gui - (extension-spine)
- iac - (extension-iac)
- iap - (extension-iap)
- instantapp - (extension-googleplayinstant)
- ironsource - (extension-ironsource)
- permissions - (extension-permissions)
- poki_sdk - (extension-poki-sdk)
- push - (extension-push)
- realtime - (extension-photon-realtime)
- review - (extension-review)
- rive - (extension-rive)
- safearea - (extension-safearea)
- shop - (extension-xsolla)
- siwa - (extension-siwa)
- spine - (extension-spine)
- steam - (extension-steam)
- websocket - (extension-websocket)
- webview - (extension-webview)
- zendesk - (extension-zendesk)
adpf
Version: stable
| FUNCTIONS | |
|---|---|
| adpf.hint.initialize() | |
| adpf.hint.update_target_fps() | |
| adpf.thermal.initialize() | |
| adpf.thermal.get_headroom() | |
| adpf.thermal.get_status() |
| CONSTANTS | |
|---|---|
| THERMAL_STATUS_CRITICAL | |
| THERMAL_STATUS_EMERGENCY | |
| THERMAL_STATUS_LIGHT | |
| THERMAL_STATUS_MODERATE | |
| THERMAL_STATUS_NONE | |
| THERMAL_STATUS_SEVERE | |
| THERMAL_STATUS_SHUTDOWN |
Functions
adpf.hint.initialize()
adpf.hint.initialize(target_fps_nanos)
Initialise performance hints
PARAMETERS
target_fps_nanos |
number |
RETURNS
boolean |
Return true if the PerformanceHintManager API is available on the device |
adpf.hint.update_target_fps()
adpf.hint.update_target_fps(target_fps_nanos)
Update the target fps
PARAMETERS
target_fps_nanos |
number |
adpf.thermal.initialize()
adpf.thermal.initialize(available)
Initialise thermal
PARAMETERS
available |
boolean |
Return true if the Thermal API is available on the device |
adpf.thermal.get_headroom()
adpf.thermal.get_headroom(forecast_seconds)
Provides an estimate of how much thermal headroom the device currently has before hitting severe throttling.
PARAMETERS
forecast_seconds |
number |
how many seconds in the future to forecast |
RETURNS
number |
a value greater than or equal to 0.0 where 1.0 indicates the SEVERE throttling threshold |
adpf.thermal.get_status()
adpf.thermal.get_status()
Get the current thermal status of the device
PARAMETERS
None
RETURNS
number |
The current thermal status of the device. One of THERMAL_STATUS_XYZ. |
Constants
THERMAL_STATUS_CRITICAL
Platform has done everything to reduce power.
THERMAL_STATUS_EMERGENCY
Key components in platform are shutting down due to thermal condition.
THERMAL_STATUS_LIGHT
Light throttling where UX is not impacted.
THERMAL_STATUS_MODERATE
Moderate throttling where UX is not largely impacted.
THERMAL_STATUS_NONE
Not under throttling.
THERMAL_STATUS_SEVERE
Severe throttling where UX is largely impacted.
THERMAL_STATUS_SHUTDOWN
Need shutdown immediately