UnityInterface.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. #pragma once
  2. #include <stdint.h>
  3. #include <stdarg.h>
  4. #include "UnityForwardDecls.h"
  5. #include "UnityRendering.h"
  6. // unity plugin functions
  7. // audio plugin api
  8. typedef int (*UnityPluginGetAudioEffectDefinitionsFunc)(struct UnityAudioEffectDefinition*** descptr);
  9. // OLD rendering plugin api (will become obsolete soon)
  10. typedef void (*UnityPluginSetGraphicsDeviceFunc)(void* device, int deviceType, int eventType);
  11. typedef void (*UnityPluginRenderMarkerFunc)(int marker);
  12. // new rendering plugin api
  13. typedef void (*UnityPluginLoadFunc)(struct IUnityInterfaces* unityInterfaces);
  14. typedef void (*UnityPluginUnloadFunc)(void);
  15. // log handler function
  16. #ifdef __cplusplus
  17. typedef bool (*LogEntryHandler)(LogType logType, const char* log, va_list list);
  18. #endif
  19. //
  20. // these are functions referenced in trampoline and implemented in unity player lib
  21. //
  22. #ifdef __cplusplus
  23. extern "C" {
  24. #endif
  25. // life cycle management
  26. void UnityInitRuntime(int argc, char* argv[]);
  27. void UnityInitApplicationNoGraphics(const char* appPathName);
  28. void UnityUnloadApplication(void);
  29. void UnityQuitApplication(int exitCode);
  30. void UnityInitApplicationGraphics(void);
  31. void UnityCleanup(void);
  32. void UnityLoadApplication(void);
  33. void UnityLoadApplicationFromSceneLessState(void);
  34. void UnityPlayerLoop(void); // normal player loop
  35. void UnityBatchPlayerLoop(void); // batch mode like player loop, without rendering (usable for background processing)
  36. void UnitySetPlayerFocus(int focused); // send OnApplicationFocus() message to scripts
  37. void UnityLowMemory(void);
  38. void UnityPause(int pause);
  39. void UnitySuppressPauseMessage(void);
  40. int UnityIsPaused(void); // 0 if player is running, 1 if paused
  41. void UnityWillPause(void); // send the message that app will pause
  42. void UnityWillResume(void); // send the message that app will resume
  43. void UnityDeliverUIEvents(void); // unity processing impacting UI will be called in there
  44. void UnityInputProcess(void); // no longer used, will be removed soon
  45. // rendering
  46. int UnityGetRenderingAPI(void);
  47. void UnityFinishRendering(void);
  48. void UnityDisplayLinkCallback(double /*machAbsoluteTimeSeconds*/); // argument is not used anymore
  49. // controling player internals
  50. // TODO: needs some cleanup
  51. void UnitySetAudioSessionActive(int active);
  52. void UnityGLInvalidateState(void);
  53. void UnityReloadResources(void);
  54. int UnityIsCaptureScreenshotRequested(void);
  55. void UnityCaptureScreenshot(void);
  56. void UnitySendMessage(const char* obj, const char* method, const char* msg);
  57. void UnityUpdateMuteState(int mute);
  58. void UnityUpdateAudioOutputState(void);
  59. int UnityShouldActivateAVAudioSession(void);
  60. #ifdef __cplusplus
  61. void UnitySetLogEntryHandler(LogEntryHandler newHandler);
  62. #endif
  63. // plugins support
  64. // WARNING: old UnityRegisterRenderingPlugin will become obsolete soon
  65. void UnityRegisterRenderingPlugin(UnityPluginSetGraphicsDeviceFunc setDevice, UnityPluginRenderMarkerFunc renderMarker);
  66. void UnityRegisterRenderingPluginV5(UnityPluginLoadFunc loadPlugin, UnityPluginUnloadFunc unloadPlugin);
  67. void UnityRegisterAudioPlugin(UnityPluginGetAudioEffectDefinitionsFunc getAudioEffectDefinitions);
  68. // resolution/orientation handling
  69. void UnityGetRenderingResolution(unsigned* w, unsigned* h);
  70. void UnityGetSystemResolution(unsigned* w, unsigned* h);
  71. void UnityRequestRenderingResolution(unsigned w, unsigned h);
  72. int UnityIsOrientationEnabled(unsigned /*ScreenOrientation*/ orientation);
  73. int UnityHasOrientationRequest(void);
  74. int UnityShouldAutorotate(void);
  75. int UnityAutorotationStatusChanged(void);
  76. int UnityShouldChangeAllowedOrientations(void);
  77. int UnityRequestedScreenOrientation(void); // returns ScreenOrientation
  78. void UnityOrientationRequestWasCommitted(void);
  79. int UnityReportResizeView(unsigned w, unsigned h, unsigned /*ScreenOrientation*/ contentOrientation); // returns ScreenOrientation
  80. void UnityReportSafeAreaChange(float x, float y, float w, float h);
  81. void UnityReportBackbufferChange(UnityRenderBufferHandle colorBB, UnityRenderBufferHandle depthBB);
  82. float UnityCalculateScalingFactorFromTargetDPI(UIScreen* screen);
  83. void UnityReportDisplayCutouts(const float* x, const float* y, const float* width, const float* height, int count);
  84. // player settings
  85. int UnityDisableDepthAndStencilBuffers(void);
  86. int UnityUseAnimatedAutorotation(void);
  87. int UnityGetDesiredMSAASampleCount(int defaultSampleCount);
  88. int UnityGetSRGBRequested(void);
  89. int UnityGetWideColorRequested(void);
  90. int UnityGetHDRModeRequested(void);
  91. int UnityGetShowActivityIndicatorOnLoading(void);
  92. int UnityGetAccelerometerFrequency(void);
  93. int UnityGetTargetFPS(void);
  94. int UnityGetUseCustomAppBackgroundBehavior(void);
  95. int UnityGetDeferSystemGesturesTopEdge(void);
  96. int UnityGetDeferSystemGesturesBottomEdge(void);
  97. int UnityGetDeferSystemGesturesLeftEdge(void);
  98. int UnityGetDeferSystemGesturesRightEdge(void);
  99. int UnityGetHideHomeButton(void);
  100. int UnityMetalFramebufferOnly(void);
  101. int UnityMetalMemorylessDepth(void);
  102. int UnityPreserveFramebufferAlpha(void);
  103. void UnitySetTargetFPS(int targetFPS);
  104. void UnitySetAbsoluteURL(const char* url);
  105. // push notifications
  106. #if !PLATFORM_TVOS
  107. #pragma clang diagnostic push
  108. #pragma clang diagnostic ignored "-Wdeprecated-declarations"
  109. void UnitySendLocalNotification(UILocalNotification* notification);
  110. #pragma clang pop
  111. #endif
  112. void UnitySendRemoteNotification(NSDictionary* notification);
  113. void UnitySendDeviceToken(NSData* deviceToken);
  114. void UnitySendRemoteNotificationError(NSError* error);
  115. // native events
  116. void UnityInvalidateDisplayDataCache(void* screen);
  117. void UnityUpdateDisplayListCache(void** screens, int screenCount);
  118. // profiler
  119. void* UnityCreateProfilerCounter(const char*);
  120. void UnityDestroyProfilerCounter(void*);
  121. void UnityStartProfilerCounter(void*);
  122. void UnityEndProfilerCounter(void*);
  123. // sensors
  124. void UnitySensorsSetGyroRotationRate(int idx, float x, float y, float z);
  125. void UnitySensorsSetGyroRotationRateUnbiased(int idx, float x, float y, float z);
  126. void UnitySensorsSetGravity(int idx, float x, float y, float z);
  127. void UnitySensorsSetUserAcceleration(int idx, float x, float y, float z);
  128. void UnitySensorsSetAttitude(int idx, float x, float y, float z, float w);
  129. void UnityDidAccelerate(float x, float y, float z, double timestamp);
  130. void UnitySetJoystickPosition(int joyNum, int axis, float pos);
  131. int UnityStringToKey(const char *name);
  132. void UnitySetKeyState(int key, int /*bool*/ state);
  133. void UnitySetKeyboardKeyState(int key, int /*bool*/ state);
  134. void UnitySendKeyboardCommand(UIKeyCommand* command);
  135. // WWW connection handling
  136. void UnityReportWebRequestStatus(void* udata, int status);
  137. void UnityReportWebRequestNetworkError(void* udata, int status);
  138. void UnityReportWebRequestResponseHeader(void* udata, const char* headerName, const char* headerValue);
  139. void UnityReportWebRequestReceivedResponse(void* udata, unsigned expectedDataLength);
  140. void UnityReportWebRequestReceivedData(void* udata, const void* buffer, unsigned totalRead, unsigned expectedTotal);
  141. void UnityReportWebRequestFinishedLoadingData(void* udata);
  142. void UnityWebRequestRelease(void* udata);
  143. void UnityReportWebRequestSentData(void* udata, unsigned totalWritten, unsigned expectedTotal);
  144. int UnityReportWebRequestValidateCertificate(void* udata, const void* certificateData, unsigned certificateSize);
  145. const void* UnityWebRequestGetUploadData(void* udata, unsigned* bufferSize);
  146. void UnityWebRequestConsumeUploadData(void* udata, unsigned consumedSize);
  147. // AVCapture
  148. void UnityReportAVCapturePermission(void);
  149. void UnityDidCaptureVideoFrame(intptr_t tex, void* udata);
  150. // logging override
  151. #ifdef __cplusplus
  152. } // extern "C"
  153. #endif
  154. // touches processing
  155. #ifdef __cplusplus
  156. extern "C" {
  157. #endif
  158. void UnitySetViewTouchProcessing(UIView* view, int /*ViewTouchProcessing*/ processingPolicy);
  159. void UnityDropViewTouchProcessing(UIView* view);
  160. void UnitySendTouchesBegin(NSSet* touches, UIEvent* event);
  161. void UnitySendTouchesEnded(NSSet* touches, UIEvent* event);
  162. void UnitySendTouchesCancelled(NSSet* touches, UIEvent* event);
  163. void UnitySendTouchesMoved(NSSet* touches, UIEvent* event);
  164. void UnityCancelTouches(void);
  165. #ifdef __cplusplus
  166. } // extern "C"
  167. #endif
  168. //
  169. // these are functions referenced and implemented in trampoline
  170. //
  171. #ifdef __cplusplus
  172. extern "C" {
  173. #endif
  174. // UnityAppController.mm
  175. UIViewController* UnityGetGLViewController(void);
  176. UIView* UnityGetGLView(void);
  177. UIWindow* UnityGetMainWindow(void);
  178. enum ScreenOrientation UnityCurrentOrientation(void);
  179. // Unity/DisplayManager.mm
  180. float UnityScreenScaleFactor(UIScreen* screen);
  181. #ifdef __cplusplus
  182. } // extern "C"
  183. #endif
  184. //
  185. // these are functions referenced in unity player lib and implemented in trampoline
  186. //
  187. #ifdef __cplusplus
  188. extern "C" {
  189. #endif
  190. // iPhone_Sensors.mm
  191. void UnityInitJoysticks(void);
  192. void UnityCoreMotionStart(void);
  193. void UnityCoreMotionStop(void);
  194. void UnityUpdateAccelerometerData(void);
  195. int UnityIsGyroEnabled(int idx);
  196. int UnityIsGyroAvailable(void);
  197. void UnityUpdateGyroData(void);
  198. void UnitySetGyroUpdateInterval(int idx, float interval);
  199. float UnityGetGyroUpdateInterval(int idx);
  200. void UnityUpdateJoystickData(void);
  201. NSArray* UnityGetJoystickNames(void);
  202. void UnityGetJoystickAxisName(int idx, int axis, char* buffer, int maxLen);
  203. void UnityGetNiceKeyname(int key, char* buffer, int maxLen);
  204. // UnityAppController+Rendering.mm
  205. void UnityInitMainScreenRenderingCallback(void);
  206. void UnityGfxInitedCallback(void);
  207. void UnityPresentContextCallback(struct UnityFrameStats const* frameStats);
  208. void UnityFramerateChangeCallback(int targetFPS);
  209. int UnitySelectedRenderingAPI(void);
  210. NSBundle* UnityGetMetalBundle(void);
  211. MTLDeviceRef UnityGetMetalDevice(void);
  212. MTLCommandQueueRef UnityGetMetalCommandQueue(void);
  213. MTLCommandQueueRef UnityGetMetalDrawableCommandQueue(void);
  214. int UnityCommandQueueMaxCommandBufferCountMTL(void);
  215. UnityRenderBufferHandle UnityBackbufferColor(void);
  216. UnityRenderBufferHandle UnityBackbufferDepth(void);
  217. int UnityIsWideColorSupported(void);
  218. // UI/ActivityIndicator.mm
  219. void UnityStartActivityIndicator(void);
  220. void UnityStopActivityIndicator(void);
  221. // UI/Keyboard.mm
  222. void UnityKeyboard_Create(unsigned keyboardType, int autocorrection, int multiline, int secure, int alert, const char* text, const char* placeholder, int characterLimit);
  223. void UnityKeyboard_Show(void);
  224. void UnityKeyboard_Hide(void);
  225. void UnityKeyboard_GetRect(float* x, float* y, float* w, float* h);
  226. void UnityKeyboard_SetText(const char* text);
  227. NSString* UnityKeyboard_GetText(void);
  228. int UnityKeyboard_IsActive(void);
  229. int UnityKeyboard_Status(void);
  230. void UnityKeyboard_SetInputHidden(int hidden);
  231. int UnityKeyboard_IsInputHidden(void);
  232. void UnityKeyboard_SetCharacterLimit(unsigned characterLimit);
  233. int UnityKeyboard_CanGetSelection(void);
  234. void UnityKeyboard_GetSelection(int* location, int* range);
  235. int UnityKeyboard_CanSetSelection(void);
  236. void UnityKeyboard_SetSelection(int location, int range);
  237. // UI/UnityViewControllerBase.mm
  238. void UnityNotifyHideHomeButtonChange(void);
  239. void UnityNotifyDeferSystemGesturesChange(void);
  240. // Unity/AVCapture.mm
  241. int UnityGetAVCapturePermission(int captureTypes);
  242. void UnityRequestAVCapturePermission(int captureTypes);
  243. // Unity/CameraCapture.mm
  244. void UnityEnumVideoCaptureDevices(void* udata, void(*callback)(void* udata, const char* name, int frontFacing, int autoFocusPointSupported, int kind, const int* resolutions, int resCount));
  245. void* UnityInitCameraCapture(int device, int w, int h, int fps, int isDepth, void* udata);
  246. void UnityStartCameraCapture(void* capture);
  247. void UnityPauseCameraCapture(void* capture);
  248. void UnityStopCameraCapture(void* capture);
  249. void UnityCameraCaptureExtents(void* capture, int* w, int* h);
  250. void UnityCameraCaptureReadToMemory(void* capture, void* dst, int w, int h);
  251. int UnityCameraCaptureVideoRotationDeg(void* capture);
  252. int UnityCameraCaptureVerticallyMirrored(void* capture);
  253. int UnityCameraCaptureSetAutoFocusPoint(void* capture, float x, float y);
  254. // Unity/DeviceSettings.mm
  255. const char* UnityDeviceUniqueIdentifier(void);
  256. const char* UnityVendorIdentifier(void);
  257. const char* UnityAdIdentifier(void);
  258. int UnityAdTrackingEnabled(void);
  259. int UnityGetLowPowerModeEnabled(void);
  260. int UnityGetWantsSoftwareDimming(void);
  261. void UnitySetWantsSoftwareDimming(int enabled);
  262. int UnityGetIosAppOnMac(void);
  263. const char* UnityDeviceName(void);
  264. const char* UnitySystemName(void);
  265. const char* UnitySystemVersion(void);
  266. const char* UnityDeviceModel(void);
  267. int UnityDeviceCPUCount(void);
  268. int UnityGetPhysicalMemory(void);
  269. int UnityDeviceGeneration(void);
  270. float UnityDeviceDPI(void);
  271. const char* UnitySystemLanguage(void);
  272. int UnityDeviceSupportsUpsideDown(void);
  273. // Unity/DisplayManager.mm
  274. void UnityActivateScreenForRendering(void* nativeDisplay);
  275. void UnityStartFrameRendering(void);
  276. void UnityDestroyUnityRenderSurfaces(void);
  277. int UnityMainScreenRefreshRate(void);
  278. void UnitySetBrightness(float brightness);
  279. float UnityGetBrightness(void);
  280. // Unity/Filesystem.mm
  281. const char* UnityDataBundleDir(void);
  282. void UnitySetDataBundleDirWithBundleId(const char * bundleId);
  283. const char* UnityDocumentsDir(void);
  284. const char* UnityLibraryDir(void);
  285. const char* UnityCachesDir(void);
  286. int UnityUpdateNoBackupFlag(const char* path, int setFlag); // Returns 1 if successful, otherwise 0
  287. // Unity/WWWConnection.mm
  288. void* UnityStartWWWConnectionGet(void* udata, const void* headerDict, const char* url);
  289. void* UnityStartWWWConnectionPost(void* udata, const void* headerDict, const char* url, const void* data, unsigned length);
  290. void UnityDestroyWWWConnection(void* connection);
  291. void UnityShouldCancelWWW(const void* connection);
  292. // Unity/FullScreenVideoPlayer.mm
  293. int UnityIsFullScreenPlaying(void);
  294. void TryResumeFullScreenVideo(void);
  295. //Apple TV Remote
  296. int UnityGetAppleTVRemoteAllowExitToMenu(void);
  297. void UnitySetAppleTVRemoteAllowExitToMenu(int val);
  298. int UnityGetAppleTVRemoteAllowRotation(void);
  299. void UnitySetAppleTVRemoteAllowRotation(int val);
  300. int UnityGetAppleTVRemoteReportAbsoluteDpadValues(void);
  301. void UnitySetAppleTVRemoteReportAbsoluteDpadValues(int val);
  302. int UnityGetAppleTVRemoteTouchesEnabled(void);
  303. void UnitySetAppleTVRemoteTouchesEnabled(int val);
  304. // Unity/UnityReplayKit.mm
  305. void UnityShouldCreateReplayKitOverlay(void);
  306. #ifdef __cplusplus
  307. } // extern "C"
  308. #endif
  309. #ifdef __OBJC__
  310. // This is basically a wrapper for [NSString UTF8String] with additional strdup.
  311. //
  312. // Apparently multiple calls on UTF8String will leak memory (NSData objects) that are collected
  313. // only when @autoreleasepool is exited. This function serves as documentation for this and as a
  314. // handy wrapper.
  315. inline char* AllocCString(NSString* value)
  316. {
  317. if (value == nil)
  318. return 0;
  319. const char* str = [value UTF8String];
  320. return str ? strdup(str) : 0;
  321. }
  322. #endif